INSTALL

1) Choosing the right files to download

If ymol has been ported to your platform, it is very likely that there
are precompiled binaries available. If there are no binaries for your
platform, you can download the sources and compile Ymol
yourself. It is fairly easy to port ymol to a new platform.


2a) Downloading the binaries

The ymol binary archives are named as follows:
package name - version number - operating system .tar.gz or .tar.Z

Unfortunately I can't yet provide binaries for the Win32 version,
but you can compile the source yourself. See the section about
compiling the source below.

2b) Downloading the source

To compile ymol all you need is the ymol-allsource-VERSION.tar.gz
archive. This contains all sources (Xco+y4vm+ymol).

3) Unpacking the archives

If you downloaded the ymol-allsource-VERSION.tar.gz package the
simplest way to unpack is to type (requires gnutar for the z option):
tar xzf ymol-allsource-VERSION.tar.gz

If this does not work read on:
If your archives are named something.tar.gz you need gunzip
( already installed on your system, or available on the internet )
to unpack them. If they are named something.tar.Z you need
uncompress (already available on all (?) systems).
Using gunzip type: "gunzip something.tar.gz" on all packages.
Using uncompress type: "uncompress something.tar.Z"
This will leave you with packages named something.tar
Then you need to use tar to unpack the archives.
Type "tar xf something.tar" on all packages.


4a) Compiling the source (UNIX)

If you downloaded the binaries you don't need to perform this step,
just move on to step 5a).  If ymol has been ported to your platform you can
compile it by using the make command in the directory holding the
sources: make


4b) Compiling the source on Win32 (very very old instructions, now
probably works fine directly out of the box as on UNIX, provided that you have
cygwin installed).

These instructions apply to the CYGWIN32 B19.
First get the compiler from http://www.cygnus.com (or from somewhere else).
You will need both the cdk package and egcs.
Install cdk and egcs. Create the directories /bin and /lib (c:\bin and c:\lib):
In the bash shell (cygnus.bat) type: mkdir /bin /lib
Now you need to create symlinks:
cd /bin
ln -s /cygnus/b19/.../bash.exe sh
cd /lib
ln -s /cygnus/b19/.../cpp.exe cpp
You will also need the X libraries. Download the Xlib source
(follow instructions on http://www.cynus.com) and compile it yourself.
Alternatively download a precompiled X11 (browse http://www.cygnus.com).
Ymol expects to see X installed on /usr/X11, so if you have some other
directory where X is, create a symlink:
mkdir /usr
cd /usr
ln -s __whereever X is__ X11
The last command can be "ln -s X11R6.3 X11" for example.
Now you must create a home directory for yourself.
mkdir /myhome
export HOME=/myhome
may work. Alternatively put a command in CYGNUS.BAT (or AUTOEXEC.BAT)
to set the HOME environment variable:
SET HOME=/myhome
This home directory is required for ymol to run.
Now you can follow the instructions for "Compiling the source (UNIX)" above.

*DO NOT* distribute the binary compiled with cdk!!


5a) Installing

Installing ymol is just a matter of typing "make install" in the
directory you created. You may want to change the default
installation directories in the bourne shell script
make-install.sh. If you are root, ymol will be installed for
all users on the system. If you are not root, ymol will
be installed in a directory named "bin" in your home directory.
Make sure that this is appropriate for you and that the bin
directory is in your path. The installation script will also
install some files needed by ymol in the directory named
".ymol" in your home directory.

5b) Installing on Win32 (also very old instructions, should now work out of the box as on UNIX)

Type make install. You will get some error messages. Create a directory where you want to
put ymol. (mkdir /ymol perhaps). Copy ymol.exe to this directory. You will also need to copy
a few libraries to this directory. Copy the cygwin32b19.dll to this directory. Also copy
X11.dll and Xext.dll to this directory. When running ymol, make sure that the HOME environment
variable is set to the same as when you installed ymol. Also make sure that you have an
X server running. To make ymol understand which X display to use, set the DISPLAY environment
variable. This can be done in CYGNUS.BAT (or AUTOEXEC.BAT) or at the command prompt.
For bash: export DISPLAY=localhost:0.0
For CYGNUS.BAT (or AUTOEXEC.BAT): SET DISPLAY=localhost:0.0
You can of course change the DISPLAY variable to any location you like.

For information of what you may and may not with this/these
packages, see the file LICENSE.