2.11BSD/man/cat1/ptx.0

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



NAME
     ptx - permuted index

SYNOPSIS
     ptx [ option ] ...  [ input [ output ] ]

DESCRIPTION
     _P_t_x generates a permuted index to file _i_n_p_u_t on file _o_u_t_p_u_t
     (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.  _P_t_x produces output in the form:

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

     where .xx may be an _n_r_o_f_f or _t_r_o_f_f(1) macro for user-defined
     formatting.  The _b_e_f_o_r_e _k_e_y_w_o_r_d and _k_e_y_w_o_r_d _a_n_d _a_f_t_e_r fields
     incorporate as much of the line as will fit around the key-
     word when it is printed at the middle of the page.  _T_a_i_l and
     _h_e_a_d, 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:

     -f   Fold upper and lower case letters for sorting.

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

     -w _n Use the next argument, _n, as the width of the output
	  line.  The default line length is 72 characters.

     -g _n Use the next argument, _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.

     -o only
	  Use as keywords only the words given in the _o_n_l_y file.

     -i ignore
	  Do not use as keywords any words given in the _i_g_n_o_r_e
	  file.  If the -i and -o options are missing, use
	  /_u_s_r/_s_h_a_r_e/_m_i_s_c/_e_i_g_n as the _i_g_n_o_r_e file.

     -b break
	  Use the characters in the _b_r_e_a_k file to separate words.
	  In any case, tab, newline, and space characters are
	  always used as break characters.



Printed 11/26/99	October 22, 1996			1






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



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

     The index for this manual was generated using _p_t_x.

FILES
     /usr/bin/sort
     /usr/share/misc/eign

BUGS
     Line length counts do not account for overstriking or pro-
     portional spacing.









































Printed 11/26/99	October 22, 1996			2