ptx(1)                                                     ptx(1)



     NAME
          ptx - make permuted index

     SYNOPSIS
          ptx [-b break] [-f] [-g gap] [-i ignore] [-o only] [-r] [-t]
          [-w n] [input [output]]

     DESCRIPTION
          ptx generates the file output that can be processed with a
          text formatter (nroff or troff) to produce a permuted index
          of file input.  Standard input (-) and standard output are
          default.  ptx has three phases:  first, the permutation is
          done, generating one line for each keyword in an input line.
          The keyword is rotated to the front.  Second, the permuted
          file is then sorted.  Finally, the sorted lines are rotated
          so the keyword comes at the middle of each line.  ptx output
          is in the following form:

             .xx "tail" "before keyword" "keyword and after" "head"

          where .xx is assumed to be an nroff(1) or troff(1) macro
          provided by the user or provided by ptx(1).  The mptx(5)
          macro package provides the .xx macro definition.  The before
          keyword and keyword and after fields incorporate as much of
          the line as fits around the keyword when it is printed.  The
          tail and head fields, at least one of which is always the
          empty string, are wrapped-around pieces small enough to fit
          in the unused space at the opposite end of the line.

     FLAG OPTIONS
          The following flag options can be applied:

          -f       Fold upper and lowercase letters for sorting.
          -t       Prepare the output for the phototypesetter.
          -w n     Use the next argument n as the length of the output
                   line.  The default line length is 72 characters for
                   nroff and 100 for troff.
          -g n     Use the next argument n as the number of characters
                   that ptx reserves in its calculations for each gap
                   among the four parts of the line as finally print-
                   ed.  The default gap is 3.
          -o only  Use as keywords any words given in the file only.
                   This option cannot be used with the -i option.
          -i ignore
                   Do not use as keywords any words given the file ig-
                   nore.  If the -i and -o options are missing, use
                   /usr/lib/eign as the file ignore.  This option can-
                   not be used with the -o option.
          -b break Use the characters in the file break to separate
                   words.  Tab, newline, and space characters are al-
                   ways used as break characters.
          -r       Take any leading nonblank characters of each input



     April, 1990                                                     1

     ptx(1)                                                     ptx(1)



                   line to be a reference identifier (as to a page or
                   chapter), separate from the text of the line.  At-
                   tach that identifier as a 5th field on each output
                   line.

     FILES
          /usr/bin/ptx
          /bin/sort
          /usr/lib/eign
          /usr/lib/tmac/tmac.ptx

     SEE ALSO
          troff(1), mm(5), mptx(5).

          ``Other Text Processing Tools,'' in A/UX Text Processing
          Tools.

     BUGS
          Line-length counts do not account for overstriking or pro-
          portional spacing.  Lines that contain tildes (~) are
          botched because ptx uses that character internally.  ptx
          does not discard nonalphanumeric characters.

































     2                                                     April, 1990