
      Installation Instructions for the SPP Programming Tools Package
      ---------------------------------------------------------------

The IRAF external package, SPPTOOLS, is being distributed separately from
the IRAF V2.10 distribution.  This package is being made available for user
testing on a user-beware basis. The installation instructions that follow
assume that you have copied the tar format SPPTOOLS archive onto your host
machine.  The method you use to copy the file (or remotely access the tar
file) is OS dependent and is not discussed in this document.  If you have 
any questions, please contact the author (602-325-9387) or fitz@noao.edu 
(5355::fitz). 


[1] The package is distributed as a compressed tar archive; IRAF is distributed
    with a tar reader.  The tar archive may be obtained by magnetic
    tape or anonymous ftp.  For magnetic tape go to step [2] and when
    reading the tar archive simply mount the tape and use the tape
    device name for the archive name in step [4].  To obtain the package
    via ftp (assuming a UNIX computer):

	% ftp 140.252.1.1
	login: anonymous
	password: [your last name]
	ftp> cd contrib
	ftp> get spptools.readme
	ftp> binary
	ftp> get spptools.tar.Z
	ftp> quit
	% ls -l *spptools*
   	  6 -rw-r--r--  1 fitz         5542 Oct 26 15:41 readme.spptools
	896 -rw-r--r--  1 fitz       902367 Oct 26 15:33 spptools.tar.Z
	% uncompress spptools.tar

    The spptools.readme file contains these instructions.  Special arrangements 
    can be made for sites that don't have access to internet but could copy 
    the uncompressed archive over SPAN.

[2] Create a directory to contain the SPPTOOLS external package files.  This
    directory should be outside the IRAF directory tree and must be owned
    by the IRAF account.  In the following examples, this root directory
    is named usr1:[spptools] (VMS) or  /local/spptools/ (UNIX).  Make the 
    appropriate file name substitutions for your site.

[3] Log in as IRAF and edit the extern.pkg file in the hlib directory to
    define the package to the CL.  From the IRAF account, outside the CL,
    you can move to this directory with the commands:

	$ set def irafhlib	# VMS example
	% cd $hlib		# UNIX example

    Define the environment variable spptools to be the pathname to the spptools
    root directory.  The '$' character must be escaped in the VMS pathname; UNIX
    pathnames must be terminated with a '/'.  Edit extern.pkg to include:

	reset spptools      = usr\$1:[spptools]   	# VMS example
	reset spptools      = /local/spptools/		# UNIX example

	task  spptools.pkg = spptools$spptools.cl

    Near the end of the hlib$extern.pkg file, update the definition of helpdb
    so it includes the spptools help database, copying the syntax already used
    in the string.  Add this line before the line containing a closing quote:
        
                ,spptools$lib/helpdb.mip\

    NOTE: In IRAF V2.8 the length of the helpdb string cannot exceede 160 
    characters.  A helpdb string longer than 160 characters will cause the
    CL startup process to fail.

[4] Log into the CL from the IRAF account and unpack the archive file.  Change
    directories to the SPPTOOLS root directory created above and use 'rtar':

	cl> cd spptools
	cl> softools
	cl> rtar -xrf <archive>  where <archive> is the host name of the
				 archive file or the IRAF tape
				 device for tape distributions.

   On VMS systems, an error message will appear ("Copy 'bin.generic' to
   './bin fails") which can be ignored.  Also on VMS systems, the four
   bin.'mach' directories created by rtar under [newimred.bin] can be
   deleted.  UNIX sites should leave the symbolic link 'bin' in the SPPTOOLS
   root directory pointing to 'bin.generic' but can delete any of the 
   bin.`mach' directories that won't be used.  The archive file can be
   deleted once the package has been successfully installed.

[5] When the archive has been unpacked, build the SPPTOOLS package executable.  
    The compilation and linking of the SPPTOOLS package is done using the 
    following command:

	cl> mkpkg -p spptools update >& spptools.spool &

    NOTE: On systems that concurrently support different architectures
    (e.g., Suns, Convex), you must configure the system for the desired
    architecture before issuing the above command.  SUN/IRAF sites must
    execute a pair of 'mkpkg' commands for each supported architecture type.
    The Unix environment variable IRAFARCH must be set as well before
    compiling.  For example:

	# Assuming IRAFARCH is set to ffpa
	cl> mkpkg -p spptools ffpa
	cl> mkpkg -p spptools update >& spptools.ffpa &
	cl> mkpkg -p spptools f68881
	# Now reset IRAFARCH to f68881 before continuing
	cl> mkpkg -p spptools update >& spptools.f68881 &

    The spool file(s) should be reviewed upon completion to make sure there
    were no errors.  

[6] This version of the package contains new package parameters so you will
    need to unlearn them by doing the following once it is built:

	cl> delete uparm$spptools*.par
	cl> delete uparm$clespptools.par

    Note also that if the package was previously installed, you will need to
    re-edit the hlib$extern.pkg file and remove the leading '$' from the
    "task spptools.pkg = ..." definition.

