ptx(1)                                                     ptx(1)



NAME
     ptx - generates a permuted index

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

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

ARGUMENTS
     -b break
          Uses the characters in the file break to separate
          words.  Tab, newline, and space characters are always
          used as break characters.

     -f   Folds uppercase and lowercase letters for sorting.

     -g gap
          Uses 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 printed.
          The default gap is 3.

     -i ignore
          Does not use as keywords any words given in the file
          ignore.  If the -i and -o options are missing, use
          /usr/lib/eign as the file ignore.  This option cannot
          be used with the -o option.

     input
          Specifies the file to be processed with a text
          formatter.

     -o only
          Uses as keywords any words given in the file only.
          This option cannot be used with the -i option.

     output
          Specifies the file from which a permuted index is
          generated.

     -r   Takes any leading nonblank characters of each input
          line to be a reference identifier (as to a page or
          chapter), separate from the text of the line, then
          attaches that identifier as a fifth field on each
          output line.

     -t   Prepares the output for the phototypesetter.

     -w n Uses the next argument n as the length of the output
          line.  The default line length is 72 characters for



January 1992                                                    1

ptx(1)                                                     ptx(1)



          nroff and 100 for troff.

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
     the default.  The ptx program 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:


     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.

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

FILES
     /usr/bin/ptx
          Executable file
     /bin/sort
          Executable file
     /usr/lib/eign
          Executable file
     /usr/lib/tmac/tmac.ptx
          Executable macro file

SEE ALSO
     troff(1)

     mm(5), mptx(5) in A/UX Programmer's Reference

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









2                                                    January 1992