NAME

ptx − make permuted index

SYNOPSIS

ptx [ option(s) ] [ input [ output ] ]

DESCRIPTION

Ptx generates the file output that can be processed with a text formatter (nroffortroff) to produce a permuted index of file input. 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 form:

.xx "" "before keyword" "keyword" "after keyword"

where .xx is assumed to be an nroff(1) or troff(1) macro provided by the user, or provided by ptx(1). The mptx macro package provides the .xx macro definitions. 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 to fit in the unused space at the opposite end of the line. 

The following option(s) 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 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.  Tab, new-line, 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. 

FILES

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

SEE ALSO

nroff(1), troff(1), mm(5), mptx(5). 

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-alpha-numeric characters. 

Version 2.5r1  —  December 06, 1986