XPLAN INSTALLATION PROCEDURE (last updated Mars 9, 2000)
$Id: INSTALL,v 1.1.2.3 2000/05/14 00:39:33 xplan Exp $

This file is far from complete and is only intended to serve as a guide
on how to install and build XPlan. 


(1) EXTRACT FILES FROM TAR FILE

Depending on how you have received the XPlan distribution consult the
appropriate section below.


(1.1) ORIGINAL SunOS TAR FILE DISTRIBUTION (somewhat obsolete)

Assuming you have not yet extracted xplan from diskette, do the
following:

	Insert diskette in drive, and type:

	tar xvf /dev/rfd0

rfd0 may not be the correct device for your machine --- check with
vendor documentation. Now proceed to section 1.3


(1.2) CURRENT DISTRIBUTION FORMAT
The current binary and source distribution of XPlan is in a gzipped tar
file format. So to unpack and install it just change to your preferred
installation directory and untar it:

$ gunzip -c xplan-X.Y.Z.tar.gz | tar xvf -

The same goes for the source distribution:

$ gunzip -c xplan-X.Y.Z.src.tar.gz | tar xvf -

Which will create a directory called 'xplan-X.Y.Z/' containing the
complete source tree for that version.


(1.3) FINAL RESULT

At this point you should have a directory structure resembling that
below:

	xplan/
		bin/
		src/



(2) GETTING THE DEVELOPER ENVIRONMENT

You need to have both the Sun XView libraries and the Sun DevGuide
run-time libraries to be able to compile and run XPlan.

The XView toolkit is available in many forms. Under Linux it is
available as .deb- .rpm- as well as ordinary .tgz-files for install.
However, if you would like to compile it for yourself you can get
it, amongst many places, from:

	ftp://step.polymtl.ca/pub/Xview/libs/

The DevGuide libraries for Sparc and x86 architectures are available
in the original form from:

	ftp://step.polymtl.ca/pub/Xview/libs/guide/

Or in a patched form for Linux, see the XPlan home page for details.


(2) SETUP THE DEVELOPER ENVIRONMENT

The next step, after installing the above mentioned libraries, is to
ensure that the environment variables are set correctly. In bash it
would look something like this:

$ export OPENWINHOME=/usr/openwin
$ export GUIDEHOME=/usr/openwin/DevGuide-3.0.1



(3) BUILD XPLAN

Move into the xplan/src directory

	cd xplan/src

To build the program, type:

	make

to create an executable version of xplan which will be placed in the
bin directory.



(4) SETTING UP YOUR WORK ENVIRONMENT

Now you need to set up the help path, so the help text for xplan will
be displayed when you use your help key.  An example help path might
be:

	setenv HELPPATH /usr/openwin/lib/help:/usr/openwin/lib/locale:/usr/lacey/xplan/src

The one thing that is essential for xplan is that you have your help
path pointing to the location of the .info files that are included in
the src directory as distributed.

If you plan on using xplan a lot you might want to add the bin
directory to your PATH environment variable, too.



(5) SUMMARY

xplan is now installed, and if your PATH is set up correctly you
should be able to run it by simply typing 'xplan' at the command
prompt from any directory.