ndx Command

Edit online

Purpose

Creates a subject-page index for a document.

Syntax

ndx [  SubjectFile ] " FormatterCommandLine "

Description

The ndx command, given a list of subjects (SubjectFile), searches a specified English-language document and writes a subject-page index to standard output.

The document must include formatting directives for the mm, mmt, nroff, or troff commands. The formatter command line informs the ndx command whether the troff command, nroff command, mm command, or mmt command can be used to produce the final version of the document. These commands do the following:

Item Description
troff or mmt Specifies the troff command as the formatting program.
nroff or mm Specifies the nroff command as the formatting program.

Parameters

Item Description
SubjectFile Specifies the list of subjects that are included in the index. Each subject must begin on a new line and have the following format:

word1[word2...][,wordk...]

For example:

printed circuit boards
arrays
arrays, dynamic storage
Smith, W.P.
printed circuit boards, channel-oriented
                               multi-layer
Aranoff
University of Illinois
PL/1

The subject must start in column one.
FormatterCommandLine Creates the final form of the document. The syntax for this parameter is as follows:

Formatter [Flag...] File...

mm -Tlp File(s)
nroff -mm -Tlp -rW60 File(s)
troff -rB2 -Tibm3816 -r01.5i File(s)

For more information on the formatter command line, see the mmt command, nroff command, and html