collateindex.pl (1)

collateindex.pl [-f] [-g] [-i id] [-I scope] [-N]

                [-o file] [-p] [-P file] [-q] [-s name]
                [-S scope] [-t name] [-x] file

collateindex.pl creates index data for DocBook \s-1XML\s0 or \s-1SGML\s0 files.

-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.)

-i id

The \s-1ID\s0 to use for the <index> tag.

-I scope

The implied scope, must be \*(C`all\*(C', \*(C`local\*(C', or \*(C`global\*(C'. IndexTerms which do not specify a scope will have the implied scope. If unspecified, \*(C`all\*(C' is assumed.

-N

New index (generates an empty index file).

-o file

Output to file. Defaults to stdout.

-p

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

-P file

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

-q

Run quietly.

-s name

Name the IndexDiv that contains symbols. The default is \*(C`Symbols\*(C'. Meaningless if -g is not used.

-S scope

Scope of the index, must be \*(C`all\*(C', \*(C`local\*(C', or \*(C`global\*(C'. If unspecified, \*(C`all\*(C' is assumed.

-t name

Title for the index.

-x

Make a SetIndex.

-V

Print version number and exit.

file

The file containing index data generated with the DocBook \s-1DSSSL\s0 \s-1HTML\s0 stylesheet (usually called \s-1HTML\s0.index).

collateindex.pl -o index.sgml \s-1HTML\s0.index

0

Success

1

Failure

Norm Walsh <[email protected]>

Minor updates by Adam Di Carlo <[email protected]> and Peter Eisentraut <[email protected]>