collateindex.pl - generate DocBook index files

Author

       Norm Walsh <ndw@nwalsh.com>

       Minor updates by Adam Di Carlo <adam@onshore.com> and Peter Eisentraut <peter_e@gmx.net>

docbook-dsssl 1.79                                 2004-11-04                                    COLLATEINDEX(1)

Description

collateindex.pl creates index data for DocBook XML or SGML files.

Example

collateindex.pl-oindex.sgmlHTML.index

Exit Status

0    Success

       1    Failure

Name

       collateindex.pl - generate DocBook index files

Options

-f   Force the output file to be written, even if it appears to have been edited by hand.

       -g   Group  terms  with  IndexDiv based on the first letter of the term (or its SortAs attribute).  (This
            might not handle all language environments.)

       -iid
            The ID to use for the <index> tag.

       -Iscope
            The implied scope, must be "all", "local", or "global".  IndexTerms which do  not  specify  a  scope
            will have the implied scope.  If unspecified, "all" is assumed.

       -N   New index (generates an empty index file).

       -ofile
            Output to file. Defaults to stdout.

       -p   Link to points in the document.  The default is to link to the closest containing section.

       -Pfile
            Read a preamble from file.  The contents of file will be inserted before the <index> tag.

       -q   Run quietly.

       -sname
            Name the IndexDiv that contains symbols.  The default is "Symbols".  Meaningless if -g is not used.

       -Sscope
            Scope of the index, must be "all", "local", or "global".  If unspecified, "all" is assumed.

       -tname
            Title for the index.

       -x   Make a SetIndex.

       -V   Print version number and exit.

       file The  file  containing  index  data  generated with the DocBook DSSSL HTML stylesheet (usually called
            HTML.index).

Synopsis

collateindex.pl [-f] [-g] [-iid] [-Iscope] [-N]
                       [-ofile] [-p] [-Pfile] [-q] [-sname]
                       [-Sscope] [-tname] [-x] file