Difference between revisions of "Ptx"

Revision as of 08:34, 11 February 2007

The correct title of this article is ptx. The initial letter is capitalized due to technical restrictions.

ptx is a command-line utility to produce a permuted index of file contents similar to a KWIC (keywords in their context). It is part of the GNU textutils (a sub-category of the GNU coreutils).

Usage

Usage: ptx [OPTION]... [INPUT]...   (without -G)
  or:  ptx -G [OPTION]... [INPUT [OUTPUT]]
Output a permuted index, including context, of the words in the input files.

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
  -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

With no FILE or if FILE is -, read Standard Input.  `-F /' by default.