summaryrefslogtreecommitdiff
path: root/man/ptx.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/ptx.1')
-rw-r--r--man/ptx.196
1 files changed, 96 insertions, 0 deletions
diff --git a/man/ptx.1 b/man/ptx.1
new file mode 100644
index 0000000..5c623ec
--- /dev/null
+++ b/man/ptx.1
@@ -0,0 +1,96 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35.
+.TH PTX "1" "March 2007" "GNU coreutils 6.9" "User Commands"
+.SH NAME
+ptx \- produce a permuted index of file contents
+.SH SYNOPSIS
+.B ptx
+[\fIOPTION\fR]... [\fIINPUT\fR]... \fI(without -G)\fR
+.br
+.B ptx
+\fI-G \fR[\fIOPTION\fR]... [\fIINPUT \fR[\fIOUTPUT\fR]]
+.SH DESCRIPTION
+.\" Add any additional description here
+.PP
+Output a permuted index, including context, of the words in the input files.
+.PP
+Mandatory arguments to long options are mandatory for short options too.
+.TP
+\fB\-A\fR, \fB\-\-auto\-reference\fR
+output automatically generated references
+.TP
+\fB\-G\fR, \fB\-\-traditional\fR
+behave more like System V `ptx'
+.TP
+\fB\-F\fR, \fB\-\-flag\-truncation\fR=\fISTRING\fR
+use STRING for flagging line truncations
+.TP
+\fB\-M\fR, \fB\-\-macro\-name\fR=\fISTRING\fR
+macro name to use instead of `xx'
+.TP
+\fB\-O\fR, \fB\-\-format\fR=\fIroff\fR
+generate output as roff directives
+.TP
+\fB\-R\fR, \fB\-\-right\-side\-refs\fR
+put references at right, not counted in \fB\-w\fR
+.TP
+\fB\-S\fR, \fB\-\-sentence\-regexp\fR=\fIREGEXP\fR
+for end of lines or end of sentences
+.TP
+\fB\-T\fR, \fB\-\-format\fR=\fItex\fR
+generate output as TeX directives
+.TP
+\fB\-W\fR, \fB\-\-word\-regexp\fR=\fIREGEXP\fR
+use REGEXP to match each keyword
+.TP
+\fB\-b\fR, \fB\-\-break\-file\fR=\fIFILE\fR
+word break characters in this FILE
+.TP
+\fB\-f\fR, \fB\-\-ignore\-case\fR
+fold lower case to upper case for sorting
+.TP
+\fB\-g\fR, \fB\-\-gap\-size\fR=\fINUMBER\fR
+gap size in columns between output fields
+.TP
+\fB\-i\fR, \fB\-\-ignore\-file\fR=\fIFILE\fR
+read ignore word list from FILE
+.TP
+\fB\-o\fR, \fB\-\-only\-file\fR=\fIFILE\fR
+read only word list from this FILE
+.TP
+\fB\-r\fR, \fB\-\-references\fR
+first field of each line is a reference
+.HP
+\fB\-t\fR, \fB\-\-typeset\-mode\fR \- not implemented \-
+.TP
+\fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
+output width in columns, reference excluded
+.TP
+\fB\-\-help\fR
+display this help and exit
+.TP
+\fB\-\-version\fR
+output version information and exit
+.PP
+With no FILE or if FILE is \-, read Standard Input. `\-F /' by default.
+.SH AUTHOR
+Written by F. Pinard.
+.SH "REPORTING BUGS"
+Report bugs to <bug\-coreutils@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2007 Free Software Foundation, Inc.
+.br
+This is free software. You may redistribute copies of it under the terms of
+the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
+There is NO WARRANTY, to the extent permitted by law.
+.SH "SEE ALSO"
+The full documentation for
+.B ptx
+is maintained as a Texinfo manual. If the
+.B info
+and
+.B ptx
+programs are properly installed at your site, the command
+.IP
+.B info ptx
+.PP
+should give you access to the complete manual.