1indxbib(1) General Commands Manual indxbib(1)
2
6 indxbib - make inverted index for bibliographic databases
7
9 indxbib [-w] [-c common-words-file] [-d dir] [-f list-file]
10 [-h min-hash-table-size] [-i excluded-fields]
11 [-k max-keys-per-record] [-l min-key-length] [-n threshold]
12 [-o file] [-t max-key-length] [file ...]
13 indxbib --help
15 indxbib -v
17 indxbib --version
18
20 indxbib makes an inverted index for the bibliographic databases in each
21 file for use with refer(1), lookbib(1), and lkbib(1). Each created in‐
22 dex is named file.i; writing is done to a temporary file which is then
23 renamed to this. If no file operands are given on the command line be‐
24 cause the -f option has been used, and no -o option is given, the index
25 will be named Ind.i.
26 Bibliographic databases are divided into records by blank lines.
28 Within a record, each field starts with a % character at the beginning
29 of a line. Fields have a one letter name that follows the % character.
30 The values set by the -c, -l, -n, and -t options are stored in the in‐
32 dex: when the index is searched, keys will be discarded and truncated
33 in a manner appropriate to these options; the original keys will be
34 used for verifying that any record found using the index actually con‐
35 tains the keys. This means that a user of an index need not know
36 whether these options were used in the creation of the index, provided
37 that not all the keys to be searched for would have been discarded dur‐
38 ing indexing and that the user supplies at least the part of each key
39 that would have remained after being truncated during indexing. The
40 value set by the -i option is also stored in the index and will be used
41 in verifying records found using the index.
42
44 --help displays a usage message, while -v and --version show version
45 information; all exit afterward.
46 -c common-words-file
48 Read the list of common words from common-words-file instead of
49 /usr/share/groff/1.23.0/eign.
50 -d dir Use dir as the name of the directory to store in the index, in‐
52 stead of that returned by getcwd(2). Typically, dir will be a
53 symbolic link whose target is the current working directory.
54 -f list-file
56 Read the files to be indexed from list-file. If list-file is -,
57 files will be read from the standard input stream. The -f op‐
58 tion can be given at most once.
59 -h min-hash-table-size
61 Use the first prime number greater than or equal to the argument
62 for the size of the hash table. Larger values will usually make
63 searching faster, but will make the index file larger and cause
64 indxbib to use more memory. The default hash table size is 997.
65 -i excluded-fields
67 Don't index the contents of fields whose names are in excluded-
68 fields. Field names are one character each. If this option is
69 not present, indxbib excludes fields X, Y, and Z.
70 -k max-keys-per-record
72 Use no more keys per input record than specified in the argu‐
73 ment. If this option is not present, the maximum is 100.
74 -l min-key-length
76 Discard any key whose length in characters is shorter than the
77 value of the argument. If this option is not present, the mini‐
78 mum key length is 3.
79 -n threshold
81 Discard the threshold most common words from the common words
82 file. If this option is not present, the 100 most common words
83 are discarded.
84 -o basename
86 Name the index basename.i.
87 -t max-key-length
89 Truncate keys to max-key-length in characters. If this option
90 is not present, keys are truncated to 6 characters.
91 -w Index whole files. Each file is a separate record.
93
95 file.i index for file
96 Ind.i default index name
98 /usr/share/groff/1.23.0/eign
100 contains the list of common words. The traditional name,
101 “eign”, is an abbreviation of “English ignored [word list]”.
102 indxbibXXXXXX
104 temporary file
105
107 “Some Applications of Inverted Indexes on the Unix System”, by M. E.
108 Lesk, 1978, AT&T Bell Laboratories Computing Science Technical Report
109 No. 69.
110 refer(1), lkbib(1), lookbib(1)
112groff 1.23.0 2 November 2023 indxbib(1)