File: collateindex.html

package info (click to toggle)
docbook-dsssl-doc 1.79-7
  • links: PTS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 3,724 kB
  • sloc: makefile: 2
file content (223 lines) | stat: -rw-r--r-- 3,055 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>collateindex.pl</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
></A
>collateindex.pl</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2"
></A
><H2
>Name</H2
>collateindex.pl&nbsp;--&nbsp;Create
a DocBook index from raw index data</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>collateindex.pl</B
>  [-p] [-g] [-s <TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>] [-t <TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>] [-P <TT
CLASS="REPLACEABLE"
><I
>filename</I
></TT
>] [-i <TT
CLASS="REPLACEABLE"
><I
>id</I
></TT
>] [-o <TT
CLASS="REPLACEABLE"
><I
>file</I
></TT
>] [-S <TT
CLASS="REPLACEABLE"
><I
>scope</I
></TT
>] [-I <TT
CLASS="REPLACEABLE"
><I
>scope</I
></TT
>] [-x] [-f]  -N | file </P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><CODE
CLASS="OPTION"
>-p</CODE
></DT
><DD
><P
>Link to points in the document.  The default is to link to the closest
containing section.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-g</CODE
></DT
><DD
><P
>Group terms with IndexDiv based on the first letter of the term (or
its sortas attribute).  (This probably doesn't handle i10n particularly well)</P
></DD
><DT
><CODE
CLASS="OPTION"
>-s name</CODE
></DT
><DD
><P
>Name the IndexDiv that contains symbols.  The default is 'Symbols'.
 Meaningless if -g is not used.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-t name</CODE
></DT
><DD
><P
>Title for the index.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-P file</CODE
></DT
><DD
><P
>Read a preamble from file.  The content of file will be inserted before
the &lt;index&#62; tag.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-i id</CODE
></DT
><DD
><P
>The ID for the &lt;index&#62; tag.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-o file</CODE
></DT
><DD
><P
>Output to file. Defaults to stdout.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-S scope</CODE
></DT
><DD
><P
>Scope of the index, must be 'all', 'local', or 'global'.  If unspecified,
'all' is assumed.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-I scope</CODE
></DT
><DD
><P
>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.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-x</CODE
></DT
><DD
><P
>Make a SetIndex.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-f</CODE
></DT
><DD
><P
>Force the output file to be written, even if it appears to have been
edited by hand.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-N</CODE
></DT
><DD
><P
>New index (generates an empty index file).</P
></DD
><DT
><CODE
CLASS="OPTION"
>file</CODE
></DT
><DD
><P
>The file containing index data generated by Jade with the DocBook HTML
Stylesheet.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="DESC"
></A
><H2
>Description</H2
><P
>Generates an index.</P
></DIV
></BODY
></HTML
>