If problems should arise during the installation, help is available by sending email to iraf@noao.edu or by calling the IRAF Hotline: (520) 318-8160.
If you are updating an existing IRAF installation, you will be replacing IRAF by the new version and IRAF should already have an account and root directory on the desired host system. You should first log in as IRAF and save any locally modified files before deleting the old system. Ordinarily the only directories containing files you may wish to save are dev, hlib, and local. The safest and easiest way to do this is to save the entire contents of those directories. For example:
This would physically move (not copy) the dev, local, and hlib directories to the named directory, which must be on the same disk device as [IRAF]. Many variations on this are possible. The destination directory should be somewhere outside the [IRAF...] directory tree, else it may get deleted when you delete the old system.
Although it is probably simplest and safest to save entire directories as in the example, in practice only a few files are likely to have been modified. These are the following:
Having temporarily preserved all the locally modified files, it is now time to delete the old system and read in the new one. If you are the cautious (prudent?) type you may wish to first preserve the entire existing IRAF system on a backup tape. Using only the standard VMS utilities, the old system may be deleted as follows (assuming IRAF owns all the files in [IRAF...]).
It is normal for the delete command shown to generate lots of messages during execution warning that it cannot delete directories because they are not yet empty. When the command finally executes without any warning messages this means the directory tree has been fully deleted.
Once the old system has been deleted you are ready to install the new one, as described in 'Read in the distribution files' It is important to delete the old system first to avoid creating junk files or directories when the new system is installed (due to file or directory name changes or deletions). Once the new system has been restored to disk, do not merely restore the files saved above, as you will need to carefully merge local changes into the versions of the files supplied with the new IRAF release.
If you are installing IRAF for the first time then the first step is to set up a new account for the user `iraf'. This is necessary for IRAF system management, which should always be done from the IRAF account. Having an IRAF account provides a convenient place (the IRAF system manager's login directory) to keep scratch files created during system configuration.
System management policies vary from site to site, so we do not give specific instructions for how to create the account (e.g., $ run sys$system:authorize), but the account itself should be structured as follows:
If you are installing from tape skip forward to (from tape) . If you are installing from a network distribution (i.e., from disk) continue with the next section.
VMS/IRAF is available over the network via anonymous ftp from the node iraf.noao.edu, in the subdirectory iraf/vnnn/VMS7, where 'vnnn' is the IRAF version number, e.g., subdirectory iraf/v211/VMS7 for V2.11 VMS/IRAF. Complete instructions for retrieving IRAF from the network archive are given in the README file in this directory. The retrieval can be accomplished with UNIX FTP, VMS FTP or VMS DECNET.
The above directory contains the entire VMS/IRAF distribution, including both sources and binaries for both VAX and AXP. Both sets of binaries do not have to be downloaded if you will only be running VMS/IRAF on one platform. For example, if you wanted to install IRAF on the Alpha architecture only, you should not grab the files with suffix '_VAX' since they are used only for the VAX. The files in this directory are compressed (zipped) VMS backup save files. To reconstruct the original backup save file, the files need to be uncompressed and then restored using the BACKUP command as described in the README file. Once the disk save set has been reconstructed on your local disk, you can proceed with the installation.
Login as IRAF (ignore any LOGIN.COM not found error message) and run the VMS backup utility to read the backup save sets:
In this and all the following examples, names like disk:, etc., denote site dependent device names for which you must supply values.
Login as IRAF (ignore any LOGIN.COM not found error message) and run the VMS backup utility to read the backup tape or tapes provided.
The tape may be restored while logged in as SYSTEM if desired, but the switch /OWNER=IRAF should be appended to give the IRAF system manager (anyone who logs in as IRAF) write permission on the files.
It typically takes twenty minutes to half an hour to read the tape on a lightly loaded system.
If this is a new IRAF installation this step can be skipped. Otherwise, once the new system has been restored to disk any local revisions made to the previous IRAF installation should be merged back into the new system. See Existing for a list of the files most likely to be affected. When propagating revisions made to these files, be sure to not replace the entire file with your saved version, as the version of the file in the new release of IRAF will often contain important additions or changes which must be preserved. It is best to merge your revisions into the version of the file which comes with the new IRAF.
This task will be easier if the revisions have been localized as far as possible, e.g., keep all termcap additions together at the head of the file, so that they may merely be transferred to the new file with the editor. The task of propagating revisions will also be much easier if detailed notes have been kept of all revisions made since the last release was installed.
The files listed below must be edited before the system can be run. The principal change required is to change the pathnames of the major IRAF logical directories for the local machine. If any of these files are edited while logged in as SYSTEM, be sure to do a set file/owner=iraf to restore ownership of the edited file to IRAF.
This file defines the VMS logical names and symbols needed to run IRAF. The site dependent ones are grouped at the beginning of the file. The top of the distributed file looks like this:
$! IRAFUSER.COM -- VMS symbols and logicals for using IRAF. $! $! The following logical names are system-dependent. IMDIRDISK and $! TEMPDISK should be public devices and may be the same device. $! $ define/job IRAFDISK USR$3: ! Disk IRAF resides on $ define/job IMDIRDISK SCR$4: ! User image subdirectories go here $ define/job TEMPDISK SCR$2: ! Runtime (scratch) files go here $ define/job IRAFGMTOFF-7 ! Offset from GMT in hours $! define/job IRAFUHNT (file) ! Use (file) instead of dev$uhosts $!
This command procedure is run by the system manager, or by the system at boot time, to install the IRAF shared library and selected executable images (In VMS terminology, image, as in "executable image" refers to the executable program, and has nothing to do with IRAF image data)
Installing images in system memory is necessary to permit memory sharing in VMS, and can greatly reduce physical memory usage and paging on a busy system, while speeding process startup. Installing images also consumes system global pages, however, of which there is a limited supply. Hence, one should only install those images which will be used enough to make it worthwhile. See installing executables for more information.
The install.com procedure both installs the IRAF executables and replaces them after any have been changed. It works from a separate list of files, so you should not edit install.com itself. Instead, edit install.lst to select files by commenting out only those which are not to be installed (the comment character is a "!" at the beginning of the line).
The IRAF shared library s_iraf.exe should always be installed if IRAF is going to be used at all, or the system will execute very inefficiently (the IRAF shared library is used by all executing IRAF processes). Normally the executables cl.exe and x_system.exe should also be installed, since these are used by anyone using IRAF, as well as by all batch IRAF jobs. If IRAF is heavily used and sufficient global pages are available it is also desirable to install x_images.exe and x_plot.exe, since virtually everyone uses these executable images frequently when using IRAF. It is probably not worthwhile to install any other executables, unless usage at the local site involves heavy use of specific additional executable images.
This file (often referred to as "<iraf.h>") is required to compile any of the C source files used in IRAF. Most sites will not need to recompile the C sources and indeed may not even have the DEC C compiler, but the file is also used by the runtime system in some cases to resolve logical names, hence must be edited and installed in the VMS system library. Change the following disk names as required for your system, referencing only system wide logical names in the new directory pathnames (e.g. usr1:[IRAF.VMS], where usr1 is a system logical name; do not leave the IRAF logicals like irafdisk in the definition).
IRAF Logical Directory VMS directory HOST irafdisk:[IRAF.VMS] IRAF irafdisk:[IRAF] TMP tempdisk:[IRAFTMP]
If local system restrictions forbid a public IRAFTMP directory, set this entry to the pathname of a suitable directory in IRAF, e.g., [IRAF.LOCAL.UPARM]. This should work in most circumstances, since it is most likely to be the IRAF system manager who runs a program that accesses these pathnames. This is separate from the user-level private IRAFTMP irectory discussed in Appendix A.
.FE
These directory definitions are referenced only if logical name translation fails, as sometimes happens on VMS systems for various reasons. It is therefore essential that only system wide logical names be used in these directory pathnames. Do not use job or process logicals. Do not change the order in which the entries appear, or otherwise alter the syntax; the kernel code which scans <iraf.h> is very strict about the syntax.
Login again as SYSTEM and copy the recently edited file irafdisk:[iraf.vms.hlib.libc]iraf.h to the system library, ensuring that the file has world read permission (be sure not to copy [iraf.vms.hlib]iraf.h by mistake)(1):
Add the following statement to the system SYLOGIN.COM file, making the appropriate substitution for disk.
Add the following statement to the SYSTARTUP_VMS.COM file, read by the system at startup time. This is necessary to cause the IRAF executables to be reinstalled in system memory when the system is rebooted.
While still logged in as SYSTEM, type in the above command interactively to perform the initial executable image installation. It may be necessary to increase the number of system global pages for the command to execute successfully. If you do not want to install the set of IRAF executables normally installed at NOAO, edit [iraf.vms.hlib]install.lst before executing install.com (see Installing executables ).
Lastly, log out of SYSTEM, and back in as IRAF. Update the date stamp of a file that is used to ensure that newly updated parameter sets are used rather than any old versions a user might have around: