Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ptx(1) [bsd man page]

PTX(1)							      General Commands Manual							    PTX(1)

ptx - permuted index SYNOPSIS
ptx [ option ] ... [ input [ output ] ] DESCRIPTION
Ptx generates a permuted index to file input on file output (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. Ptx produces output in the form: .xx "tail" "before keyword" "keyword and after" "head" where .xx may be an nroff or troff(1) macro for user-defined formatting. The before keyword and keyword and after fields incorporate as much of the line as will fit around the keyword when it is printed at the middle of the page. Tail and head, 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 only file. -i ignore Do not use as keywords any words given in the ignore file. If the -i and -o options are missing, use /usr/share/misc/eign as the ignore file. -b break Use the characters in the break file to separate words. In any case, tab, newline, and space characters are always used as break characters. -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 identifier as a 5th field on each output line. The index for this manual was generated using ptx. FILES
/usr/bin/sort /usr/share/misc/eign BUGS
Line length counts do not account for overstriking or proportional spacing. 7th Edition October 22, 1996 PTX(1)

Check Out this Related Man Page

PTX(1)								   User Commands							    PTX(1)

ptx - produce a permuted index of file contents SYNOPSIS
ptx [OPTION]... [INPUT]... (without -G) ptx -G [OPTION]... [INPUT [OUTPUT]] DESCRIPTION
Output a permuted index, including context, of the words in the input files. With no FILE, or when FILE is -, read standard input. Mandatory arguments to long options are mandatory for short options too. -A, --auto-reference output automatically generated references -G, --traditional behave more like System V 'ptx' -F, --flag-truncation=STRING use STRING for flagging line truncations. The default is '/' -M, --macro-name=STRING macro name to use instead of 'xx' -O, --format=roff generate output as roff directives -R, --right-side-refs put references at right, not counted in -w -S, --sentence-regexp=REGEXP for end of lines or end of sentences -T, --format=tex generate output as TeX directives -W, --word-regexp=REGEXP use REGEXP to match each keyword -b, --break-file=FILE word break characters in this FILE -f, --ignore-case fold lower case to upper case for sorting -g, --gap-size=NUMBER gap size in columns between output fields -i, --ignore-file=FILE read ignore word list from FILE -o, --only-file=FILE read only word list from this FILE -r, --references first field of each line is a reference -t, --typeset-mode - not implemented - -w, --width=NUMBER output width in columns, reference excluded --help display this help and exit --version output version information and exit AUTHOR
Written by F. Pinard. REPORTING BUGS
GNU coreutils online help: <> Report ptx translation bugs to <> COPYRIGHT
Copyright (C) 2017 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO
Full documentation at: <> or available locally via: info '(coreutils) ptx invocation' GNU coreutils 8.28 January 2018 PTX(1)
Man Page