4.3BSD-Reno/share/man/cat1/ptx.0

PTX(1)			    UNIX Reference Manual			PTX(1)

NNAAMMEE
     ppttxx - permuted index

SSYYNNOOPPSSIISS
     ppttxx [option] ...  [input [output]]

DDEESSCCRRIIPPTTIIOONN
     PPttxx generates a permuted index to file _i_n_p_u_t on file _o_u_t_p_u_t (standard in-
     put and output default).  It has three phases: the first does the permu-
     tation, generating one line for each keyword in an input line.  The key-
     word is rotated to the front.  The permuted file is then sorted.  Final-
     ly, the sorted lines are rotated so the keyword comes at the middle of
     the page.	PPttxx produces output in the form:

	   .xx tail before keyword keyword and after head

     where .xx may be an nroff(1) or troff(1) macro for user-defined format-
     ting.  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 keyword 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 dis-
     carded, `/' marks the spot.

     The following options can be applied:

     --ff        Fold upper and lower case letters for sorting.

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

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

     --gg _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 print-
	       ed.  The default gap is 3 characters.

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

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

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

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

     The index for this manual was generated using ppttxx.

FFIILLEESS
     /usr/bin/sort
     /usr/share/dict/eign


HHIISSTTOORRYY
     PPttxx appeared in Version 7 AT&T UNIX
BBUUGGSS
     Line length counts do not account for overstriking or proportional spac-
     ing.