Debian Codegraph @

upstream/debian-unstable/man1/ptx.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.50.1.
2 .TH PTX "1" "February 2026" "GNU coreutils 9.10" "User Commands"
3 .SH NAME
4 ptx \- produce a permuted index of file contents
5 .SH SYNOPSIS
6 .B ptx
7 [\fI\,OPTION\/\fR]... [\fI\,INPUT\/\fR]... \fI\,(without -G)\/\fR
8 .br
9 .B ptx
10 \fI\,-G \/\fR[\fI\,OPTION\/\fR]... [\fI\,INPUT \/\fR[\fI\,OUTPUT\/\fR]]
11 .SH DESCRIPTION
12 .\" Add any additional description here
13 .PP
14 Output a permuted index, including context, of the words in the input files.
15 .PP
16 With no FILE, or when FILE is \-, read standard input.
17 .PP
18 Mandatory arguments to long options are mandatory for short options too.
19 .TP
20 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-A'\fB\-A, \-\-auto\-reference\fP\X'tty: link'
21 output automatically generated references
22 .TP
23 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-G'\fB\-G, \-\-traditional\fP\X'tty: link'
24 behave more like System V 'ptx'
25 .TP
26 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-F'\fB\-F, \-\-flag\-truncation=\,STRING\fP\X'tty: link'\/\fR
27 use STRING for flagging line truncations.
28 The default is '/'
29 .TP
30 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-M'\fB\-M, \-\-macro\-name=\,STRING\fP\X'tty: link'\/\fR
31 macro name to use instead of 'xx'
32 .TP
33 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-O'\fB\-O, \-\-format=\,roff\fP\X'tty: link'\/\fR
34 generate output as roff directives
35 .TP
36 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-R'\fB\-R, \-\-right\-side\-refs\fP\X'tty: link'
37 put references at right, not counted in \fB\-w\fR
38 .TP
39 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-S'\fB\-S, \-\-sentence\-regexp=\,REGEXP\fP\X'tty: link'\/\fR
40 for end of lines or end of sentences
41 .TP
42 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-T'\fB\-T, \-\-format=\,tex\fP\X'tty: link'\/\fR
43 generate output as TeX directives
44 .TP
45 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-W'\fB\-W, \-\-word\-regexp=\,REGEXP\fP\X'tty: link'\/\fR
46 use REGEXP to match each keyword
47 .TP
48 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-b'\fB\-b, \-\-break\-file=\,FILE\fP\X'tty: link'\/\fR
49 word break characters in this FILE
50 .TP
51 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-f'\fB\-f, \-\-ignore\-case\fP\X'tty: link'
52 fold lower case to upper case for sorting
53 .TP
54 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-g'\fB\-g, \-\-gap\-size=\,NUMBER\fP\X'tty: link'\/\fR
55 gap size in columns between output fields
56 .TP
57 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-i'\fB\-i, \-\-ignore\-file=\,FILE\fP\X'tty: link'\/\fR
58 read ignore word list from FILE
59 .TP
60 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-o'\fB\-o, \-\-only\-file=\,FILE\fP\X'tty: link'\/\fR
61 read only word list from this FILE
62 .TP
63 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-r'\fB\-r, \-\-references\fP\X'tty: link'
64 first field of each line is a reference
65 .TP
66 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-t'\fB\-t, \-\-typeset\-mode\fP\X'tty: link'
67 change the default width from 72 to 100
68 .TP
69 \X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ptx-w'\fB\-w, \-\-width=\,NUMBER\fP\X'tty: link'\/\fR
70 output width in columns, reference excluded
71 .TP
72 \X'tty: link https://www.gnu.org/software/coreutils/ptx#ptx--help'\fB\-\-help\fP\X'tty: link'
73 display this help and exit
74 .TP
75 \X'tty: link https://www.gnu.org/software/coreutils/ptx#ptx--version'\fB\-\-version\fP\X'tty: link'
76 output version information and exit
77 .SH AUTHOR
78 Written by F. Pinard.
79 .SH "REPORTING BUGS"
80 Report bugs to: bug\[email protected]
81 .br
82 GNU coreutils home page: <https://www.gnu.org/software/coreutils/>
83 .br
84 General help using GNU software: <https://www.gnu.org/gethelp/>
85 .br
86 Report any translation bugs to <https://translationproject.org/team/>
87 .SH "SEE ALSO"
88 Full documentation <https://www.gnu.org/software/coreutils/ptx>
89 .br
90 or available locally via: info \(aq(coreutils) ptx invocation\(aq
91 .PP
92 .br
93 Packaged by Debian (9.10\-1)
94 .br
95 Copyright \(co 2026 Free Software Foundation, Inc.
96 .br
97 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
98 .br
99 This is free software: you are free to change and redistribute it.
100 .br
101 There is NO WARRANTY, to the extent permitted by law.