1INDXBIB(1) General Commands Manual INDXBIB(1)
2
6 indxbib - make inverted index for bibliographic databases
7
9 indxbib [ -vw ] [ -cfile ] [ -ddir ] [ -ffile ] [ -hn ] [ -istring ]
10 [ -kn ] [ -ln ] [ -nn ] [ -ofile ] [ -tn ] [ filename... ]
11
13 indxbib makes an inverted index for the bibliographic databases in
14 filename... for use with refer(1), lookbib(1), and lkbib(1). The
15 index will be named filename.i; the index is written to a temporary
16 file which is then renamed to this. If no filenames are given on the
17 command line because the -f option has been used, and no -o option is
18 given, the index will be named Ind.i.
19 Bibliographic databases are divided into records by blank lines.
21 Within a record, each fields starts with a % character at the beginning
22 of a line. Fields have a one letter name which follows the % charac‐
23 ter.
24 The values set by the -c, -n, -l and -t options are stored in the
26 index; when the index is searched, keys will be discarded and truncated
27 in a manner appropriate to these options; the original keys will be
28 used for verifying that any record found using the index actually con‐
29 tains the keys. This means that a user of an index need not know
30 whether these options were used in the creation of the index, provided
31 that not all the keys to be searched for would have been discarded dur‐
32 ing indexing and that the user supplies at least the part of each key
33 that would have remained after being truncated during indexing. The
34 value set by the -i option is also stored in the index and will be used
35 in verifying records found using the index.
36
38 It is possible to have whitespace between a command line option and its
39 parameter.
40 -v Print the version number.
42 -w Index whole files. Each file is a separate record.
44 -cfile Read the list of common words from file instead of
46 /usr/share/groff/1.22.3/eign.
47 -ddir Use dir as the pathname of the current working directory to
49 store in the index, instead of the path printed by pwd(1). Usu‐
50 ally dir will be a symbolic link that points to the directory
51 printed by pwd(1).
52 -ffile Read the files to be indexed from file. If file is -, files
54 will be read from the standard input. The -f option can be
55 given at most once.
56 -istring
58 Don't index the contents of fields whose names are in string.
59 Initially string is XYZ.
60 -hn Use the first prime greater than or equal to n for the size of
62 the hash table. Larger values of n will usually make searching
63 faster, but will make the index larger and indxbib use more mem‐
64 ory. Initially n is 997.
65 -kn Use at most n keys per input record. Initially n is 100.
67 -ln Discard keys that are shorter than n. Initially n is 3.
69 -nn Discard the n most common words. Initially n is 100.
71 -obasename
73 The index should be named basename.i.
74 -tn Truncate keys to n. Initially n is 6.
76
78 filename.i Index.
79 Ind.i Default index name.
81 /usr/share/groff/1.22.3/eign
83 List of common words.
84 indxbibXXXXXX Temporary file.
86
88 refer(1), lkbib(1), lookbib(1)
89
91 Copyright © 1989-2014 Free Software Foundation, Inc.
92 Permission is granted to make and distribute verbatim copies of this
94 manual provided the copyright notice and this permission notice are
95 preserved on all copies.
96 Permission is granted to copy and distribute modified versions of this
98 manual under the conditions for verbatim copying, provided that the
99 entire resulting derived work is distributed under the terms of a per‐
100 mission notice identical to this one.
101 Permission is granted to copy and distribute translations of this man‐
103 ual into another language, under the above conditions for modified ver‐
104 sions, except that this permission notice may be included in transla‐
105 tions approved by the Free Software Foundation instead of in the origi‐
106 nal English.
107Groff Version 1.22.3 4 November 2014 INDXBIB(1)