ptx

PURPOSE

     Generates a permuted index.

SYNOPSIS
     ptx [ options ] [ input [ output ] ]


DESCRIPTION

     The ptx command reads infile (standard input by default),
     creates a  permuted index from  its input, and  writes to
     outfile (standard output by default).

     The ptx  command searches infile for  keywords, sorts the
     lines, and generates the  file outfile.  outfile can then
     be processed  with nroff or  troff to produce  a permuted
     index from the file infile.

     The ptx command follows three steps:

     1.  In  the  permutation,  generates one  line  for  each
         keyword in an input line,  and rotates the keyword to
         the front.
     2.  Sorts the permuted file.
     3.  Rotates the sorted lines so that the keyword comes at
         the middle of each line.

     The resulting lines in output are in the form:

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

     where  .xx is  an nroff  or troff  macro provided  by the
     user, or provided by the  mptx macro package (see the AIX
     Operating System  Technical Reference for  information on
     this macro package).  The  before keyword and keyword and
     after fields incorporate as much  of the line as will fit
     around the keyword when it  is printed.  tail or head, at
     least  one  of which  is  always  the empty  string,  are
     wrapped-around pieces  small enough to fit  in the unused
     space at the opposite end of the line.

     Notes:

     1.  Line length counts do not account for overstriking or
         proportional spacing.

     2.  Lines that contain tildes (~) do not work because ptx
         uses that character internally.

FLAGS

     -b  break   Uses the characters in the break file to sep-
                 arate words.  Tab  characters, new-line char-
                 acters, and  spaces are always used  as break
                 characters.
     -f          Does  not distinguish  between uppercase  and
                 lowercase   characters  while   sorting  (see
                 "sort").
     -g  num     Uses num  as the  number of  spaces displayed
                 between  the four  parts  of  the line.   The
                 default num is 3.
     -i  ignore  Does not use any words  in the ignore file as
                 keywords.   If the  -i and  -o flags  are not
                 used,  /usr/lib/eign  is the  default  ignore
                 file.
     -o  only    Uses  only  the words  in  the  only file  as
                 keywords.
     -r          Takes any leading nonblank characters of each
                 input line to be a reference identifier sepa-
                 rate  from the  text of  the line.   Attaches
                 that  identifier as  a  fifth  field on  each
                 output line.
     -t          Prepares the output for the phototypesetter.
     -w  num     Uses num  as the  length of the  output line.
                 The default line length  is 72 characters for
                 nroff and 100 for troff.

FILES

     /bin/sort
     /usr/lib/eign
     /usr/lib/tmac/tmac.ptx

RELATED INFORMATION

     The following commands:  "nroff, troff" and "troff."

     The mm and mptx miscellaneous facilities in AIX Operating
     System Technical Reference.

     The "Overview of International Character Support" in Man-
     aging the AIX Operating System.