4.4BSD/usr/share/man/cat1/indxbib.0

INDXBIB(1)             BSD Reference Manual            INDXBIB(1)


NNAAMMEE
       indxbib - make inverted index for bibliographic databases

SSYYNNOOPPSSIISS
       iinnddxxbbiibb [ --vvww ] [ --cc_f_i_l_e ] [ --dd_d_i_r ] [ --ff_f_i_l_e ] [ --hh_n ]
               [ --ii_s_t_r_i_n_g ] [ --kk_n ] [ --ll_n ] [ --nn_n ] [ --oo_f_i_l_e ]
               [ --tt_n ] [ _f_i_l_e_n_a_m_e... ]

DDEESSCCRRIIPPTTIIOONN
       iinnddxxbbiibb  makes  an  inverted  index  for the bibliographic
       databases in _f_i_l_e_n_a_m_e...  for  use  with  rreeffeerr(1),  llooookk--
       bbiibb(1), and llkkbbiibb(1).  The index will be named _f_i_l_e_n_a_m_e..ii;
       the index is written to a temporary  file  which  is  then
       renamed to this.  If no filenames are given on the command
       line because the --ff option has been used, and no --oo option
       is given, the index will be named IInndd..ii.

       Bibliographic  databases are divided into records by blank
       lines.  Within a record, each fields starts with a %% char-
       acter  at the beginning of a line.  Fields have a one let-
       ter name which follows the %% character.

       The values set by the --cc, --nn, --ll and --tt 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 --ii option is also stored in the index and
       will be used in verifying records found using the index.

OOPPTTIIOONNSS
       --vv     Print the version number.

       --ww     Index whole files.  Each file is a separate record.

       --cc_f_i_l_e Read  the list of common words from _f_i_l_e instead of
              //uussrr//sshhaarree//mmiisscc//eeiiggnn.

       --dd_d_i_r  Use _d_i_r as the  pathname  of  the  current  working
              directory  to  store  in  the index, instead of the
              path printed by ppwwdd(1).  Usually _d_i_r will be a sym-
              bolic  link that points to the directory printed by
              ppwwdd(1).

       --ff_f_i_l_e Read the files to be indexed from _f_i_l_e.  If _f_i_l_e is



Groff Version 1.08        16 April 1993                         1








INDXBIB(1)             BSD Reference Manual            INDXBIB(1)


              --, files will be read from the standard input.  The
              --ff option can be given at most once.

       --ii_s_t_r_i_n_g
              Don't index the contents of fields whose names  are
              in _s_t_r_i_n_g.  Initially _s_t_r_i_n_g is XXYYZZ.

       --hh_n    Use  the first prime greater than or equal to _n for
              the size of the hash table.   Larger  values  of  _n
              will  usually  make searching faster, but will make
              the index larger and iinnddxxbbiibb use more memory.  Ini-
              tially _n is 997.

       --kk_n    Use  at  most _n keys per input record.  Initially _n
              is 100.

       --ll_n    Discard keys that are shorter than _n.  Initially  _n
              is 3.

       --nn_n    Discard  the  _n  most common words.  Initially _n is
              100.

       --oo_b_a_s_e_n_a_m_e
              The index should be named _b_a_s_e_n_a_m_e..ii.

       --tt_n    Truncate keys to _n.  Initially _n is 6.

FFIILLEESS
       _f_i_l_e_n_a_m_e..ii     Index.

       IInndd..ii          Default index name.

       //uussrr//sshhaarree//mmiisscc//eeiiggnn
                      List of common words.

       iinnddxxbbiibb_X_X_X_X_X_X  Temporary file.

SSEEEE AALLSSOO
       rreeffeerr(1), llkkbbiibb(1), llooookkbbiibb(1)















Groff Version 1.08        16 April 1993                         2