man/ptx.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.35.
   2 .TH PTX "1" "March 2007" "GNU coreutils 6.9" "User Commands"
   3 .SH NAME
   4 ptx \- produce a permuted index of file contents
   5 .SH SYNOPSIS
   6 .B ptx
   7 [\fIOPTION\fR]... [\fIINPUT\fR]...   \fI(without -G)\fR
   8 .br
   9 .B ptx
  10 \fI-G \fR[\fIOPTION\fR]... [\fIINPUT \fR[\fIOUTPUT\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 Mandatory arguments to long options are mandatory for short options too.
  17 .TP
  18 \fB\-A\fR, \fB\-\-auto\-reference\fR
  19 output automatically generated references
  20 .TP
  21 \fB\-G\fR, \fB\-\-traditional\fR
  22 behave more like System V `ptx'
  23 .TP
  24 \fB\-F\fR, \fB\-\-flag\-truncation\fR=\fISTRING\fR
  25 use STRING for flagging line truncations
  26 .TP
  27 \fB\-M\fR, \fB\-\-macro\-name\fR=\fISTRING\fR
  28 macro name to use instead of `xx'
  29 .TP
  30 \fB\-O\fR, \fB\-\-format\fR=\fIroff\fR
  31 generate output as roff directives
  32 .TP
  33 \fB\-R\fR, \fB\-\-right\-side\-refs\fR
  34 put references at right, not counted in \fB\-w\fR
  35 .TP
  36 \fB\-S\fR, \fB\-\-sentence\-regexp\fR=\fIREGEXP\fR
  37 for end of lines or end of sentences
  38 .TP
  39 \fB\-T\fR, \fB\-\-format\fR=\fItex\fR
  40 generate output as TeX directives
  41 .TP
  42 \fB\-W\fR, \fB\-\-word\-regexp\fR=\fIREGEXP\fR
  43 use REGEXP to match each keyword
  44 .TP
  45 \fB\-b\fR, \fB\-\-break\-file\fR=\fIFILE\fR
  46 word break characters in this FILE
  47 .TP
  48 \fB\-f\fR, \fB\-\-ignore\-case\fR
  49 fold lower case to upper case for sorting
  50 .TP
  51 \fB\-g\fR, \fB\-\-gap\-size\fR=\fINUMBER\fR
  52 gap size in columns between output fields
  53 .TP
  54 \fB\-i\fR, \fB\-\-ignore\-file\fR=\fIFILE\fR
  55 read ignore word list from FILE
  56 .TP
  57 \fB\-o\fR, \fB\-\-only\-file\fR=\fIFILE\fR
  58 read only word list from this FILE
  59 .TP
  60 \fB\-r\fR, \fB\-\-references\fR
  61 first field of each line is a reference
  62 .HP
  63 \fB\-t\fR, \fB\-\-typeset\-mode\fR               \- not implemented \-
  64 .TP
  65 \fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
  66 output width in columns, reference excluded
  67 .TP
  68 \fB\-\-help\fR
  69 display this help and exit
  70 .TP
  71 \fB\-\-version\fR
  72 output version information and exit
  73 .PP
  74 With no FILE or if FILE is \-, read Standard Input.  `\-F /' by default.
  75 .SH AUTHOR
  76 Written by F. Pinard.
  77 .SH "REPORTING BUGS"
  78 Report bugs to <bug\-coreutils@gnu.org>.
  79 .SH COPYRIGHT
  80 Copyright \(co 2007 Free Software Foundation, Inc.
  81 .br
  82 This is free software.  You may redistribute copies of it under the terms of
  83 the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
  84 There is NO WARRANTY, to the extent permitted by law.
  85 .SH "SEE ALSO"
  86 The full documentation for
  87 .B ptx
  88 is maintained as a Texinfo manual.  If the
  89 .B info
  90 and
  91 .B ptx
  92 programs are properly installed at your site, the command
  93 .IP
  94 .B info ptx
  95 .PP
  96 should give you access to the complete manual.