PTX(1) General Commands Manual PTX(1)
ptx - generate a permuted index
ptx [ -f ] [ -t ] [ -w n ] [ -g n ] [ -o only ] [ -i ignore ]
[ -b break] [ -r ] [ input [ output ] ]
This command is available with the Text software installation option.
Refer to for information on how to install optional software.
ptx generates a permuted index of the contents of file input onto file
output (defaults are standard input and output). 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 the page. ptx produces output in the form:
.xx "tail" "before keyword" "keyword and after" "head"
where xx may be an nroff(1) or troff(1) macro for user-defined format-
ting. The before keyword and keyword and after fields incorporate as
much of the line as will fit around the keyword when it is printed at
the middle of the page. tail and head, at least one of which is an
empty string "", are wrapped-around pieces small enough to fit in the
unused space at the opposite end of the line. When original text must
be discarded, `/' marks the spot.
-f Fold upper and lower case letters for sorting.
-t Prepare the output for the phototypesetter; the default
line length is 100 characters.
-w n Use the next argument, n, as the width of the output
line. The default line length is 72 characters.
-g n Use the next argument, n, as the number of characters to
allow for each gap among the four parts of the line as
finally printed. The default gap is 3 characters.
-o only Use as keywords only the words given in the only file.
-i ignore Do not use as keywords any words given in the ignore
file. If the -i and -o options are missing, use
/usr/lib/eign as the ignore file.
-b break Use the characters in the break file to separate words.
In any case, TAB, NEWLINE, and SPACE characters are
always used as break characters.
-r Take 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. Attach that identi-
fier as a 5th field on each output line.
nroff(1), sort(1V), troff(1)
Line length counts do not account for overstriking or proportional
21 December 1987 PTX(1)