ptx(1M)                                                             ptx(1M)

NAME
     ptx - make permuted index

SYNOPSIS
     ptx [option ...] [input [output]]

DESCRIPTION
     ptx generates the file output that can be processed with a text for-
     matter (nroff or troff) to produce a permuted index of file input.
     Standard input (-) and standard output are default.

     ptx has three phases: the first does the permutation, generating one
     line for each keyword in an input line. The keyword is rotated to the
     front. 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  ""  "before keyword"  "keyword"  "after keyword"

     where .xx is assumed to be an nroff(1M) or troff(1M) macro provided by
     the user, or provided by ptx(1M). The -mptx macro package provides the
     .xx macro definition. The before keyword and after keyword fields
     incorporate as much of the line as will fit around the keyword when it
     is printed.

     The first field and the last field, 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.

OPTIONS
     -f         Folds uppercase and lowercase letters for sorting.

     -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 nroff
                and 100 for troff.

     -g n       Uses the next argument, n, as the number of characters that
                ptx will reserve in its calculations for each gap among the
                four parts of the line as finally printed. The default gap
                is 3.

     -o only    Uses as keywords any words given in the only file.

     -i ignore  Do not use as keywords any words given the ignore file. If
                the -i and -o options are missing, use /usr/lib/dwb/eign as
                the ignore file.






Page 1                       Reliant UNIX 5.44                Printed 11/98

ptx(1M)                                                             ptx(1M)

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

     -r         Takes any leading non-blank characters of each input line
                to be a reference identifier (as to a page or chapter),
                separate from the text of the line. Attaches that identif-
                ier as a 5th field on each output line.

NOTES
     Line length counts do not account for overstriking or proportional
     spacing. Lines that contain tildes (~) are botched because ptx uses
     that character internally. ptx does not discard non-alphanumeric char-
     acters.

FILES
     /bin/sort

     /usr/lib/dwb/eign

     /usr/lib/tmac/tmac.ptx

SEE ALSO
     nroff(1M), troff(1M), mptx(5).






























Page 2                       Reliant UNIX 5.44                Printed 11/98