usr/man/cat1/ptx.0



PTX(1)              UNIX Programmer's Manual               PTX(1)


N\bNA\bAM\bME\bE
     ptx - permuted index

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
     p\bpt\btx\bx [ option ] ...  [ input [ output ] ]

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     _\bP_\bt_\bx generates a permuted index to file _\bi_\bn_\bp_\bu_\bt on file _\bo_\bu_\bt_\bp_\bu_\bt
     (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.  _\bP_\bt_\bx produces output in the form:

          .xx "tail" "before keyword" "keyword and after" "head"

     where .xx may be an _\bn_\br_\bo_\bf_\bf or _\bt_\br_\bo_\bf_\bf(1) macro for user-defined
     formatting.  The _\bb_\be_\bf_\bo_\br_\be _\bk_\be_\by_\bw_\bo_\br_\bd and _\bk_\be_\by_\bw_\bo_\br_\bd _\ba_\bn_\bd _\ba_\bf_\bt_\be_\br fields
     incorporate as much of the line as will fit around the key-
     word when it is printed at the middle of the page.  _\bT_\ba_\bi_\bl and
     _\bh_\be_\ba_\bd, 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.

     The following options can be applied:

     -\b-f\bf   Fold upper and lower case letters for sorting.

     -\b-t\bt   Prepare the output for the phototypesetter; the default
          line length is 100 characters.

     -\b-w\bw _\bn Use the next argument, _\bn, as the width of the output
          line.  The default line length is 72 characters.

     -\b-g\bg _\bn Use the next argument, _\bn, 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.

     -\b-o\bo only
          Use as keywords only the words given in the _\bo_\bn_\bl_\by file.

     -\b-i\bi ignore
          Do not use as keywords any words given in the _\bi_\bg_\bn_\bo_\br_\be
          file.  If the -\b-i\bi and -\b-o\bo options are missing, use
          /_\bu_\bs_\br/_\bl_\bi_\bb/_\be_\bi_\bg_\bn as the _\bi_\bg_\bn_\bo_\br_\be file.

     -\b-b\bb break
          Use the characters in the _\bb_\br_\be_\ba_\bk file to separate words.
          In any case, tab, newline, and space characters are
          always used as break characters.


Printed 7/9/88           April 29, 1985                         1


PTX(1)              UNIX Programmer's Manual               PTX(1)


     -\b-r\br   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 iden-
          tifier as a 5th field on each output line.

     The index for this manual was generated using _\bp_\bt_\bx.

F\bFI\bIL\bLE\bES\bS
     /usr/bin/sort
     /usr/lib/eign

B\bBU\bUG\bGS\bS
     Line length counts do not account for overstriking or pro-
     portional spacing.


Printed 7/9/88           April 29, 1985                         2