Section 3: DOCUMENTATION

How can I learn to use IRAF?

 The best way to learn to use IRAF is to actually sit down and use it, making
use of available cookbooks, the Beginner's Guide, or exercises.
1) If you have some photometric or spectroscopic data that need to be reduced
then sit down with one of the cookbooks available for these procedures, select
a small subset of data, and actually start to do some reductions.  Become
familiar with the online help to assist you with understanding the tasks.
2) There is "A Beginner's Guide to Using IRAF (IRAF Version 2.10)" that has
many examples in it that you can also use to get started.  This manual is
available in the pub directory in our IRAF network archive as the file
beguide.ps.Z (compressed PostScript).
3) There are also some IRAF exercises available.  These are exercises that
use real data to do basic CCD reductions, photometric reductions through
standard calibration, spectroscopic reductions through extraction and
wavelength calibration, and data i/o manipulations.  These exercises are
bundled together in a tar file and are available in the IRAF network archive
in the /iraf/misc directory as exer2102.tar.Z - see the exer2102.readme for
installation instructions (a version is also available for V2.10.3 systems).
The IRAF network archive can be reached by anonymous FTP to the node
iraf.noao.edu (140.252.1.1).  Binary files (including compressed PostScript
and tar files with a '.Z' extension) need to be transferred as "binary".

Is there a beginner's guide for IRAF?

 There is a "draft" beginner's guide for IRAF that is available in the pub
directory in the anonymous FTP archive on iraf.noao.edu (140.252.1.1) - it is
called beguide.ps.Z.  This file is distributed as compressed PostScript so be
sure to set binary mode before the transfer.

Is there IRAF help online?

 All tasks in IRAF have "help" pages describing the parameters used by
the tasks and how the tasks work.  These can be accessed by "help <taskname>"
or "phelp <taskname>" - the phelp task allows you to space back in the help
file as well as forward (help only goes forward).
If you would like to print a help file to your default IRAF printer (defined
by the IRAF environment variable "printer") then use the following:
   cl> show printer
   cl> set printer = <your_printer>
   cl> help <taskname> | lprint

What general documentation is available? Where can I find it?

 There is a lot of IRAF documentation available in the form of technical
specifications for an interface or package, cookbooks for specific
procedures, programming documents, or overviews of packages or procedures.
Most of these documents are available by anonymous FTP to the node iraf.noao.edu
(140.252.1.1) - look at the README file in the /iraf/docs directory for a list
of the documents available to you in this directory.
Some documents are also available in the iraf$doc directory as part of your
IRAF distribution.

What documentation do you recommend that I have for the latest release?

 Here is a brief list of IRAF documentation that may be useful for V2.11.
All documentation is available in the IRAF network archive in the /iraf/docs
directory accessible by anonymous FTP to the node iraf.noao.edu, unless
otherwise noted.
Introductory Materials:
    A Beginner's Guide to Using IRAF (IRAF Version 2.10), Jeannette Barnes,
    August 1993, (beguide.ps.Z in the pub directory)
    A User's Introduction to the IRAF Command Language Version 2.3, Peter MB
    Shames and Doug Tody, August 1986, (cluser.ps.Z)
    Preliminary Test Procedure for IRAF, IRAF Version 2.11, Jeannette Barnes,
    revised Sept 1997, (testproc.ps.Z)
Cookbooks and Guides:
    A User's Guide to CCD Reductions with IRAF, Philip Massey, Feb 1997,
    (ccduser3.ps.Z)
    A User's Guide to Reducing Slit Spectra with IRAF, Phil Massey, Frank
    Valdes, Jeannette Barnes, April 1992, (spect.ps.Z)
    A User's Guide to Reducing Echelle Spectra With IRAF, Daryl Willmarth
    and Jeannette Barnes, May 1994, (ech.ps.Z)
    Guide to the Coude Three Fiber Reduction Task DO3FIBER, Francisco Valdes,
    April 1992, (do3fiber.ps.Z)
    Guide to the ARGUS Reduction Task DOARGUS, Francisco Valdes, April 1992,
    (doargus2.ps.Z)
    Guide to the Multifiber Reduction Task DOFIBERS, Francisco Valdes,
    April 1992, (dofibers2.ps.Z)
    Guide to the HYDRA Reduction Task DOHYDRA, Francisco Valdes, April 1992,
    (dohydra.ps.Z)
    Guide to the Slit Spectra Reduction Task DOSLIT, Francisco Valdes,
    February 1993, (doslit.ps.Z)
    Guide to the Slit Spectra Reduction Task DOECSLIT, Francisco Valdes,
    February 1993, (doecslit.ps.Z)
    Guide to the Fiber Optic Echelle Reduction Task DOFOE, Francisco Valdes,
    April 1992, (dofoe.ps.Z)
    A User's Guide to Stellar CCD Photometry with IRAF, Philip Massey and
    Lindsey Davis, April 1992, (daophot2.ps.Z)
    Specifications for the Aperture Photometry Package, Lindsey Davis, revised
    October 1987, (apspec.ps.Z)
    A Reference Guide to the IRAF/DAOPHOT Package, Lindsey E. Davis, January
    1994, (daorefman.ps.Z)
    Photometry Using IRAF, Lisa A. Wells, February 1994, (photom.ps.Z)
    Rectifying and Registering Images Using IRAF, Lisa A. Wells, April 1994,
    (reg.ps.Z)
    Cleaning Images of Bad Pixels and Cosmic Rays Using IRAF, Lisa A. Wells
    and David J. Bell, September 1994, (clean.ps.Z)
Programming Guides:
    A User's Guide to Fortran Programming in IRAF  The IMFORT Interface,
    Doug Tody, September 1986, (imfort.ps.Z)
    Specifying Pixel Directories with IMFORT, Doug Tody, June 1989,
    (imfortmem.ps.Z)
    An Introductory User's Guide to IRAF Scripts, revised by Rob Seaman,
    September 1989, (script.ps.Z)
    An Introductory User's Guide to IRAF SPP Programming, Rob Seaman,
    October 1992, (sppguide.ps.Z)
Other Useful Documents:
    IRAF Newsletter, April 1998 (newslet_14.pdf, newslet_14.ps.gz)
    Table of Contents for IRAF Newsletters, (TOC_news.txt)
    Table of Contents for IRAF User Handbook Volume 1A, (TOC210_vol1a.txt)
    Table of Contents for IRAF User Handbook Volume 2B, (TOC210_vol2b.txt)
    The IRAF Packages, IRAF Version 2.10, (glos210a.ps.Z)
    The NOAO Packages, IRAF Version 2.10, (glos210b.ps.Z)
    IRAF Version 2.10 Revisions Summary, July 1992, (v210revs.ps.Z)

What manuals are available for helping me do photometry?

 IRAF users doing photometry might find the following documents useful.  They
are all available in our anonymous FTP archive on iraf.noao.edu (140.252.1.1)
in the /iraf/docs directory.
    Photometry Using IRAF, Lisa A. Wells, February 1994, (photom.ps.Z)
    A User's Guide to CCD Reductions with IRAF, Philip Massey, Feb 1997,
    (ccduser3.ps.Z)
    A User's Guide to Stellar CCD Photometry with IRAF, Philip Massey and
    Lindsey Davis, April 1992, (daophot2.ps.Z)
    Specifications for the Aperture Photometry Package, Lindsey Davis, revised
    October 1987, (apspec.ps.Z)
    A User's Guide to the IRAF Apphot Package, Lindsey Davis, revised May 1989,
    (apuser.ps.Z)
    A Reference Guide to the IRAF/DAOPHOT Package, Lindsey E. Davis, January
    1994, (daorefman.ps.Z)
    See the online help for photcal.pcintro and photcal.config describing the
    PHOTCAT package.
    A Beginner's Guide to Using IRAF (IRAF Version 2.10), Jeannette Barnes,
    August 1993, (beguide.ps.Z in the pub directory)

What manuals are available for helping me do spectroscopy?

 IRAF users wishing to do spectroscopic reductions will find a variety
of documents available for the different types of reductions possible.
They are all available in our anonymous FTP archive on iraf.noao.edu in
the /iraf/docs directory.
    A User's Guide to CCD Reductions with IRAF, Philip Massey, Feb 1997,
    (ccduser3.ps.Z)
    A User's Guide to Reducing Slit Spectra with IRAF, Phil Massey, Frank
    Valdes, Jeannette Barnes, April 1992, (spect.ps.Z)
    A User's Guide to Reducing Echelle Spectra With IRAF, Daryl Willmarth
    and Jeannette Barnes, May 1994, (ech.ps.Z)
    Guide to the Coude Three Fiber Reduction Task DO3FIBER, Francisco Valdes,
    April 1992, (do3fiber.ps.Z)
    Guide to the ARGUS Reduction Task DOARGUS, Francisco Valdes, April 1992,
    (doargus2.ps.Z)
    Guide to the Multifiber Reduction Task DOFIBERS, Francisco Valdes,
    July 1995, (dofibers.ps.Z)
    Guide to the HYDRA Reduction Task DOHYDRA, Francisco Valdes, July 1995,
    (dohydra.ps.Z)
    Guide to the Slit Spectra Reduction Task DOSLIT, Francisco Valdes,
    Feb 1993, (doslit.ps.Z)
    Guide to the Slit Spectra Reduction Task DOECSLIT, Francisco Valdes,
    Feb 1993, (doecslit.ps.Z)
    Guide to the Fiber Optic Echelle Reduction Task DOFOE, Francisco Valdes,
    April 1992, (dofoe.ps.Z)
    See the online help for onedspec.package and onedspec.specwcs for a
    discussion of the onedspec package, the spectral image formats, and the
    dispersion world coordinate systems.
    A Beginner's Guide to Using IRAF (IRAF Version 2.10), Jeannette Barnes,
    August 1993, (beguide.ps.Z in the pub directory)

What documents are available for general image processing?

 We have very little documentation directed at general image processing.
We are trying to rectify that however.  For now we recommend the
following documents from our FTP archive on iraf.noao.edu in the /iraf/docs
directory.
    A Beginner's Guide to Using IRAF (IRAF Version 2.10), Jeannette Barnes,
    August 1993, (beguide.ps.Z in the pub directory)
    The IRAF Packages, IRAF Version 2.10, (glos210a.ps.Z)
    The NOAO Packages, IRAF Version 2.10, (glos210b.ps.Z)
    Rectifying and Registering Images Using IRAF, Lisa A. Wells, April 1994,
    (reg.ps.Z)
    Cleaning Images of Bad Pixels and Cosmic Rays Using IRAF, Lisa A. Wells
    and David J. Bell, September 1994, (clean.ps.Z)

What programming documentation is available?

 There are several manuals available to assist you with programming in IRAF;
the one you will need will depend on the type of programming you expect to do.
They are all available in the /iraf/docs directory on the node iraf.noao.edu
(140.252.1.1) by anonymous FTP.  The documents are compressed so be sure
to declare binary before the transfer.
1) scripts - An Introductory User's Guide to IRAF Scripts, revised by Rob
Seaman, September 1989, 49 pages (script.ps.Z).
2) IMFORT - A User's Guide to Fortran Programming in IRAF: The IMFORT
Interface, Doug Tody, September 1986, 29 pages [manual pages not included]
(imfort.ps.Z).
Specifying Pixel Directories with IMFORT, Doug Tody, June 1989, 1 page [short
memo describing a modification to IMFORT] (imfortmem.ps.Z)
3) SPP -  An Introductory User's Guide to IRAF SPP Programming, Rob Seaman,
October 1992, 76 pages (sppguide.ps.Z).
SPP Reference Manual, Zolt Levay, October 1992 - see the archives at
stsci.edu in the software/stsdas/v1.3/doc/programmer/spp directory.
4) There are many more older documents that may be referenced by the above
that are also available.  These are all listed in the TOC_vol3a.txt
and TOC_vol3b.txt files in /iraf/docs.

How can I learn more about the WCS in IRAF?

 There is no one document that we can refer you to learn more about the
WCS.  Depending on your needs one or more of the following may be useful.
1) sys$mwcs/MWCS.hlp - this is the main technical document describing the WCS
interace. You can read this from within IRAF by typing "phelp mwcs$MWCS.hlp f+".
2) A more user friendly description of the WCS can be found in the help pages
for the tasks wcsedit and wcsreset in the proto package.
3) Typing "phelp onedspec.specwcs" will give you information about the way
the WCS in implemented in the spectroscopic packages along with a description
of the spectroscopic keywords used.
4) There were article in two IRAF Newsletters discussing this interface
that may useful to review as well - Number 9 (February/June 1990 - page 3) and
Number 12 (July 1992 - page 5).

What installation manuals are available and where are they?

 Installation manuals are available for each distribution and are in the
same directory as the distributions themselves in the /iraf/v212 directory in
the IRAF network archive (anonymous FTP to iraf.noao.edu [140.252.1.1]).
These installation (and Site Manager Guide's) are also available as unformatted
TROFF source in the iraf$doc directory.  They may also be obtained in the
web at /iraf/web/docs/igsm.html.

Are there revisions notices for the last release?

 Yes, there are revisions notes for the last general release of IRAF,
Version 2.11.  They are available by anonymous FTP to the node iraf.noao.edu
in the /iraf/v212 directory, or on-line as unformatted LROFF in the file
iraf$doc/v212revs.hlp.
There are several different types of revisions notes available:
    -r--rw-r--   1 iraf       311904 May  2  2002 sysnotes.v212
    -rw-rw-r--   1 iraf        54703 Mar 15  2002 v212revs.txt

Is there a buglog for IRAF? How can I get a copy?

 Yes, there is buglog for IRAF.  You can retrieve it by anonymous FTP
to the node iraf.noao.edu (140.252.1.1).  The file, bugs.log, is in the
/iraf/v212 directory and is continuously updated, it may be searched on the
web at /iraf/web/search.

Is there a manual for SAOimage?

 Yes, the "User Manual for SAOimage" by M. VanHilst, dated 1 January 1991.
It is available by anonymous FTP to iraf.noao.edu in the contrib directory
as the file saoimage/saoimage.ps.Z - this is a compressed PostScript file so be
sure to declare binary before the transfer.

How can I subscribe to the IRAF Newsletter?

  The easiest way is to use the electronic form available from our
subscription page.

What is the last issue of the IRAF Newsletter?

 The last issue of the IRAF Newsletter was Newsletter #14, dated April
1998.

Can I get back issues of the IRAF Newsletter?

 Back issues of the IRAF Newsletter are available by anonymous FTP to
iraf.noao.edu in the directory /iraf/docs.  See the files newslet*.  These are
compressed PostScript files so be sure to transfer them as binary.
	-rw-r--r--  1 iraf        60139 Aug 10  1990 newslet_1.ps.Z
	-rw-r--r--  1 iraf        76093 Nov 15  1990 newslet_2.ps.Z
	-rw-r--r--  1 iraf        40020 Jun 27  1990 newslet_3.ps.Z
	-rw-r--r--  1 iraf        44810 Jul  8  1990 newslet_4.ps.Z
	-rw-r--r--  1 iraf        61481 Jun 27  1990 newslet_5.ps.Z
	-rw-r--r--  1 iraf        49042 Jun 27  1990 newslet_6.ps.Z
	-rw-r--r--  1 iraf       118945 Jun 27  1990 newslet_7.ps.Z
	-rw-r--r--  1 iraf        40042 Jun 27  1990 newslet_8.ps.Z
	-rw-r--r--  1 iraf        89599 Jun 27  1990 newslet_9.ps.Z
	-rw-r--r--  1 iraf        68959 Apr 11  1991 newslet_10.ps.Z
	-rw-r--r--  1 iraf        30197 Apr 26  1992 newslet_11.ps.Z
	-rw-r--r--  1 jbarnes     96795 May 25  1993 newslet_12.ps.Z
	-rw-r--r--  1 jbarnes    129569 Mar  9  1995 newslet_13.ps.Z
	-rw-r--r--  1 jbarnes    299262 May  8  1998 newslet_14.pdf
	-rw-r--r--  1 jbarnes    235893 May  8  1998 newslet_14.ps.gz

Is there an index for the Newsletter?

 There is no index for the IRAF Newsletter, but we do have a file containing
the Table of Contents for each Newsletter - perhaps this will help.  You
can acquire this file by anonymous FTP to iraf.noao.edu in the directory
/iraf/docs.  See the TOC_news.txt file.