IUETOOLS Installation Guide

The following instructions will guide you through making your own personal installation of the iuetools package in IRAF. Please note that these instructions apply to the current version (V1.1, 1999-Aug-9) of this package.

• PART 1: First Time Set-Up
• PART 2: Using the iuetools package
• PART 3: Installing the Help Pages

PART 1: First Time Set-Up

1. If you have not already done so, retrieve the source tar file from the NEWSIPS ftp area. Note that this package depends upon recent versions of TABLES and IRAF. If these packages are not installed and configured on your system, you must do so before proceeding with the rest of these instructions.

2. Untar the file in a suitable directory. I will use the directory /home/shaw/iraf/iuetools and the tar file iuetools.tar for this example.
   % cd /home/shaw/iraf/iuetools
% tar xvpf iuetools.tar

   Note that there are analogous, but not necessarily identical, commands for this step if you are using a non-Unix operating system.

3. Compile the source code. For this step, start an IRAF session and "cd" to the directory where the source code was installed, then run "mkpkg". Following the previous example, the steps would be:
   cl> cd iuetools
cl> mkpkg -p tables update
   You will see a warning about the iuetools.a file not being found; this is the normal behavior when the library file is first created. After some time the compilation will yield a few new files, notably x_iuetools.e, which is the executable. If there were no errors, you will be ready to use the iuetools package within IRAF after following the directions in Part 2 below.

PART 2: Using the iuetools Package

Here are the directions for loading and running the iuetools package once the package has been installed and built for your machine. You will need to perform the first three steps each time you start a new IRAF session, unless you follow the advice in point 3:

1. Begin an IRAF session and load TABLES. Define an IRAF environment variable that gives the directory path to the iuetools source code. Using the example directory from Part 1 above, this would be:
   cl> set iuetools = home$iuetools/

   Don't forget the trailing slash (/) in the iuetools definition!

2. Define the iuetools task, and load the package using:
   cl> task iuetools = iuetools$iuetools.cl
cl> iuetools

3. Now everything should work during this session. We recommend that you put the "iuetools" environment variable and iuetools task definitions in your loginuser.cl file so you don't have to define it each time at the start of an IRAF session.

PART 3: Installing the Help Pages

Here are the directions for building an IRAF-style help database for the iuetools package, which will allow you to access help pages for the tasks in the package using the normal IRAF help mechanism.

1. Begin an IRAF session and load the softools package:
   cl> softools


2. Change directories to iuetools$lib and run the mkhelpdb task (this assumes you have the iuetools environment variable defined as above):
   so> cd iuetools$lib
so> mkhelpdb root.hd helpdb.mip

3. Now you need to add the iuetools helpdb.mip file to the path searched by the IRAF help utility. This is done by adding the following line to your "loginuser.cl" file, which is in your IRAF home directory:
   printf ("reset helpdb=%s,iuetools$lib/helpdb.mip\nkeep\n",envget("helpdb"))|cl

4. The next time you start an IRAF session you should be able to access the iuetools task's help pages, e.g.
   cl> iuetools
cl> help mxexpand

5. For general information on the utilities in this package, you can read the package help documentation:
   cl> help iuetools opt=sysdoc