[unix-history] / usr / man / man1 / ptx.1

.TH PTX 1
.SH NAME
ptx \- permuted index
.SH SYNOPSIS
.B ptx
[ option ] ...
[ input [ output ] ]
.SH DESCRIPTION
.I Ptx
generates a permuted index to file
.I input
on file
.I output
(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.
Finally, the sorted lines are rotated so the keyword
comes at the middle of the page.
.I Ptx
produces output in the form:
.br
.IP
\&.xx "tail" "before keyword" "keyword and after" "head"
.LP
where .xx may be an
.I nroff
or
.IR troff (1)
macro
for user-defined formatting.
The
.I before keyword
and
.I keyword and after
fields incorporate as much of the line as will fit
around the keyword when it is printed at the middle of the page.
.I Tail
and
.I head,
at least one of which is an empty string "",
are wrapped-around pieces small enough to fit
in the unused space at the opposite end of the line.
When original text must be discarded, `/' marks the spot.
.PP
The following options can be applied:
.TP
.BR \-f
Fold upper and lower case letters for sorting.
.TP 
.BR \-t
Prepare the output for the phototypesetter;
the default line length is 100 characters.
.TP 
.BI \-w " n"
Use the next argument,
.I n,
as the width of the output line.
The default line length is 72 characters.
.TP
.BI \-g " n"
Use the next argument,
.I n,
as the number of characters to allow for each gap
among the four parts of the line as finally printed.
The default gap is 3 characters.
.TP 
.BR \-o " only"
Use as keywords only the words given in the \fIonly\fR file.
.TP 
.BR \-i " ignore"
Do not use as keywords any words given in the
.I
ignore
file.
If the \fB\-i\fR and \fB\-o\fR options are missing, use /usr/lib/eign
as the 
.I
ignore
file.
.TP 
.BR \-b " break"
Use the characters in the 
.I
break
file to separate words.
In any case, tab, newline, and space characters are always used as break characters.
.TP
.BR \-r
Take any leading nonblank 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.
.PP
The index for this manual was generated using
.I ptx.
.SH FILES
/bin/sort
.br
/usr/lib/eign
.SH BUGS
Line length counts do not account for overstriking or
proportional spacing.
.br
Commit	Line	Data
e3758c96 C	1	.TH PTX 1
	2	.SH NAME
	3	ptx \- permuted index
	4	.SH SYNOPSIS
	5	.B ptx
	6	[ option ] ...
	7	[ input [ output ] ]
	8	.SH DESCRIPTION
	9	.I Ptx
	10	generates a permuted index to file
	11	.I input
	12	on file
	13	.I output
	14	(standard input and output default).
	15	It has three phases: the first does the permutation, generating
	16	one line for each keyword in an input line.
	17	The keyword is rotated to the front.
	18	The permuted file is then
	19	sorted.
	20	Finally, the sorted lines are rotated so the keyword
	21	comes at the middle of the page.
	22	.I Ptx
	23	produces output in the form:
	24	.br
	25	.IP
	26	\&.xx "tail" "before keyword" "keyword and after" "head"
	27	.LP
	28	where .xx may be an
	29	.I nroff
	30	or
	31	.IR troff (1)
	32	macro
	33	for user-defined formatting.
	34	The
	35	.I before keyword
	36	and
	37	.I keyword and after
	38	fields incorporate as much of the line as will fit
	39	around the keyword when it is printed at the middle of the page.
	40	.I Tail
	41	and
	42	.I head,
	43	at least one of which is an empty string "",
	44	are wrapped-around pieces small enough to fit
	45	in the unused space at the opposite end of the line.
	46	When original text must be discarded, `/' marks the spot.
	47	.PP
	48	The following options can be applied:
	49	.TP
	50	.BR \-f
	51	Fold upper and lower case letters for sorting.
	52	.TP
	53	.BR \-t
	54	Prepare the output for the phototypesetter;
	55	the default line length is 100 characters.
	56	.TP
	57	.BI \-w " n"
	58	Use the next argument,
	59	.I n,
	60	as the width of the output line.
	61	The default line length is 72 characters.
	62	.TP
	63	.BI \-g " n"
	64	Use the next argument,
65	.I n,
66	as the number of characters to allow for each gap
67	among the four parts of the line as finally printed.
68	The default gap is 3 characters.
69	.TP
70	.BR \-o " only"
71	Use as keywords only the words given in the \fIonly\fR file.
72	.TP
73	.BR \-i " ignore"
74	Do not use as keywords any words given in the
75	.I
76	ignore
77	file.
78	If the \fB\-i\fR and \fB\-o\fR options are missing, use /usr/lib/eign
79	as the
80	.I
81	ignore
82	file.
83	.TP
84	.BR \-b " break"
85	Use the characters in the
86	.I
87	break
88	file to separate words.
89	In any case, tab, newline, and space characters are always used as break characters.
90	.TP
91	.BR \-r
92	Take any leading nonblank characters of each input line to
93	be a reference identifier (as to a page or chapter)
94	separate from the text of the line.
95	Attach that identifier as a 5th field on each output line.
96	.PP
97	The index for this manual was generated using
98	.I ptx.
99	.SH FILES
100	/bin/sort
101	.br
102	/usr/lib/eign
103	.SH BUGS
104	Line length counts do not account for overstriking or
105	proportional spacing.
106	.br