INSTALL.TXT                                                          v9.45.06
Robin Shirley                                                      8 Jul 2002


                        Installing Crysfire 2002
                    under DOS and Windows (except XP)
                      
The installation procedure under Windows XP has to be completely different
because it will not allow changes to be made to its main Windows directory.
Thus if you wish to install Crysfire under Windows XP, please turn now to the
separate file of installation notes in XPINSTAL.TXT.  This also applies if for
any other reason you are prevented from making changes to your main Windows
directory - for example, if running on a network under Windows 2000 where the
system administrator has given protected status to the main Windows directory.

Trademarks mentioned are acknowledged as belonging to their respective owners.

Installation
------------

If you have an existing Crysfire installation on your system, please first read
the section below headed "Notes for Crysfire 2000 Users".

1)  Download the current Crysfire 2002 distribution zipfile

2)  Create a directory (folder) on your hard disk to act as your Crysfire
    home directory.  It can have any DOS-acceptable name (i.e. 8.3 characters),
    but unless you have some other preference, it's suggested that you use
    C:\CRYSFIRE, then you won't need to edit CF_HOME.BAT in step 4 below.

3)  Copy the distribution zipfile into the home directory that you have just
    created.  Use a suitable utility such as WinZip to expand all its files
    into that directory.

4)  The script CF_HOME.BAT tells the system the name of your Crysfire home
    directory.  The default is C:\CRYSFIRE (it doesn't matter whether this is
    in upper or lower case).  If that was the name you gave your Crysfire home
    directory in step 2, no action is needed here and you can proceed to step 5.

    However, if the home directory that you created in step 2 above was not
    C:\CRYSFIRE, you must now use a text editor (for example WordPad or
    DOS EDIT) to change the directory name in CF_HOME.BAT from C:\CRYSFIRE to
    whatever name you gave your Crysfire home directory in step 2.

5)  Now change directory to your new Crysfire home directory and run CFsetup.
    This will copy the two files CF_HOME.BAT and CRYSFIRE.BAT to a suitable
    directory on your execution PATH (usually C:\WINDOWS).

6)  Probably Crysfire 2002 will now be ready to run.

    But, like previous Crysfire releases, it communicates between its
    sub-systems via environment variables, so it will encounter problems if
    there is not enough environment space available.  If that happens, a
    screen message should be displayed, advising how to increase the
    environment memory allocation.  About 1024 to 2048 bytes of space for
    environment variables is recommended, depending on how much is already in
    use by other parts of your system.  See the "Environment Variables" notes
    below on how to check and update this.

Your Crysfire 2002 installation is now complete.  Note that you do *not* need
to add the Crysfire home directory to your DOS execution PATH, and it's
recommended that you don't do so, to reduce the chances of inadvertantly
picking up an obsolete or inappropriate file (if it is already on the PATH
from a previous Crysfire version, see "Notes for Crysfire 2000 Users" below).


Running Crysfire 2002
---------------------

All that's needed to run Crysfire 2002 is to open a DOS prompt in the directory
(folder) containing the data that you wish to analyse, and to type CRYSFIRE.

The Crysfire system will then be launched and your dataset can be loaded using
the LO command.  For more further information, type ? (Help) at a Crysfire
command prompt.


Notes for Crysfire 2000 Users
-----------------------------

While Crysfire 2002 is completely *compatible* with all your old datasets and
output files, it has been radically rewritten and is TOTALLY INCOMPATIBLE with
previous Crysfire executable files.  It won't work if they get in on the act.

This means that it's essential to ensure that Crysfire 2002 can't inadvertantly
pick up any of your old Crysfire executables.

For this reason it is recommended that you do the following:

a)  If your old Crysfire directory was C:\CRYSFIRE, at least rename it and
    preferably move its contents completely from your system, before installing
    Crysfire 2002.  There can then be no conflict with your new Crysfire home
    directory, which can take the default name and simplify the installation.

    If you're concerned that the new version may run into problems, then keep
    the old Crysfire directory backed up somewhere (preferably offline) - but
    trust me, you're unlikely to need it again.

b)  Unlike the old Crysfire directory, the new Crysfire 2002 home directory
    doesn't need to be on your execution PATH, and preferably shouldn't be.

    Thus now would be a good time to edit it out of the PATH (in AUTOEXEC.BAT),
    especially if both are called C:\CRYSFIRE, which may well be the case.
    Leaving it on the PATH will bring no benefits, and could cause odd things
    to happen if a Crysfire component happened to have the same name as a
    program belonging to some other powder diffraction application.

c)  The recommended way to run any Crysfire version is to use one or more data
    directories (i.e. folders) to keep different problems separate, and not to
    keep them in the Crysfire home directory among its distribution files and
    programs, which leads to problems with housekeeping, updating and backup.

    If you previously did keep work in progress within the Crysfire directory,
    now is a good time to move it somewhere else, preferably into an organised
    directory tree.  For security, I'd recommend that you don't use a
    sub-directory of the Crysfire home directory, so that if that were to
    become corrupted, your data would be unaffected.


Environment Variables
---------------------

If Crysfire 2002 fails to run, reporting "out of environment space", you have
probably already used up most of your environment allocation, and so need to
increase this to e.g. 1024 or 2048 bytes, using the SHELL command in CONFIG.SYS
via its /e parameter - e.g. /e:2048 for 2048 bytes.

Thus, to provide 2048 bytes of environment space, insert the one of the
following "shell=" lines in your CONFIG.SYS file, as appropriate:

    (Windows 9x, etc)  shell=C:\WINDOWS\COMMAND.COM C:\WINDOWS /e:2048 /p
    (DOS/Windows 3.x)  shell=C:\COMMAND.COM C:\DOS /e:2048 /p

Special action is required under Windows ME (which ignores CONFIG.SYS), as
follows:

    Right-click on the Crysfire (or MSDOS) icon on the Windows desktop, and
    choose "Properties" then "Memory".  Change the setting for the "Initial
    Environment" from "Auto" to a suitable value such as 2048 (the largest
    available is 4096).

