ndx(1)                                                     ndx(1)



     NAME
          ndx - create a subject-page index for a document

     SYNOPSIS
          ndx subjfile formatter-command-line

     DESCRIPTION
          ndx, given a list of subjects (subjfile), searches a speci-
          fied document and writes a subject-page index to the stan-
          dard output.

          subjfile is the list of subjects to be included in the in-
          dex.  Each subject must begin on a new line and have the
          following format.

               word1 [ word2 ... ] [, wordn ... ]

          Some examples are:

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

          The subject must start in column 1.

          The syntax for formatter-command-line is

               formatter [option(s)] file(s)

          This is the command that is used to create the final form of
          the document.  The following are examples of valid formatter
          command lines:

             mm -Tlp files
             nroff -mm -Tlp -rW60 file
             troff -rB2 -Taps -r01.5i files

          For more information about the formatter command line, see
          mm(1), mmt(1), nroff(1), and troff(1).

          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   Specify troff as the formatting program.




     April, 1990                                                     1

     ndx(1)                                                     ndx(1)



          nroff or mm    Specify 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 docu-
          ment to be printed.  The author must create the document
          separately.  The indexer, of course, should not be used un-
          til the document is complete and no further changes are ex-
          pected.

     EXAMPLES
          The command

             ndx subjfile "nroff -mm -rW70 files" > indexfile

          would produce a subject-page index for the document files
          and take its subjects from the list, subjfile.  The page
          numbers would correspond to the document produced by

             nroff -mm -rW70 files

          The command

             ndx subjfile "mm -rW60 -rN2 -rO0 ch1 ch2 ch3" > indexfile

          would produce a subject-page index for the documents ch1,
          ch2, and ch3.  The page numbers would correspond to the do-
          cuments produced by

             mm -rW60 -rN2 -rO0 ch1 ch2 ch3

          The command

             ndx subjfile "troff -rB2 -rW5i -rO1.5i -mm files" > indexfile

          would produce a subject-page index for the document file.
          The page numbers would correspond to the document produced
          by

             troff -rB2 -rW5i -rO1.5i -mm files


     FILES
          /usr/bin/ndx

     SEE ALSO
          mm(1), mmt(1), nroff(1), subj(1), troff(1).






     2                                                     April, 1990