------------------------------------------------------------------------------
Title:   Installation instructions for ADE
Version: $HeadURL$ $LastChangedRevision$
------------------------------------------------------------------------------

Prerequisite software
---------------------

You must have the following software installed and accessible to the
user who will compile and to the user who will install this package:

	GNU make
	Perl version 5 or greater
	Korn shell or Bash

Not required, but useful are the following:

	sendmail (or something which pretends to be sendmail, e.g. masqmail)
	gzip/gunzip
	compress/uncompress

Compilation 
-----------

This software uses a mechanism similar in principle, but not identical, to GNU
'configure'. 

As outlined above, GNU make, Perl 5 and Korn shell or Bash are required.
If the command invoked by running 'make' is GNU make, and ksh is installed
as /usr/bin/ksh, and perl is installed as /usr/bin/perl, then you can 
just run:

  	make ADEROOT_INCLUDE=`pwd`/include ADEROOT_LIB=`pwd`/lib ADEROOT_BIN=`pwd`/bin configure

However, if your 'make' is not GNU make, then change 'make' in the above
command to:

	/path/to/gnu/make

If ksh is not in /usr/bin, or is not installed and you want to use bash 
instead, then, after the 'make' command, and before the 'ADEROOT_whatever=`pwd`'
insert:

	SHELL_CMD=/path/to/ksh/or/bash

If perl 5 is not /usr/bin/perl then insert:

	PERL_CMD=/path/to/perl

This will generate files ./bldcfg/paths.*. Review the contents of one
of these files (the others present the same information in an alternative
format).

If you need to provide some non-default options to adeconf, then 
do so by inserting another setting as in this example:

	ADECONF_FLAGS="--prefix=/some/dir --lckdir=/another/dir" 

Valid path-specifying options are:

	--prefix
	--cfgdir
	--sttdir
	--lckdir
	--logdir
	--bindir
	--mandir

You can read an explanation of these flags in the 'adeconf' manual page 
which is the ./man directory for more information on these options.

When you are happy with the paths then (still from the top directory
of the sources) run:

  	make ADEROOT_INCLUDE=`pwd`/include ADEROOT_LIB=`pwd`/lib ADEROOT_BIN=`pwd`/bin

with the 'make' command adjusted, and extra make settings inserted, as 
determined above already.

Problems Compiling?
-------------------

Q1) Running "make ... configure" produces:
    ...: Could not find /bldcfg/settings.mk
    ...: Missing dependency operator
    ...: Need an operator 
    ...
    Fatal errors encountered -- cannot continue

A1) You are not using GNU make. Locate GNU make (/usr/gnu/make? 
    /usr/bin/gmake?) and invoke that instead.

Q2) Running "make ... configure" produces:
    make[1]: .../bin/adeconf: Command not found

A2) Probably /usr/bin/ksh does not exist. Locate ksh or bash and run
    "make SHELL_CMD=/path/to/ksh/or/bash ... configure"
    instead.

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

If you chose an installation prefix for which you need root access
then now run:

  	su root -c "make ADEROOT_INCLUDE=`pwd`/include ADEROOT_LIB=`pwd`/lib ADEROOT_BIN=`pwd`/bin install"

again, with the 'make' command adjusted, and extra make settings inserted,
as determined above already.

Otherwise run:

  	make ADEROOT_INCLUDE=`pwd`/include ADEROOT_LIB=`pwd`/lib ADEROOT_BIN=`pwd`/bin install

with the same adjustments.

Configuration and execution
---------------------------

See the man pages.