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

NAME

6       indxbib - make inverted index for bibliographic databases
7

SYNOPSIS

9       indxbib [ -vw ] [ -cfile ] [ -ddir ] [ -ffile ] [ -hn ] [ -istring ]
10               [ -kn ] [ -ln ] [ -nn ] [ -ofile ] [ -tn ] [ filename... ]
11
12       It is possible to have whitespace between a command line option and its
13       parameter.
14

DESCRIPTION

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

OPTIONS

41       -v     Print the version number.
42
43       -w     Index whole files.  Each file is a separate record.
44
45       -cfile Read   the   list   of   common   words  from  file  instead  of
46              /usr/share/groff/1.20.1/eign.
47
48       -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
53       -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
57       -istring
58              Don't  index  the  contents of fields whose names are in string.
59              Initially string is XYZ.
60
61       -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
66       -kn    Use at most n keys per input record.  Initially n is 100.
67
68       -ln    Discard keys that are shorter than n.  Initially n is 3.
69
70       -nn    Discard the n most common words.  Initially n is 100.
71
72       -obasename
73              The index should be named basename.i.
74
75       -tn    Truncate keys to n.  Initially n is 6.
76

FILES

78       filename.i     Index.
79
80       Ind.i          Default index name.
81
82       /usr/share/groff/1.20.1/eign
83                      List of common words.
84
85       indxbibXXXXXX  Temporary file.
86

SEE ALSO

88       refer(1), lkbib(1), lookbib(1)
89
90
91
92Groff Version 1.20.1            9 January 2009                      INDXBIB(1)