1PTX(1)                           User Commands                          PTX(1)
2
3
4

NAME

6       ptx - produce a permuted index of file contents
7

SYNOPSIS

9       ptx [OPTION]... [INPUT]...   (without -G)
10       ptx -G [OPTION]... [INPUT [OUTPUT]]
11

DESCRIPTION

13       Output  a  permuted index, including context, of the words in the input
14       files.
15
16       With no FILE, or when FILE is -, read standard input.
17
18       Mandatory arguments to long options are  mandatory  for  short  options
19       too.
20
21       -A, --auto-reference
22              output automatically generated references
23
24       -G, --traditional
25              behave more like System V 'ptx'
26
27       -F, --flag-truncation=STRING
28              use STRING for flagging line truncations.  The default is '/'
29
30       -M, --macro-name=STRING
31              macro name to use instead of 'xx'
32
33       -O, --format=roff
34              generate output as roff directives
35
36       -R, --right-side-refs
37              put references at right, not counted in -w
38
39       -S, --sentence-regexp=REGEXP
40              for end of lines or end of sentences
41
42       -T, --format=tex
43              generate output as TeX directives
44
45       -W, --word-regexp=REGEXP
46              use REGEXP to match each keyword
47
48       -b, --break-file=FILE
49              word break characters in this FILE
50
51       -f, --ignore-case
52              fold lower case to upper case for sorting
53
54       -g, --gap-size=NUMBER
55              gap size in columns between output fields
56
57       -i, --ignore-file=FILE
58              read ignore word list from FILE
59
60       -o, --only-file=FILE
61              read only word list from this FILE
62
63       -r, --references
64              first field of each line is a reference
65
66       -t, --typeset-mode               - not implemented -
67
68       -w, --width=NUMBER
69              output width in columns, reference excluded
70
71       --help display this help and exit
72
73       --version
74              output version information and exit
75

AUTHOR

77       Written by F. Pinard.
78

REPORTING BUGS

80       GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
81       Report any translation bugs to <https://translationproject.org/team/>
82

84       Copyright  ©  2022  Free Software Foundation, Inc.  License GPLv3+: GNU
85       GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
86       This is free software: you are free  to  change  and  redistribute  it.
87       There is NO WARRANTY, to the extent permitted by law.
88

SEE ALSO

90       Full documentation <https://www.gnu.org/software/coreutils/ptx>
91       or available locally via: info '(coreutils) ptx invocation'
92
93
94
95GNU coreutils 9.1                  May 2023                             PTX(1)
Impressum