# indxbib

## Name



           indxbib - make inverted index of bibliographic databases
    


## Synopsis



           **indxbib**[**-w**] [**-c** _common-words-file_] [**-d** _dir_] [**-f** _list-file_]
                   [**-h** _min-hash-table-size_] [**-i** _excluded-fields_]
                   [**-k** _max-keys-per-record_] [**-l** _min-key-length_]
                   [**-n** _threshold_] [**-o** _file_] [**-t** _max-key-length_] [_file_ ...]
    
           **indxbib --help**
    
           **indxbib -v**
    
           **indxbib --version**
    


## Description



           _indxbib_ makes an inverted index of the bibliographic databases in
           each _file_ to speed their access by _refer_(1), _lookbib_(1), and
           _lkbib_(1).  The program writes to a temporary file that it later
           renames to file _.i_.  If no _file_ operands are present and no **-o**
           option is given, _indxbib_ names the index _Ind.i_.
    
           Bibliographic databases are divided into records by blank lines.
           Within a record, each field starts with a **%** character at the
           beginning of a line.  Fields have a one-letter name that follows
           the **%** character.
    
           _indxbib_ stores the values set by the **-c** , **-l** , **-n** , and **-t** options in
           the index: programs that search the index interpret them,
           discarding and truncating keys appropriately, and using the
           original keys to verify that any record found using the index
           actually contains the keys.  This means that a user of an index
           need not know whether these options were used in the creation of
           the index, provided that not all the keys to be searched for would
           have been discarded during indexing and that the user supplies at
           least the part of each key that would have remained after being
           truncated during indexing.  _indxbib_ also stores the value set by
           the **-i** option in the index for use in verifying records found
           using it.
    


## Options



           **--help** displays a usage message, while **-v** and **--version** show
           version information; all exit afterward.
    
           **-c** _common-words-file_
                  Read the list of common words from _common-words-file_
                  instead of _/usr/local/share/groff/1.23.0/eign_.
    
           **-d** _dir_ Use _dir_ as the name of the directory to store in the index,
                  instead of that returned by _getcwd_(2).  Typically, _dir_ will
                  be a symbolic link whose target is the current working
                  directory.
    
           **-f** _list-file_
                  Read the files to be indexed from _list-file_.  If _list-file_
                  is **-** , files will be read from the standard input stream.
                  The **-f** option can be given at most once.
    
           **-h** _min-hash-table-size_
                  Use the first prime number greater than or equal to the
                  argument for the size of the hash table.  Larger values
                  will usually make searching faster, but will make the index
                  file larger and cause _indxbib_ to use more memory.  The
                  default hash table size is 997.
    
           **-i** _excluded-fields_
                  Don't index the contents of fields whose names are in
                  _excluded-fields_.  Field names are one character each.  If
                  this option is not present, _indxbib_ excludes fields **X** , **Y** ,
                  and **Z**.
    
           **-k** _max-keys-per-record_
                  Use no more keys per input record than specified in the
                  argument.  If this option is not present, the maximum is
                  100.
    
           **-l** _min-key-length_
                  Discard any key whose length in characters is shorter than
                  the value of the argument.  If this option is not present,
                  the minimum key length is 3.
    
           **-n** _threshold_
                  Discard the _threshold_ most common words from the common
                  words file.  If this option is not present, the 100 most
                  common words are discarded.
    
           **-o** _basename_
                  Name the index basename _.i_.
    
           **-t** _max-key-length_
                  Truncate keys to _max-key-length_ in characters.  If this
                  option is not present, keys are truncated to 6 characters.
    
           **-w** Index whole files.  Each file is a separate record.
    


## Exit status



           _indxbib_ exits with status **0** on successful operation, status **2** if
           the program cannot interpret its command-line arguments, and
           status **1** if it encounters an error during operation.
    


## Files



           file _.i_ index for _file_
    
           _Ind.i_  default index name
    
           _/usr/local/share/groff/1.23.0/eign_
                  contains the list of common words.  The traditional name,
                  “ _eign_ ”, is an abbreviation of “English ignored [word
                  list]”.
    
           _indxbib_ XXXXXX
                  temporary file
    


## See also



           “Some Applications of Inverted Indexes on the Unix System”, by M.
           E. Lesk, 1978, AT&T Bell Laboratories Computing Science Technical
           Report No. 69.
    
           _refer_(1), _lkbib_(1), _lookbib_(1)
    


* * *