HP-UX Reference (11i v2 07/12) - 1 User Commands N-Z (vol 2)

p
ptx(1) ptx(1)
NAME
ptx - permuted index
SYNOPSIS
ptx [ options ][input [ output ]]
DESCRIPTION
ptx 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, generat-
ing 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 key-
word comes at the middle of each line.
ptx output is in the form:
.xx "tail""before keyword""keyword and after""head"
where
.xx is assumed to be an
nroff or troff macro provided by the user, or provided by the mptx
macro package (see NOTES below). The before keyword and keyword 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:
-f Fold uppercase and lowercase letters for sorting.
-t Prepare the output for the phototypesetter by using a line length of 100.
-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 cal-
culations 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 charac-
ters are always used as break characters. Punctuation characters are treated as part of
the word in the absence of this option.
-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.
EXTERNAL INFLUENCES
Environment Variables
LC_COLLATE determines the order in which the output is sorted.
LC_CTYPE determines the default break characters.
If LC_COLLATE or LC_CTYPE is not specified in the environment or is set to the empty string, the
value of LANG is used as a default for each unspecified or empty variable. If LANG is not specified or is
set to the empty string, a default of ‘‘C’’ (see lang(5)) is used instead of LANG. If any internationalization
variable contains an invalid setting, ptx 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 ptx uses that character internally.
HP-UX 11i Version 2: December 2007 Update − 1 − Hewlett-Packard Company 185