ptx Man page

PTX User Commands PTX


ptx – produce a permuted index of file contents


ptx [OPTION]… [INPUT]… (without -G)


Output a permuted index, including context, of the words in the input

With no FILE, or when FILE is -, read standard input.

Mandatory arguments to long options are mandatory for short options

-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

output version information and exit


Written by F. Pinard.


GNU coreutils online help:
Report ptx translation bugs to


Copyright © 2016 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.


Full documentation at:
or available locally via: info ‘(coreutils) ptx invocation’

GNU coreutils 8.25 February 2016 PTX