.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.50.1.
.TH PTX "1" "July 2026" "GNU coreutils 9.11" "User Commands"
.SH NAME
ptx \- produce a permuted index of file contents
.SH SYNOPSIS
.B ptx
[\fI\,OPTION\/\fR]... [\fI\,INPUT\/\fR]...   \fI\,(without -G)\/\fR
.br
.B ptx
\fI\,-G \/\fR[\fI\,OPTION\/\fR]... [\fI\,INPUT \/\fR[\fI\,OUTPUT\/\fR]]
.SH DESCRIPTION
.\" Add any additional description here
.PP
Output a permuted index, including context, of the words in the input files.
.PP
With no FILE, or when FILE is \-, read standard input.
.PP
Mandatory arguments to long options are mandatory for short options too.
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-A'\fB\-A, \-\-auto\-reference\fP\X'tty: link'
output automatically generated references
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-G'\fB\-G, \-\-traditional\fP\X'tty: link'
behave more like System V 'ptx'
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-F'\fB\-F, \-\-flag\-truncation=\,STRING\fP\X'tty: link'\/\fR
use STRING for flagging line truncations.
The default is '/'
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-M'\fB\-M, \-\-macro\-name=\,STRING\fP\X'tty: link'\/\fR
macro name to use instead of 'xx'
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-O'\fB\-O, \-\-format=\,roff\fP\X'tty: link'\/\fR
generate output as roff directives
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-R'\fB\-R, \-\-right\-side\-refs\fP\X'tty: link'
put references at right, not counted in \fB\-w\fR
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-S'\fB\-S, \-\-sentence\-regexp=\,REGEXP\fP\X'tty: link'\/\fR
for end of lines or end of sentences
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-T'\fB\-T, \-\-format=\,tex\fP\X'tty: link'\/\fR
generate output as TeX directives
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-W'\fB\-W, \-\-word\-regexp=\,REGEXP\fP\X'tty: link'\/\fR
use REGEXP to match each keyword
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-b'\fB\-b, \-\-break\-file=\,FILE\fP\X'tty: link'\/\fR
word break characters in this FILE
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-f'\fB\-f, \-\-ignore\-case\fP\X'tty: link'
fold lower case to upper case for sorting
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-g'\fB\-g, \-\-gap\-size=\,NUMBER\fP\X'tty: link'\/\fR
gap size in columns between output fields
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-i'\fB\-i, \-\-ignore\-file=\,FILE\fP\X'tty: link'\/\fR
read ignore word list from FILE
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-o'\fB\-o, \-\-only\-file=\,FILE\fP\X'tty: link'\/\fR
read only word list from this FILE
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-r'\fB\-r, \-\-references\fP\X'tty: link'
first field of each line is a reference
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-t'\fB\-t, \-\-typeset\-mode\fP\X'tty: link'
change the default width from 72 to 100
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-w'\fB\-w, \-\-width=\,NUMBER\fP\X'tty: link'\/\fR
output width in columns, reference excluded
.TP
\X'tty: link https://www.gnu.org/software/coreutils/ptx#ptx--help'\fB\-\-help\fP\X'tty: link'
display this help and exit
.TP
\X'tty: link https://www.gnu.org/software/coreutils/ptx#ptx--version'\fB\-\-version\fP\X'tty: link'
output version information and exit
.SH AUTHOR
Written by F. Pinard.
.SH "REPORTING BUGS"
Report bugs to: bug\-coreutils@gnu.org
.br
GNU coreutils home page: <https://www.gnu.org/software/coreutils/>
.br
General help using GNU software: <https://www.gnu.org/gethelp/>
.br
Report any translation bugs to <https://translationproject.org/team/>
.SH COPYRIGHT
Copyright \(co 2026 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
Full documentation <https://www.gnu.org/software/coreutils/ptx>
.br
or available locally via: info \(aq(coreutils) ptx invocation\(aq