Return to ptx.1 CVS log

Up to [Power 6/32 Unix Tahoe 4.2BSD] / cci / usr / src / man / man1

Annotation of cci/usr/src/man/man1/ptx.1, revision 1.1.1.1

1.1       root        1: .TH PTX 1 "18 January 1983"
                      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
                     79: .I /usr/lib/eign
                     80: as the 
                     81: .I
                     82: ignore
                     83: file.
                     84: .TP 
                     85: .BR \-b " break"
                     86: Use the characters in the 
                     87: .I
                     88: break
                     89: file to separate words.
                     90: In any case, tab, newline, and space characters are always used as break characters.
                     91: .TP
                     92: .BR \-r
                     93: Take any leading nonblank characters of each input line to
                     94: be a reference identifier (as to a page or chapter)
                     95: separate from the text of the line.
                     96: Attach that identifier as a 5th field on each output line.
                     97: .PP
                     98: The index for this manual was generated using
                     99: .I ptx.
                    100: .SH FILES
                    101: /usr/bin/sort
                    102: .br
                    103: /usr/lib/eign
                    104: .SH BUGS
                    105: Line length counts do not account for overstriking or
                    106: proportional spacing.
                    107: .br

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.