Debian Codegraph @

upstream/debian-trixie/man1/indxbib.1

raw
1 .TH \%indxbib 1 "3 June 2025" "groff 1.23.0"
2 .SH Name
3 \%indxbib \- make inverted index for bibliographic databases
4 .
5 .
6 .\" ====================================================================
7 .\" Legal Terms
8 .\" ====================================================================
9 .\"
10 .\" Copyright (C) 1989-2020 Free Software Foundation, Inc.
11 .\"
12 .\" Permission is granted to make and distribute verbatim copies of this
13 .\" manual provided the copyright notice and this permission notice are
14 .\" preserved on all copies.
15 .\"
16 .\" Permission is granted to copy and distribute modified versions of
17 .\" this manual under the conditions for verbatim copying, provided that
18 .\" the entire resulting derived work is distributed under the terms of
19 .\" a permission notice identical to this one.
20 .\"
21 .\" Permission is granted to copy and distribute translations of this
22 .\" manual into another language, under the above conditions for
23 .\" modified versions, except that this permission notice may be
24 .\" included in translations approved by the Free Software Foundation
25 .\" instead of in the original English.
26 .
27 .
28 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
29 .do nr *groff_indxbib_1_man_C \n[.cp]
30 .cp 0
31 .
32 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
33 .nr do-fallback 0
34 .if !\n(.f .nr do-fallback 1 \" mandoc
35 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
36 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
37 .if \n[do-fallback] \{\
38 . de MR
39 . ie \\n(.$=1 \
40 . I \%\\$1
41 . el \
42 . IR \%\\$1 (\\$2)\\$3
43 . .
44 .\}
45 .rr do-fallback
46 .
47 .
48 .\" ====================================================================
49 .SH Synopsis
50 .\" ====================================================================
51 .
52 .SY \%indxbib
53 .RB [ \-w ]
54 .RB [ \-c\~\c
55 .IR \%common-words-file ]
56 .RB [ \-d\~\c
57 .IR dir ]
58 .RB [ \-f\~\c
59 .IR \%list-file ]
60 .RB [ \-h\~\c
61 .IR \%min-hash-table-size ]
62 .RB [ \-i\~\c
63 .IR \%excluded-fields ]
64 .RB [ \-k\~\c
65 .IR \%max-keys-per-record ]
66 .RB [ \-l\~\c
67 .IR \%min-key-length ]
68 .RB [ \-n\~\c
69 .IR \%threshold ]
70 .RB [ \-o\~\c
71 .IR file ]
72 .RB [ \-t\~\c
73 .IR \%max-key-length ]
74 .RI [ file\~ .\|.\|.]
75 .YS
76 .
77 .
78 .SY \%indxbib
79 .B \-\-help
80 .YS
81 .
82 .
83 .SY \%indxbib
84 .B \-v
85 .
86 .SY \%indxbib
87 .B \-\-version
88 .YS
89 .
90 .
91 .\" ====================================================================
92 .SH Description
93 .\" ====================================================================
94 .
95 .I \%indxbib
96 makes an inverted index for the bibliographic databases in each
97 .I file
98 for use with
99 .MR \%refer 1 ,
100 .MR \%lookbib 1 ,
101 and
102 .MR lkbib 1 .
103 .
104 Each created index is named
105 .RI file \%.i ;
106 writing is done to a temporary file which is then renamed to this.
107 .
108 If no
109 .I file
110 operands are given on the command line because the
111 .B \-f
112 option has been used,
113 and no
114 .B \-o
115 option is given,
116 the index will be named
117 .IR \%Ind\%.i .
118 .
119 .
120 .LP
121 Bibliographic databases are divided into records by blank lines.
122 .
123 Within a record,
124 each field starts with a
125 .B %
126 character at the beginning of a line.
127 .
128 Fields have a one letter name that follows the
129 .B %
130 character.
131 .
132 .
133 .LP
134 The values set by the
135 .BR \-c ,
136 .BR \-l ,
137 .BR \-n ,
138 and
139 .B \-t
140 options are stored in the index:
141 when the index is searched,
142 keys will be discarded and truncated in a
143 manner appropriate to these options;
144 the original keys will be used for verifying that any record
145 found using the index actually contains the keys.
146 .
147 This means that a user of an index need not know whether these
148 options were used in the creation of the index,
149 provided that not all the keys to be searched for
150 would have been discarded during indexing
151 and that the user supplies at least the part of each key
152 that would have remained after being truncated during indexing.
153 .
154 The value set by the
155 .B \-i
156 option is also stored in the index
157 and will be used in verifying records found using the index.
158 .
159 .
160 .\" ====================================================================
161 .SH Options
162 .\" ====================================================================
163 .
164 .B \-\-help
165 displays a usage message,
166 while
167 .B \-v
168 and
169 .B \-\-version
170 show version information;
171 all exit afterward.
172 .
173 .
174 .TP
175 .BI \-c\~ common-words-file
176 Read the list of common words from
177 .I common-words-file
178 instead of
179 .IR \%/usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%eign .
180 .
181 .
182 .TP
183 .BI \-d\~ dir
184 Use
185 .I dir
186 as the name of the directory to store in the index,
187 instead of that returned by
188 .MR getcwd 2 .
189 .
190 Typically,
191 .I dir
192 will be a symbolic link whose target is the current working directory.
193 .
194 .
195 .TP
196 .BI \-f\~ list-file
197 Read the files to be indexed from
198 .IR list-file .
199 .
200 If
201 .I list-file
202 is
203 .BR \- ,
204 files will be read from the standard input stream.
205 .
206 The
207 .B \-f
208 option can be given at most once.
209 .
210 .
211 .TP
212 .BI \-h\~ min-hash-table-size
213 Use the first prime number greater than or equal to
214 the argument for the size of the hash table.
215 .
216 Larger values
217 will usually make searching faster,
218 but will make the index file larger
219 and cause
220 .I \%indxbib
221 to use more memory.
222 .
223 The default hash table size is 997.
224 .
225 .
226 .TP
227 .BI \-i\~ excluded-fields
228 Don't index the contents of fields whose names are in
229 .IR excluded-fields .
230 .
231 Field names are one character each.
232 .
233 If this option is not present,
234 .I \%indxbib
235 excludes fields
236 .BR X ,
237 .BR Y ,
238 and
239 .BR Z .
240 .
241 .
242 .TP
243 .BI \-k\~ max-keys-per-record
244 Use no more keys per input record than specified in the argument.
245 .
246 If this option is not present,
247 the maximum is 100.
248 .
249 .
250 .TP
251 .BI \-l\~ min-key-length
252 Discard any key whose length in characters is shorter than the value of
253 the argument.
254 .
255 If this option is not present,
256 the minimum key length
257 is 3.
258 .
259 .
260 .TP
261 .BI \-n\~ threshold
262 Discard the
263 .I threshold
264 most common words from the common words file.
265 .
266 If this option is not present,
267 the 100 most common words are discarded.
268 .
269 .
270 .TP
271 .BI \-o\~ basename
272 Name the index
273 .RI basename \%.i .
274 .
275 .
276 .TP
277 .BI \-t\~ max-key-length
278 Truncate keys to
279 .I max-key-length
280 in characters.
281 .
282 If this option is not present,
283 keys are truncated to 6 characters.
284 .
285 .
286 .TP
287 .B \-w
288 Index whole files.
289 .
290 Each file is a separate record.
291 .
292 .
293 .\" ====================================================================
294 .SH Files
295 .\" ====================================================================
296 .
297 .TP
298 .RI \%file \%.i
299 index for
300 .I file
301 .
302 .
303 .TP
304 .I \%Ind\%.i
305 default index name
306 .
307 .
308 .TP
309 .I \%/usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%eign
310 contains the list of common words.
311 .
312 The traditional name,
313 .RI \[lq] eign \[rq],
314 is an abbreviation of \[lq]English ignored [word list]\[rq].
315 .
316 .
317 .TP
318 .IR \%indxbib XXXXXX
319 temporary file
320 .
321 .
322 .\" ====================================================================
323 .SH "See also"
324 .\" ====================================================================
325 .
326 \[lq]Some Applications of Inverted Indexes on the Unix System\[rq],
327 by M.\& E.\& Lesk,
328 1978,
329 AT&T Bell Laboratories Computing Science Technical Report No.\& 69.
330 .
331 .
332 .LP
333 .MR \%refer 1 ,
334 .MR lkbib 1 ,
335 .MR \%lookbib 1
336 .
337 .
338 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
339 .cp \n[*groff_indxbib_1_man_C]
340 .do rr *groff_indxbib_1_man_C
341 .
342 .
343 .\" Local Variables:
344 .\" fill-column: 72
345 .\" mode: nroff
346 .\" End:
347 .\" vim: set filetype=groff textwidth=72: