------------------------------------------------------------------------------
Title: INSTALLATION INSTRUCTIONS FOR FAD TOOLS RELEASE 3.3
------------------------------------------------------------------------------

1.      Requirements and Notes

1.1.    To make the programs you will require GNU make, perl version 5.

1.2.    To actually run the programs you will require perl 5 
        including the URI::Escape and Net::SMTP modules (available on CPAN). 
        GNU gzip, gunzip, BSD compress and uncompress are recommended, but not 
        required.

1.3.    For your information only (i.e. if you don't understand this, don't
        worry); this program uses a very non-standard Perl code abstraction 
        method, namely something I'm calling 'Perl fragments'. These are 
        fragments of Perl code, which are included into a program at
        'compile' time, by using a script-preprocessor (simpler and slower
        than cpp or m4).  This has obvious disadvantages, but it also has
        the advantage that co-existence of multiple fragment versions
        is more easily managed, and it prevents accidentally leaving
        components on the system at de-install/upgrade time. 

2.      Compilation and Installation

2.1     As non-root run:

        chmod u+w ./Makefile.def

        (As distributed this file is normally readonly.)

2.2.    As non-root, work your way through ./Makefile.defs changing things as 
        instructed there.

2.3.    As non-root run:

        make

2.4.    As root run:

        make install

3.      Configuration

3.1.    If your system is low on memory and you *didn't* specify a 'sort'
        command in ./Makefile.defs, then you will need to define the
        environment variable FAD_SORT_CMD as explained in the fad(5) manual
        page, before using any of the FAD tools. If you have one of the 
        systems below then set the variable to the corresponding value below 
        (don't forget to export it), otherwise refer to fad(5) for an 
        explanation of to what the variable should be set. If your system has
        plenty of memory or you *did* define a 'sort' command in ./Makefile.defs
        then you do not need to set this environment variable.

        HP-UX 9 and 10:         FAD_SORT_CMD='/usr/bin/sort -t%s -k1,2'
        Ultrix 4.2:             FAD_SORT_CMD='/usr/bin/sort -t%s -k0,1'
        Solaris 2:              FAD_SORT_CMD='/usr/bin/sort -t%s +0 -1'
        SunOS 4.1.3:            FAD_SORT_CMD='/usr/bin/sort -t%s +0 -1'
        Linux:                  FAD_SORT_CMD='/usr/bin/sort -t%s +0 -1'

3.2.    fadscan(1) requires a configuration file to be created before use. 
        An example fadscan config file, plus a crontab entry you may wish to 
        add to root's crontab can be found in ./doc/examples. Consult the
        manual pages for more information.

3.3.    If you didn't set the path to the sendmail command in Makefile.defs,
        and you wish fadscan(1) to mail the reports it generates, then fadscan 
        requires at run time that environment variable FADSCAN_SENDMAIL_CMD is 
        set to its path, or that environment variable SMTPSERVER is set to the 
        name or IP address of a local SMTP server.

4.      Possible Problems

4.1     Compilation Problems

4.2     Runtime Problems

4.2.1   Can't locate Socket.pm in @INC at ..../Sys/Syslog.pm line ...

        As far as I can tell, this indicates a faulty Perl installation.
        I encountered it using a Solaris 'pkg' of Perl 5.003. I suggest you
        download the latest Perl from http://www.perl.org and re-install it.

4.2.2   Can't locate URI/Escape.pm ....
        Can't locate Net/SMTP.pm ....

        URI::Escape or Net::SMTP are not installed. Download them from
        your nearest CPAN mirror. (see the CPAN(3pm) manual page).

        (Note, last time I tried to download URI::Escape, it was visible
        but not download-able using the normal 'perl -MCPAN -e shell' method.
        However, I downloaded it using conventional ftp without problems.)

        (When installing URI::Escape, expect a warning about MIME::Base64 
        missing if it is not already installed. This does not affect the FAD
        tools.)

------------------------------------------------------------------------------
$Header: /diskb/home/alexis/dev/fad/doc/RCS/INSTALL,v 1.20 1999/01/07 12:49:16 alexis Exp $
------------------------------------------------------------------------------
