Subversion Repositories planix.SVN

Rev

Rev 2 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 - 1 
.TH PTX 1
2 
.CT 1 writing_aids
3 
.SH NAME
4 
ptx \- permuted index
5 
.SH SYNOPSIS
6 
.B ptx
7 
[
8 
.I option ...
9 
]
10 
[
11 
.I input
12 
]
13 
.SH DESCRIPTION
14 
.I Ptx
15 
place on standard output a permuted index to file
16 
.I input
17 
or to standard input.
18 
It has three phases: the first does the permutation, generating
19 
one line for each keyword in an input line.
20 
The keyword is rotated to the front.
21 
The permuted file is then
22 
sorted.
23 
Finally, the sorted lines are rotated so the keyword
24 
comes at the middle of the page.
25 
The output is exemplified by:
26 
.br
27 
.IP
28 
.L
29 
\&.xx "tail" "before" "keyword and after" "head"
30 
.LP
31 
where
32 
.L .xx
33 
may be defined as a
34 
.IR troff (1)
35 
macro
36 
for user-defined formatting.
37 
The
38 
.I before
39 
and
40 
.I keyword and after
41 
fields incorporate as much of the line as will fit
42 
around the keyword when it is printed at the middle of the page.
43 
.I Tail
44 
and
45 
.I head,
46 
at least one of which is an empty string,
47 
are wrapped-around pieces small enough to fit
48 
in the unused space at the opposite end of the line.
49 
When original text must be discarded,
50 
.L /
51 
marks the spot.
52 
.PP
53 
The following options can be applied:
54 
.TP
55 
.BR -f
56 
Fold upper and lower case letters for sorting.
57 
.TP
58 
.BR -t
59 
Prepare the output for
60 
.RI troff (1).
61 
.TP
62 
.BI -w " w"
63 
The width of the permuted output is
64 
.IR w ;
65 
default is
66 
.B 72n
67 
in
68 
.I nroff,
69 
.B 100n
70 
in
71 
.I troff.
72 
.TP
73 
.BI -g " w"
74 
The width of the gutter before the third part
75 
of the line is
76 
.IR w ;
77 
default is
78 
.BR 3n .
79 
.TP
80 
.BI -h " w"
81 
The minimum width hole between the
82 
first and second or third and and fourth parts
83 
of the line is
84 
.IR w ;
85 
default is the gutter width.
86 
.TP
87 
.BI -c " cmds"
88 
Use the (newline-separated)
89 
.I troff
90 
commands to determine widths of input characters.
91 
Implies
92 
.BR -t .
93 
.TP
94 
.BI -o " only"
95 
Use as keywords only the words given in the
96 
.I only
97 
file.
98 
.TP
99 
.BI -i " ignore"
100 
Do not use as keywords any words given in the
101 
.I
102 
ignore
103 
file.
104 
If the
105 
.B -i
106 
and
107 
.B -o
108 
options are missing, use
109 
.F /sys/lib/man/permind/eign
110 
as the
111 
.I
112 
ignore
113 
file.
114 
.TP
115 
.BI -b " break"
116 
Use the characters in the
117 
.I break
118 
file to separate words.
119 
In any case, tab, newline, and space characters are always used as break characters.
120 
.TP
121 
.B -r
122 
Take any leading nonblank characters of each input line to
123 
be a reference identifier (as to a page or chapter)
124 
separate from the text of the line.
125 
Attach that identifier as a 5th field on each output line.
126 
.PP
127 
The index for this manual was generated using
128 
.I ptx.
129 
.SH FILES
130 
.TF junk*
131 
.TP
132 
.B junk*
133 
temporary files
134 
.TP
135 
.B /sys/lib/man/permin/ignore