summaryrefslogtreecommitdiffstats
path: root/man/ptx.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 16:58:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 16:58:41 +0000
commite1908ae95dd4c9d19ee4dfabfc8bf8a7f85943fe (patch)
treef5cc731bedcac0fb7fe14d952e4581e749f8bb87 /man/ptx.1
parentInitial commit. (diff)
downloadcoreutils-upstream.tar.xz
coreutils-upstream.zip
Adding upstream version 9.4.upstream/9.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man/ptx.1')
-rw-r--r--man/ptx.191
1 files changed, 91 insertions, 0 deletions
diff --git a/man/ptx.1 b/man/ptx.1
new file mode 100644
index 0000000..76c3ac2
--- /dev/null
+++ b/man/ptx.1
@@ -0,0 +1,91 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
+.TH PTX "1" "August 2023" "GNU coreutils 9.4" "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
+\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=\fI\,STRING\/\fR
+use STRING for flagging line truncations.
+The default is '/'
+.TP
+\fB\-M\fR, \fB\-\-macro\-name\fR=\fI\,STRING\/\fR
+macro name to use instead of 'xx'
+.TP
+\fB\-O\fR, \fB\-\-format\fR=\fI\,roff\/\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=\fI\,REGEXP\/\fR
+for end of lines or end of sentences
+.TP
+\fB\-T\fR, \fB\-\-format\fR=\fI\,tex\/\fR
+generate output as TeX directives
+.TP
+\fB\-W\fR, \fB\-\-word\-regexp\fR=\fI\,REGEXP\/\fR
+use REGEXP to match each keyword
+.TP
+\fB\-b\fR, \fB\-\-break\-file\fR=\fI\,FILE\/\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=\fI\,NUMBER\/\fR
+gap size in columns between output fields
+.TP
+\fB\-i\fR, \fB\-\-ignore\-file\fR=\fI\,FILE\/\fR
+read ignore word list from FILE
+.TP
+\fB\-o\fR, \fB\-\-only\-file\fR=\fI\,FILE\/\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=\fI\,NUMBER\/\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
+.SH AUTHOR
+Written by F. Pinard.
+.SH "REPORTING BUGS"
+GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
+.br
+Report any translation bugs to <https://translationproject.org/team/>
+.SH COPYRIGHT
+Copyright \(co 2023 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