Return to ptx.1 CVS log

Up to [Research Unix] / researchv10dc / man / adm / man1

Annotation of researchv10dc/man/adm/man1/ptx.1, revision 1.1.1.1

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

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