next up previous contents index
Next: G.3.8 SUN only: mirtool, Up: G.3 Linux workstations - Previous: G.3.6 mknemo   Contents   Index

G.3.7 Documentation

The documentation of NEMO is manyold: first of all there is a Users and Programmers Guide (what you are reading now), which is currently in LaTeX format. Before you format this huge document, be sure to check if the nemo.dvi or even the (compressed) postscript file are not present in the manuals directory:

    % cd $NEMO/text/manual
    % zcat | lpr

or compile it:

    % cd $NEMO/text/manual
    % make nemo

and print it:

    % dvipr nemo    # or whatever your local version is called

The program makeindex is needed by LaTeX, it is a public domain utility, see the local Makefile for more details. The actual commands may be slightly different on your host. If makeindex does not compile or work for you, a dummy zero length file nemo.ind must be created, before LaTeX can be run. You will have to live without an index in this case, or ask the distributors for the nemo.dvi or proper nemo.idx file. Be also aware that the manual (nemo.tex) uses include files (.inc) using the TEX ``\input'' command, and may also include direct postscript files using the special $\backslash$ PSinsert command. There are a few logical ``flags'' using the TEX $\backslash$ newif command, e.g. in the top of the nemo.tex document they are declared as:

    \newif\ifnemo         % declaration of the logical "variables"
    \nemotrue             %  setting the variables to true or false
    \ifindex              % example use of such a conditional 

In particular, the $\backslash$ ifdebug variable is used to comment the margins with all the items that go into the index. This makes proofreading the manual very efficient.

The second form of documentation are online manual pages. For all programs there is (or at least should be) a manual page (see man(1)). These can be individually printed using a shell-script manlaser or:

    % manlaser program.1
    % troff -man -t program.1 | lpr -t 
The command script $NEMO/usr/nemo/maint/PrintMan can be used to print out all manual pages 1,3,5 and 8, but also check the catman target in the toplevel Makefile. This creates fmt files, that can be sent directly to the printer. Be careful about redundant information because of the .SO troff command. The fmt are normally logical links in this case, the script should take care of this, and only print out proper files and not links or zero length files.

Third, there are the doc files. They are needed by various front-end shell (as described in Appendix [*]). The script mkpdoc will check if an update of this doc file is needed; this script is called by mknemo, the quick and dirty procedure to install programs. In principle the doc files don't have to be saved, since they can be generated from the source code.

Fourth, there are the ctex files. In a number of places the source code contains mathematical details in TeX format. A small utility, ctex, extracts the these from the source code, and standard tex utilities can be used to format them. For example, most of the potential(5NEMO) descriptors have an associated CTEX section, from which Appendix #a#>:potential can be generated automatically. Other examples are anisot.c and mkop.c.

next up previous contents index
Next: G.3.8 SUN only: mirtool, Up: G.3 Linux workstations - Previous: G.3.6 mknemo   Contents   Index
(c) Peter Teuben