PTX(1)

NAME
ptx - make permuted index

SYNOPSIS
ptx [ options []] [ input_file [ output_file []] ]

DESCRTPTION
ptx generates the file output_file that can be processed with a text formatter (nroff or troff) to produce a permuted index of file input_file. Standard input (-) and standard output are default. It 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 is assumed to be an nroff(1) or troff(1) macro provided by the user, or provided by mptx(5). The MPTX macro package provides the macro definition. The before keyword, keyword, and after keyword fields incorporate as much of the line as will fit around the keyword when it is printed. tail and head, 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.

The following options can be applied:

[-f]
Fold upper- and lower-case 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 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]
Use 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 as the ignore file.
    [-b break]
Use the characters in the
    break file to separate words. Tab, newline, and space characters are always used as break characters.
    [-r]
Take 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. Attach that identifier as a 5th field on each output line.

BUGS
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 characters.

FILES

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