indxbib(1) — Linux manual page

Name | Synopsis | Description | Options | Files | See also | COLOPHON

indxbib(1)               General Commands Manual              indxbib(1)

Name         top

       indxbib - make inverted index for bibliographic databases

Synopsis         top

       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         top

       indxbib makes an inverted index for the bibliographic databases
       in each file for use with refer(1), lookbib(1), and lkbib(1).
       Each created index is named file.i; writing is done to a
       temporary file which is then renamed to this.  If no file
       operands are present and no -o option is given, refer 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.

       The values set by the -c, -l, -n, and -t options are stored in
       the index: when the index is searched, keys will be discarded and
       truncated in a manner appropriate to these options; the original
       keys will be used for verifying 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.  The value set by
       the -i option is also stored in the index and will be used in
       verifying records found using the index.

Options         top

       --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.

Files         top

       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]”.

       indxbibXXXXXX
              temporary file

See also         top

       “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)

COLOPHON         top

       This page is part of the groff (GNU troff) project.  Information
       about the project can be found at 
       ⟨http://www.gnu.org/software/groff/⟩.  If you have a bug report
       for this manual page, see ⟨http://www.gnu.org/software/groff/⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://git.savannah.gnu.org/git/groff.git⟩ on 2024-06-14.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2024-06-10.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

groff 1.23.0.1273-9d53-dirty   6 June 2024                    indxbib(1)