ptx(1)

ptx1

Produce a permuted index of file contents

Usage

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

ptx -G [OPTION] ... [INPUT [OUTPUT]]

Overview

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

change the default width from 72 to 100

-w, --width=NUMBER

output width in columns, reference excluded

--help

display this help and exit

--version

output version information and exit

Releases

14 releases since Debian 2.2 (Potato); the text changed 13 times.

  1. 2.2
  2. 3.0
  3. 3.1
  4. 4.0
  5. 5.0
  6. 6.0
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. Arch

--typeset-mode since Arch Linux 2026-11-01; -t since Arch Linux 2026-11-01.

--copyright until Debian 4.0 (Etch); -C until Debian 4.0 (Etch).

Author

Written by F. Pinard.

Reporting bugs

Report bugs to: <[email protected]>.
Report any translation bugs to: <https://translationproject.org/team/>.
GNU coreutils home page: <https://www.gnu.org/software/coreutils/>
General help using GNU software: <https://www.gnu.org/gethelp/>

From coreutils 9.12-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.