xref: /original-bsd/usr.bin/ptx/ptx.1 (revision cd89438c)
1.\" Copyright (c) 1990 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.proprietary.roff%
5.\"
6.\"	@(#)ptx.1	6.6 (Berkeley) 04/18/91
7.\"
8.Vx
9.Dd
10.Dt PTX 1
11.Os ATT 7th
12.Sh NAME
13.Nm ptx
14.Nd permuted index
15.Sh SYNOPSIS
16.Nm ptx
17.Op  option
18\&...
19.Op input [output]
20.Sh DESCRIPTION
21.Nm Ptx
22generates a permuted index to file
23.Ar input
24on file
25.Ar output
26(standard input and output default).
27It has three phases: the first does the permutation, generating
28one line for each keyword in an input line.
29The keyword is rotated to the front.
30The permuted file is then
31sorted.
32Finally, the sorted lines are rotated so the keyword
33comes at the middle of the page.
34.Nm Ptx
35produces output in the form:
36.Pp
37.Dl \&.xx "tail" "before keyword" "keyword and after" "head"
38.Pp
39where .xx may be an
40.Xr nroff 1
41or
42.Xr troff  1
43macro
44for user-defined formatting.
45The
46.Ar before keyword
47and
48.Ar keyword and after
49fields incorporate as much of the line as will fit
50around the keyword when it is printed at the middle of the page.
51.Ar Tail
52and
53.Ar head ,
54at least one of which is an empty string "",
55are wrapped-around pieces small enough to fit
56in the unused space at the opposite end of the line.
57When original text must be discarded, `/' marks the spot.
58.Pp
59The following options can be applied:
60.Tw Fl
61.Tp Fl f
62Fold upper and lower case letters for sorting.
63.Tp Fl t
64Prepare the output for the phototypesetter;
65the default line length is 100 characters.
66.Tp Cx Fl w
67.Ws
68.Ar n
69.Cx
70Use the next argument,
71.Ar n ,
72as the width of the output line.
73The default line length is 72 characters.
74.Tp Cx Fl g
75.Ws
76.Ar n
77.Cx
78Use the next argument,
79.Ar n ,
80as the number of characters to allow for each gap
81among the four parts of the line as finally printed.
82The default gap is 3 characters.
83.Tp Cx Fl o
84.Ws
85.Ar only
86.Cx
87Use as keywords only the words given in the
88.Ar only
89file.
90.Tp Cx Fl i
91.Ws
92.Ar ignore
93.Cx
94Do not use as keywords any words given in the
95ignore
96file.
97If the
98.Fl i
99and
100.Fl o
101options are missing, use
102.Pa /usr/share/dict/eign
103as the
104ignore
105file.
106.Tp Cx Fl b
107.Ws
108.Ar break
109.Cx
110Use the characters in the
111break
112file to separate words.
113In any case, tab, newline, and space characters are always used as break characters.
114.Tp Fl r
115Take any leading nonblank characters of each input line to
116be a reference identifier (as to a page or chapter)
117separate from the text of the line.
118Attach that identifier as a 5th field on each output line.
119.Tp
120.Pp
121The index for this manual was generated using
122.Nm ptx .
123.Sh FILES
124.Dw /usr/share/dict.eign
125.Di L
126.Dp /usr/bin/sort
127.Dp /usr/share/dict/eign
128.Dp
129.Sh HISTORY
130.Nm Ptx
131appeared in Version 7 AT&T UNIX
132.Sh BUGS
133Line length counts do not account for overstriking or
134proportional spacing.
135