man pages section 1: User Commands

Exit Print View

Updated: July 2014
 
 

ptx (1)

Name

ptx - produce a permuted index of file contents

Synopsis

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

Description




User Commands                                              PTX(1)



NAME
     ptx - produce a permuted index of file contents

SYNOPSIS
     ptx [OPTION]... [INPUT]...   (without -G)
     ptx -G [OPTION]... [INPUT [OUTPUT]]

DESCRIPTION
     Output  a permuted index, including context, of the words in
     the input files.

     Mandatory arguments to long options are mandatory for  short
     options too.

     -A, --auto-reference
          output automatically generated references

     -G, --traditional
          behave more like System V 'ptx'

     -F, --flag-truncation=STRING
          use STRING for flagging line truncations

     -M, --macro-name=STRING
          macro name to use instead of 'xx'

     -O, --format=roff
          generate output as roff directives

     -R, --right-side-refs
          put references at right, not counted in -w

     -S, --sentence-regexp=REGEXP
          for end of lines or end of sentences

     -T, --format=tex
          generate output as TeX directives

     -W, --word-regexp=REGEXP
          use REGEXP to match each keyword

     -b, --break-file=FILE
          word break characters in this FILE

     -f, --ignore-case
          fold lower case to upper case for sorting

     -g, --gap-size=NUMBER
          gap size in columns between output fields

     -i, --ignore-file=FILE
          read ignore word list from FILE



GNU coreutils 8.16   Last change: March 2012                    1






User Commands                                              PTX(1)



     -o, --only-file=FILE
          read only word list from this FILE

     -r, --references
          first field of each line is a reference

     -t, --typeset-mode               - not implemented -

     -w, --width=NUMBER
          output width in columns, reference excluded

     --help
          display this help and exit

     --version
          output version information and exit

     With  no  FILE or if FILE is -, read Standard Input.  '-F /'
     by default.

AUTHOR
     Written by F. Pinard.

REPORTING BUGS
     Report ptx bugs to bug-coreutils@gnu.org
     GNU coreutils home page:  <http://www.gnu.org/software/core-
     utils/>
     General  help  using GNU software: <http://www.gnu.org/geth-
     elp/>
     Report  ptx  translation  bugs  to   <http://translationpro-
     ject.org/team/>

COPYRIGHT
     Copyright  (C)  2012 Free Software Foundation, Inc.  License
     GPLv3+:     GNU     GPL     version     3      or      later
     <http://gnu.org/licenses/gpl.html>.
     This  is  free  software:  you are free to change and redis-
     tribute it.  There is NO WARRANTY, to the  extent  permitted
     by law.


ATTRIBUTES
     See   attributes(5)   for   descriptions  of  the  following
     attributes:

     +---------------+--------------------+
     |ATTRIBUTE TYPE |  ATTRIBUTE VALUE   |
     +---------------+--------------------+
     |Availability   | file/gnu-coreutils |
     +---------------+--------------------+
     |Stability      | Uncommitted        |
     +---------------+--------------------+



GNU coreutils 8.16   Last change: March 2012                    2






User Commands                                              PTX(1)



SEE ALSO
     The full documentation for ptx is maintained  as  a  Texinfo
     manual.  If the info and ptx programs are properly installed
     at your site, the command

          info coreutils 'ptx invocation'

     should give you access to the complete manual.



NOTES
     This  software  was   built   from   source   available   at
     https://java.net/projects/solaris-userland.    The  original
     community       source       was       downloaded       from
     http://ftp.gnu.org/gnu/coreutils/coreutils-8.16.tar.xz

     Further  information about this software can be found on the
     open source community  website  at  http://www.gnu.org/soft-
     ware/coreutils/.



































GNU coreutils 8.16   Last change: March 2012                    3