original/man1/ptx.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
   2 .TH PTX "1" "January 2016" "GNU coreutils 8.25" "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 \fB\-A\fR, \fB\-\-auto\-reference\fR
  21 output automatically generated references
  22 .TP
  23 \fB\-G\fR, \fB\-\-traditional\fR
  24 behave more like System V 'ptx'
  25 .TP
  26 \fB\-F\fR, \fB\-\-flag\-truncation\fR=\fI\,STRING\/\fR
  27 use STRING for flagging line truncations.
  28 The default is '/'
  29 .TP
  30 \fB\-M\fR, \fB\-\-macro\-name\fR=\fI\,STRING\/\fR
  31 macro name to use instead of 'xx'
  32 .TP
  33 \fB\-O\fR, \fB\-\-format\fR=\fI\,roff\/\fR
  34 generate output as roff directives
  35 .TP
  36 \fB\-R\fR, \fB\-\-right\-side\-refs\fR
  37 put references at right, not counted in \fB\-w\fR
  38 .TP
  39 \fB\-S\fR, \fB\-\-sentence\-regexp\fR=\fI\,REGEXP\/\fR
  40 for end of lines or end of sentences
  41 .TP
  42 \fB\-T\fR, \fB\-\-format\fR=\fI\,tex\/\fR
  43 generate output as TeX directives
  44 .TP
  45 \fB\-W\fR, \fB\-\-word\-regexp\fR=\fI\,REGEXP\/\fR
  46 use REGEXP to match each keyword
  47 .TP
  48 \fB\-b\fR, \fB\-\-break\-file\fR=\fI\,FILE\/\fR
  49 word break characters in this FILE
  50 .TP
  51 \fB\-f\fR, \fB\-\-ignore\-case\fR
  52 fold lower case to upper case for sorting
  53 .TP
  54 \fB\-g\fR, \fB\-\-gap\-size\fR=\fI\,NUMBER\/\fR
  55 gap size in columns between output fields
  56 .TP
  57 \fB\-i\fR, \fB\-\-ignore\-file\fR=\fI\,FILE\/\fR
  58 read ignore word list from FILE
  59 .TP
  60 \fB\-o\fR, \fB\-\-only\-file\fR=\fI\,FILE\/\fR
  61 read only word list from this FILE
  62 .TP
  63 \fB\-r\fR, \fB\-\-references\fR
  64 first field of each line is a reference
  65 .HP
  66 \fB\-t\fR, \fB\-\-typeset\-mode\fR               \- not implemented \-
  67 .TP
  68 \fB\-w\fR, \fB\-\-width\fR=\fI\,NUMBER\/\fR
  69 output width in columns, reference excluded
  70 .TP
  71 \fB\-\-help\fR
  72 display this help and exit
  73 .TP
  74 \fB\-\-version\fR
  75 output version information and exit
  76 .SH AUTHOR
  77 Written by F. Pinard.
  78 .SH "REPORTING BUGS"
  79 GNU coreutils online help: <http://www.gnu.org/software/coreutils/>
  80 .br
  81 Report ptx translation bugs to <http://translationproject.org/team/>
  82 .SH COPYRIGHT
  83 Copyright \(co 2016 Free Software Foundation, Inc.
  84 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
  85 .br
  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 .SH "SEE ALSO"
  89 Full documentation at: <http://www.gnu.org/software/coreutils/ptx>
  90 .br
  91 or available locally via: info \(aq(coreutils) ptx invocation\(aq