1INDXBIB(1)                  General Commands Manual                 INDXBIB(1)
2
3
4

NAME

6       indxbib - make inverted index for bibliographic databases
7

SYNOPSIS

9       indxbib [-w] [-c file] [-d dir] [-f file] [-h n] [-i string] [-k n]
10               [-l n] [-n n] [-o file] [-t n] [filename ...]
11
12       indxbib --help
13
14       indxbib -v
15       indxbib --version
16

DESCRIPTION

18       indxbib makes an inverted index  for  the  bibliographic  databases  in
19       filename...   for use with refer(1), lookbib(1), and lkbib(1).  The in‐
20       dex will be named filename.i; the index is written to a temporary  file
21       which  is  then renamed to this.  If no filenames are given on the com‐
22       mand line because the -f option has been used,  and  no  -o  option  is
23       given, the index will be named Ind.i.
24
25       Bibliographic  databases  are  divided  into  records  by  blank lines.
26       Within a record, each fields starts with a % character at the beginning
27       of  a  line.  Fields have a one letter name which follows the % charac‐
28       ter.
29
30       The values set by the -c, -n, -l, and -t options are stored in the  in‐
31       dex;  when  the index is searched, keys will be discarded and truncated
32       in a manner appropriate to these options; the  original  keys  will  be
33       used  for verifying that any record found using the index actually con‐
34       tains the keys.  This means that a user  of  an  index  need  not  know
35       whether  these options were used in the creation of the index, provided
36       that not all the keys to be searched for would have been discarded dur‐
37       ing  indexing  and that the user supplies at least the part of each key
38       that would have remained after being truncated  during  indexing.   The
39       value set by the -i option is also stored in the index and will be used
40       in verifying records found using the index.
41

OPTIONS

43       Whitespace is permitted between a command-line option and its argument.
44
45       -v     Print the version number.
46
47       -w     Index whole files.  Each file is a separate record.
48
49       -cfile Read the list of common words from file instead  of  /usr/share/
50              groff/1.22.4/eign.
51
52       -ddir  Use  dir  as  the  pathname  of the current working directory to
53              store in the index, instead of the path printed by pwd(1).  Usu‐
54              ally  dir  will  be a symbolic link that points to the directory
55              printed by pwd(1).
56
57       -ffile Read the files to be indexed from file.  If  file  is  -,  files
58              will  be  read  from  the  standard input.  The -f option can be
59              given at most once.
60
61       -istring
62              Don't index the contents of fields whose names  are  in  string.
63              Initially string is XYZ.
64
65       -hn    Use  the  first prime greater than or equal to n for the size of
66              the hash table.  Larger values of n will usually make  searching
67              faster, but will make the index larger and indxbib use more mem‐
68              ory.  Initially n is 997.
69
70       -kn    Use at most n keys per input record.  Initially n is 100.
71
72       -ln    Discard keys that are shorter than n.  Initially n is 3.
73
74       -nn    Discard the n most common words.  Initially n is 100.
75
76       -obasename
77              The index should be named basename.i.
78
79       -tn    Truncate keys to n.  Initially n is 6.
80

FILES

82       filename.i
83              Index.
84
85       Ind.i  Default index name.
86
87       /usr/share/groff/1.22.4/eign
88              List of common words.
89
90       indxbibXXXXXX
91              Temporary file.
92

SEE ALSO

94       refer(1), lkbib(1), lookbib(1)
95
96
97
98groff 1.22.4                     17 March 2021                      INDXBIB(1)