Debian Codegraph @

upstream/debian-unstable/man1/indxbib.1

raw
1 .TH \%indxbib 1 "2026-04-22" "groff 1.24.1"
2 .SH Name
3 \%indxbib \- make inverted index of bibliographic databases
4 .
5 .
6 .\" ====================================================================
7 .\" Legal Terms
8 .\" ====================================================================
9 .\"
10 .\" Copyright (C) 1989-2025 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 .P
79 .SY \%indxbib
80 .B \-\-help
81 .YS
82 .
83 .
84 .P
85 .SY \%indxbib
86 .B \-v
87 .YS
88 .
89 .SY \%indxbib
90 .B \%\-\-version
91 .YS
92 .
93 .
94 .\" ====================================================================
95 .SH Description
96 .\" ====================================================================
97 .
98 .I \%indxbib
99 makes an inverted index of the bibliographic databases in each
100 .I file
101 to speed their access by
102 .MR \%refer 1 ,
103 .MR \%lookbib 1 ,
104 and
105 .MR lkbib 1 .
106 .
107 The program writes to a temporary file
108 that it later renames to
109 .RI file \%.i .
110 .
111 If no
112 .I file
113 operands are present
114 and no
115 .B \-o
116 option is given,
117 .I \%indxbib
118 names the index
119 .IR \%Ind\%.i .
120 .
121 .
122 .PP
123 Bibliographic databases are divided into records by blank lines.
124 .
125 Within a record,
126 each field starts with a
127 .B %
128 character at the beginning of a line.
129 .
130 Fields have a one-letter name that follows the
131 .B %
132 character.
133 .
134 .
135 .PP
136 .I \%indxbib
137 stores the values set by the
138 .BR \-c ,
139 .BR \-l ,
140 .BR \-n ,
141 and
142 .B \-t
143 options in the index:
144 programs that search the index interpret them,
145 discarding and truncating keys appropriately,
146 and using the original keys to verify
147 that any record found using the index actually contains the keys.
148 .
149 This means that a user of an index need not know whether these
150 options were used in the creation of the index,
151 provided that not all the keys to be searched for
152 would have been discarded during indexing
153 and that the user supplies at least the part of each key
154 that would have remained after being truncated during indexing.
155 .
156 .I \%indxbib
157 also stores the value set by the
158 .B \-i
159 option in the index
160 for use in verifying records found using it.
161 .
162 .
163 .\" ====================================================================
164 .SH Options
165 .\" ====================================================================
166 .
167 .B \-\-help
168 displays a usage message,
169 while
170 .B \-v
171 and
172 .B \%\-\-version
173 show version information;
174 all exit afterward.
175 .
176 .
177 .TP 8n \" "-d dir" + 2n
178 .BI \-c\~ common-words-file
179 Read the list of common words from
180 .I common-words-file
181 instead of
182 .IR \%/usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%eign .
183 .
184 .
185 .TP
186 .BI \-d\~ dir
187 Use
188 .I dir
189 as the name of the directory to store in the index,
190 instead of that returned by
191 .MR getcwd 2 .
192 .
193 Typically,
194 .I dir
195 will be a symbolic link whose target is the current working directory.
196 .
197 .
198 .TP
199 .BI \-f\~ list-file
200 Read the files to be indexed from
201 .IR list-file .
202 .
203 If
204 .I list-file
205 is
206 .BR \- ,
207 files will be read from the standard input stream.
208 .
209 The
210 .B \-f
211 option can be given at most once.
212 .
213 .
214 .TP
215 .BI \-h\~ min-hash-table-size
216 Use the first prime number greater than or equal to
217 the argument for the size of the hash table.
218 .
219 Larger values
220 will usually make searching faster,
221 but will make the index file larger
222 and cause
223 .I \%indxbib
224 to use more memory.
225 .
226 The default hash table size is 997.
227 .
228 .
229 .TP
230 .BI \-i\~ excluded-fields
231 Don't index the contents of fields whose names are in
232 .IR excluded-fields .
233 .
234 Field names are one character each.
235 .
236 If this option is not present,
237 .I \%indxbib
238 excludes fields
239 .BR X ,
240 .BR Y ,
241 and
242 .BR Z .
243 .
244 .
245 .TP
246 .BI \-k\~ max-keys-per-record
247 Use no more keys per input record than specified in the argument.
248 .
249 If this option is not present,
250 the maximum is 100.
251 .
252 .
253 .TP
254 .BI \-l\~ min-key-length
255 Discard any key whose length in characters is shorter than the value of
256 the argument.
257 .
258 If this option is not present,
259 the minimum key length
260 is 3.
261 .
262 .
263 .TP
264 .BI \-n\~ threshold
265 Discard the
266 .I threshold
267 most common words from the common words file.
268 .
269 If this option is not present,
270 the 100 most common words are discarded.
271 .
272 .
273 .TP
274 .BI \-o\~ basename
275 Name the index
276 .RI basename \%.i .
277 .
278 .
279 .TP
280 .BI \-t\~ max-key-length
281 Truncate keys to
282 .I max-key-length
283 in characters.
284 .
285 If this option is not present,
286 keys are truncated to 6 characters.
287 .
288 .
289 .TP
290 .B \-w
291 Index whole files.
292 .
293 Each file is a separate record.
294 .
295 .
296 .\" ====================================================================
297 .SH "Exit status"
298 .\" ====================================================================
299 .
300 .I \%indxbib
301 exits with
302 .RB status\~ 0
303 on successful operation,
304 .RB status\~ 2
305 if the program cannot interpret its command-line arguments,
306 and
307 .RB status\~ 1
308 if it encounters an error during operation.
309 .
310 .
311 .\" ====================================================================
312 .SH Files
313 .\" ====================================================================
314 .
315 .TP
316 .RI \%file \%.i
317 index for
318 .I file
319 .
320 .
321 .TP
322 .I \%Ind\%.i
323 default index name
324 .
325 .
326 .TP
327 .I \%/usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%eign
328 contains the list of common words.
329 .
330 The traditional name,
331 .RI \[lq] eign \[rq],
332 is an abbreviation of \[lq]English ignored [word list]\[rq].
333 .
334 .
335 .TP
336 .IR \%indxbib XXXXXX
337 temporary file
338 .
339 .
340 .\" ====================================================================
341 .SH "See also"
342 .\" ====================================================================
343 .
344 \[lq]Some Applications of Inverted Indexes on the Unix System\[rq],
345 by M.\& E.\& Lesk,
346 1978,
347 AT&T Bell Laboratories Computing Science Technical Report No.\& 69.
348 .
349 .
350 .LP
351 .MR \%refer 1 ,
352 .MR lkbib 1 ,
353 .MR \%lookbib 1
354 .
355 .
356 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
357 .cp \n[*groff_indxbib_1_man_C]
358 .do rr *groff_indxbib_1_man_C
359 .
360 .
361 .\" Local Variables:
362 .\" fill-column: 72
363 .\" mode: nroff
364 .\" End:
365 .\" vim: set filetype=groff textwidth=72: