1
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35.
2
.TH PTX "1" "October 2012" "GNU coreutils 8.20" "User Commands"
4
ptx \- produce a permuted index of file contents
7
[\fIOPTION\fR]... [\fIINPUT\fR]... \fI(without -G)\fR
10
\fI-G \fR[\fIOPTION\fR]... [\fIINPUT \fR[\fIOUTPUT\fR]]
12
.\" Add any additional description here
14
Output a permuted index, including context, of the words in the input files.
16
Mandatory arguments to long options are mandatory for short options too.
18
\fB\-A\fR, \fB\-\-auto\-reference\fR
19
output automatically generated references
21
\fB\-G\fR, \fB\-\-traditional\fR
22
behave more like System V 'ptx'
24
\fB\-F\fR, \fB\-\-flag\-truncation\fR=\fISTRING\fR
25
use STRING for flagging line truncations
27
\fB\-M\fR, \fB\-\-macro\-name\fR=\fISTRING\fR
28
macro name to use instead of 'xx'
30
\fB\-O\fR, \fB\-\-format\fR=\fIroff\fR
31
generate output as roff directives
33
\fB\-R\fR, \fB\-\-right\-side\-refs\fR
34
put references at right, not counted in \fB\-w\fR
36
\fB\-S\fR, \fB\-\-sentence\-regexp\fR=\fIREGEXP\fR
37
for end of lines or end of sentences
39
\fB\-T\fR, \fB\-\-format\fR=\fItex\fR
40
generate output as TeX directives
42
\fB\-W\fR, \fB\-\-word\-regexp\fR=\fIREGEXP\fR
43
use REGEXP to match each keyword
45
\fB\-b\fR, \fB\-\-break\-file\fR=\fIFILE\fR
46
word break characters in this FILE
48
\fB\-f\fR, \fB\-\-ignore\-case\fR
49
fold lower case to upper case for sorting
51
\fB\-g\fR, \fB\-\-gap\-size\fR=\fINUMBER\fR
52
gap size in columns between output fields
54
\fB\-i\fR, \fB\-\-ignore\-file\fR=\fIFILE\fR
55
read ignore word list from FILE
57
\fB\-o\fR, \fB\-\-only\-file\fR=\fIFILE\fR
58
read only word list from this FILE
60
\fB\-r\fR, \fB\-\-references\fR
61
first field of each line is a reference
63
\fB\-t\fR, \fB\-\-typeset\-mode\fR \- not implemented \-
65
\fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
66
output width in columns, reference excluded
69
display this help and exit
72
output version information and exit
74
With no FILE or if FILE is \-, read Standard Input. '\-F /' by default.
78
Report ptx bugs to bug\-coreutils@gnu.org
80
GNU coreutils home page: <http://www.gnu.org/software/coreutils/>
82
General help using GNU software: <http://www.gnu.org/gethelp/>
84
Report ptx translation bugs to <http://translationproject.org/team/>
86
Copyright \(co 2012 Free Software Foundation, Inc.
87
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
89
This is free software: you are free to change and redistribute it.
90
There is NO WARRANTY, to the extent permitted by law.
92
The full documentation for
94
is maintained as a Texinfo manual. If the
98
programs are properly installed at your site, the command
100
.B info coreutils \(aqptx invocation\(aq
102
should give you access to the complete manual.