1COLLATEINDEX(1) DocBook DSSSL COLLATEINDEX(1)
2
3
4
6 collateindex.pl - generate DocBook index files
7
9 collateindex.pl [-f] [-g] [-i id] [-I scope] [-N]
10 [-o file] [-p] [-P file] [-q] [-s name]
11 [-S scope] [-t name] [-x] file
12
14 collateindex.pl creates index data for DocBook XML or SGML files.
15
17 -f Force the output file to be written, even if it appears to have
18 been edited by hand.
19
20 -g Group terms with IndexDiv based on the first letter of the term
21 (or its SortAs attribute). (This might not handle all language
22 environments.)
23
24 -i id
25 The ID to use for the <index> tag.
26
27 -I scope
28 The implied scope, must be "all", "local", or "global". Index‐
29 Terms which do not specify a scope will have the implied scope.
30 If unspecified, "all" is assumed.
31
32 -N New index (generates an empty index file).
33
34 -o file
35 Output to file. Defaults to stdout.
36
37 -p Link to points in the document. The default is to link to the
38 closest containing section.
39
40 -P file
41 Read a preamble from file. The contents of file will be inserted
42 before the <index> tag.
43
44 -q Run quietly.
45
46 -s name
47 Name the IndexDiv that contains symbols. The default is "Sym‐
48 bols". Meaningless if -g is not used.
49
50 -S scope
51 Scope of the index, must be "all", "local", or "global". If
52 unspecified, "all" is assumed.
53
54 -t name
55 Title for the index.
56
57 -x Make a SetIndex.
58
59 -V Print version number and exit.
60
61 file The file containing index data generated with the DocBook DSSSL
62 HTML stylesheet (usually called HTML.index).
63
65 collateindex.pl -o index.sgml HTML.index
66
68 0 Success
69
70 1 Failure
71
73 Norm Walsh <ndw@nwalsh.com>
74
75 Minor updates by Adam Di Carlo <adam@onshore.com> and Peter Eisentraut
76 <peter_e@gmx.net>
77
78
79
80docbook-dsssl 1.79 2004-11-04 COLLATEINDEX(1)