AT&T UNIX™PC Unix System V Users Manual - tenox

NDX{l) NDX( l)
NAME
ndx - create a subject-page index for a document
SYNOPSIS
ndx [ subjfile ] ''formatter command line "
DESCRIPTION
ndx , given a list of subjects (subifile) , searches a specified document and
writes a subject-page index to the standard output.
subjfile is the list of subjects to be included in the index. Each subject
must begin on a new line and have the following format:
For example,
wordl [word2 ... ] [, wordk ... ]
printed circuit boards
arrays
arrays, dynamic storage
Smith, W. P.
printed circuit boards, channel-oriented multi-layer
Aranoff
University of Illinois
PlJl
The subject must start in column 1.
The syntax for the formatter command line is
formatter [ options ] files
It is the command that will be used to create the final form of the document
The following are examples of valid formatter command lines:
mm -Tip files
nroff -mm -Tip -rW60 files
troff -rB2 -Taps -rOl.Si flies
For more information on the formatter command line, see, mm(l), and
nroff( l).
The document must include formatting commands for mm, nroff, or troff.
The formatter command line tells ndx whether troff, nroff, mm or mmt
would be used to produce the final version of the document.
troff or mmt
specifies troff as the formatting program.
nroff or mm
specifies nroff as the formatting program
The options are those that would be given to the troff, nroff, mm
or mmt command in printing the final form of the document, and
are necessary to determine the correct page numbers for subjects
as they are located in the document ndx does not actually cause
the final version of the document to be printed. The author must
create the document separately. The indexer, of course, should
not be used until the document is complete and no further
- 1 -