file: mxtools.README MXTOOLS RELEASE INFORMATION Release: 2001 December 27 =============================================================================== INSTALLATION INSTRUCTIONS FOR IRAF MANAGERS The installation instructions that follow assume that you have copied the tar format MXTOOLS 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 at kmighell@noao.edu. See below for installation of pre-compiled binaries for a particular platform. [1] The package is distributed as a tar archive; IRAF is distributed with a tar reader. The tar archive may be obtained by anonymous ftp as shown below. % ftp iraf.noao.edu login: anonymous password: [your email address] ftp> cd contrib ftp> binary ftp> get mxtools-generic-tar.Z ftp> quit [2] Create a directory to contain the MXTOOLS 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 /iraf/extern/mxtools/. 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: % cd $hlib Define the environment variable mxtools to be the pathname to the mxtools root directory. UNIX pathnames must be terminated with a '/'. Edit extern.pkg to include: reset mxtools = /iraf/extern/mxtools/ task $mxtools.pkg = mxtools$mxtools.cl Near the end of the hlib$extern.pkg file, update the definition of helpdb so it includes the mxtools help database, copying the syntax already used in the string. Add this line before the line containing a closing quote: ,mxtools$lib/helpdb.mip\ [4] Log into the CL from the IRAF account and unpack the archive file. Change directories to the mxtools root directory created above, then uncompress the distribution file and unpack it using 'rtar': cl> cd mxtools # go to MXTOOLS directory cl> softools # load SOFTOOLS package cl> !uncompress //mxtools-generic-tar.Z # uncompress distribution cl> rtar -xrf //mxtools-generic-tar # unpack the source tree Site who downloaded the gzip-compressed '.gz' file should uncompress using the "gunzip" command. UNIX sites should leave the symbolic link 'bin' in the MXTOOLS root directory pointing to the empty 'bin.generic' directory but can delete any of the bin.`mach' directories that won't be used. During the build process the appropriate bin.`mach' directory will be created automatically. The archive file can be deleted once the package has been successfully installed. [5] Configure the package for the type of system executables to be built; i.e. bin.sparc, bin.ssun, bin.linux, bin.alpha, etc. cl> mkpkg -p mxtools ssun [6] When the archive has been unpacked, build the MXTOOLS package executable. The compilation and linking of the MXTOOLS package is done using the following command: cl> mkpkg -p mxtools update >& mxtools.spool & The spool file(s) should be reviewed upon completion to make sure there were no errors. =============================================================================== PRE-BUILT BINARY INSTALLATION (FOR PRIVATE COPIES OF MXTOOLS) [1] Sites wishing to use pre-compiled binaries should follow steps 1-4 outlined above to install the package source. In addition to the source archive users will also need to download the binary tar file in step one. For *Solaris* users one would do the following % ftp iraf.noao.edu login: anonymous password: [your email address] ftp> cd contrib ftp> binary ftp> get mxtools-generic-tar.Z ftp> get mxtools-bin.ssun-tar.Z ftp> quit [2] Once the source tree has been unpacked, the binaries will be unpacked in the appropriate mxtools$bin. directory. Again using Solaris as an example, one would do the following cl> cd mxtools$bin.ssun # go to bin directory cl> !uncompress mxtools-bin.ssun-tar.Z # uncompress file cl> rtar -xrf cl> rtar -xrf //mxtools-tar # unpack the source tree Site who downloaded the gzip-compressed '.gz' file should uncompress using the "gunzip" command. UNIX sites should leave the symbolic link 'bin' in the MXTOOLS root directory pointing to the empty 'bin.generic' directory but can delete any of the bin.`mach' directories that won't be used. During the build process the appropriate bin.`mach' directory will be created automatically. The archive file can be deleted once the package has been successfully installed. [5] Configure the package for the type of system executables to be built; i.e. bin.sparc, bin.ssun, bin.linux, bin.alpha, etc. cl> mkpkg -p mxtools ssun [6] When the archive has been unpacked, build the MXTOOLS package executable. The compilation and linking of the MXTOOLS package is done using the following command: cl> mkpkg -p mxtools update >& mxtools.spool & The spool file(s) should be reviewed upon completion to make sure there were no errors. =============================================================================== PRE-BUILT BINARY INSTALLATION (FOR PRIVATE COPIES OF MXTOOLS) [1] Sites wishing to use pre-compiled binaries should follow steps 1-4 outlined above to install the package source. In addition to the source archive users will also need to download the binary tar file in step one. For *Solaris* users one would do the following % ftp iraf.noao.edu login: anonymous password: [your email address] ftp> cd contrib ftp> binary ftp> get mxtools-generic-tar.Z ftp> get mxtools-bin.ssun-tar.Z ftp> quit [2] Once the source tree has been unpacked, the binaries will be unpacked in the appropriate mxtools$bin. directory. Again using Solaris as an example, one would do the following cl> cd mxtools$bin.ssun # go to bin directory cl> !uncompress mxtools-bin.ssun-tar.Z # uncompress file cl> rtar -xrf //xtools-bin.ssun-tar # unpack it The tar file may then be deleted and the package is ready to go. [3] Suppose your username is jcool and that have intalled the package in a subdirectory of your home directory. Add the following 5 lines at the *end* of your login.cl file in your IRAF home directory: # MXTOOLS reset mxtools = /home/jcool/mxtools/ task mxtools.pkg = mxtools$mxtools.cl printf("reset helpdb=mxtools$lib/helpdb.mip,%s\nkeep\n",envget("helpdb")) | cl keep [4] *** NOTE *** You will need to change the definition of mxtools$ to the actual directory on your system. [5] MXTOOLS should be now available to you once you start your next IRAF session!