ptx(1) General Commands Manual ptx(1)
NAME
ptx - permuted index
SYNOPSIS
[options] [input [output]]
DESCRIPTION
generates the file output that can be processed with a text formatter to produce a permuted index of file input (standard input and output
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 (see sort(1) and Environment Variables below). Finally, the sorted lines are
rotated so the keyword comes at the middle of each line. output is in the form:
.xx "tail" "before keyword" "keyword and after" "head"
where is assumed to be an or macro provided by the user, or provided by the macro package (see NOTES below). The before keyword and key-
word and after 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:
Fold uppercase and lowercase letters for sorting.
Prepare the output for the phototypesetter by using a line length
of 100.
Use the next argument,
n, as the length of the output line. The default line length is 72 characters for and 100 for
Use the next argument,
n, as the number of characters that will reserve in its calculations for each gap among the four parts of the line as
finally printed. The default gap is 3.
Use as keywords only the words given in the
file.
Do not use as keywords any words given in the
ignore file. If the and options are missing, use as the ignore file.
Use the characters in the
break file to separate words. Tab, new-line, and space characters are used as break characters. Punctuation characters
are treated as part of the word in the absence of this option.
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.
EXTERNAL INFLUENCES
Environment Variables
determines the order in which the output is sorted.
determines the default break characters.
If or is not specified in the environment or is set to the empty string, the value of is used as a default for each unspecified or empty
variable. If is not specified or is set to the empty string, a default of ``C'' (see lang(5)) is used instead of If any internationaliza-
tion variable contains an invalid setting, behaves as if all internationalization variables are set to ``C'' (see environ(5)).
International Code Set Support
Single-byte character code sets are supported.
WARNINGS
Line length counts do not account for overstriking or proportional spacing.
Lines containing tildes are botched because uses that character internally.
FILES
NOTES
The macro package is not provided as part of the HP-UX operating system. It is part of the Documenters Work Bench (DWB) software package
originally developed by AT&T which has been ported to HP9000 systems by various third-party software suppliers including Elan Computer
Group, Inc. of Mountain View California and others.
Permuted indexes produced by using usually have a 4-column format that some users prefer and others dislike greatly. The two-column format
index provided in this manual is created by processing index entries that are hidden as comments at the end of each manual entry file.
SEE ALSO
nroff(1), mm(5).
ptx(1)
