Hlavní navigace

collateindex.pl

NAME

collateindex.pl - generate DocBook index files

SYNOPSIS

collateindex.pl [-f] [-g] [-i id] [-I scope] [-N] [-o file] [-p] [-P file] [-q] [-s name] [-S scope] [-t name] [-x] file

DESCRIPTION

collateindex.pl creates index data for DocBook \s-1XML\s0 or \s-1SGML\s0 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.)
"-i The \s-1ID\s0 to use for the <index> tag.
"-I The implied scope, must be CWall, CWlocal, or CWglobal. IndexTerms which do not specify a scope will have the implied scope. If unspecified, CWall is assumed.
"-N" New index (generates an empty index file).
"-o Output to file. Defaults to stdout.
"-p" Link to points in the document. The default is to link to the closest containing section.
"-P Read a preamble from file. The contents of file will be inserted before the <index> tag.
"-q" Run quietly.
"-s Name the IndexDiv that contains symbols. The default is CWSymbols. Meaningless if -g is not used.
"-S Scope of the index, must be CWall, CWlocal, or CWglobal. If unspecified, CWall is assumed.
"-t 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).

EXAMPLE

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

EXIT STATUS

"0" Success
"1" Failure

AUTHOR

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