gindxbib
(1)
Name
gindxbib - make inverted index for bibliographic databases
Synopsis
gindxbib [ -vw ] [ -cfile ] [ -ddir ] [ -ffile ] [ -hn ]
[ -istring ] [ -kn ] [ -ln ] [ -nn ] [ -ofile ]
[ -tn ] [ filename... ]
It is possible to have whitespace between a command line
option and its parameter.
Description
User Commands GINDXBIB(1)
NAME
gindxbib - make inverted index for bibliographic databases
SYNOPSIS
gindxbib [ -vw ] [ -cfile ] [ -ddir ] [ -ffile ] [ -hn ]
[ -istring ] [ -kn ] [ -ln ] [ -nn ] [ -ofile ]
[ -tn ] [ filename... ]
It is possible to have whitespace between a command line
option and its parameter.
DESCRIPTION
gindxbib makes an inverted index for the bibliographic data-
bases in filename... for use with grefer(1), glookbib(1),
and lkbib(1). The index will be named filename.i; 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 -f option has been used, and no -o option is given, the
index will be named Ind.i.
Bibliographic databases are divided into records by blank
lines. Within a record, each fields starts with a % charac-
ter at the beginning of a line. Fields have a one letter
name which follows the % character.
The values set by the -c, -n, -l and -t options are stored
in the index; when the index is searched, keys will be dis-
carded 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, pro-
vided 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 veri-
fying records found using the index.
OPTIONS
-v Print the version number.
-w Index whole files. Each file is a separate record.
-cfile
Read the list of common words from file instead of
/usr/share/groff/1.19.2/eign.
-ddir
Use dir as the pathname of the current working direc-
tory to store in the index, instead of the path printed
by pwd(1). Usually dir will be a symbolic link that
Groff Version 1.19.2Last change: 27 June 2001 1
User Commands GINDXBIB(1)
points to the directory printed by pwd(1).
-ffile
Read the files to be indexed from file. If file is -,
files will be read from the standard input. The -f
option can be given at most once.
-istring
Don't index the contents of fields whose names are in
string. Initially string is XYZ.
-hn Use the first prime greater than or equal to n for the
size of the hash table. Larger values of n will usu-
ally make searching faster, but will make the index
larger and gindxbib use more memory. Initially n is
997.
-kn Use at most n keys per input record. Initially n is
100.
-ln Discard keys that are shorter than n. Initially n is
3.
-nn Discard the n most common words. Initially n is 100.
-obasename
The index should be named basename.i.
-tn Truncate keys to n. Initially n is 6.
FILES
filename.i Index.
Ind.i Default index name.
/usr/share/groff/1.19.2/eign
List of common words.
indxbibXXXXXX Temporary file.
ATTRIBUTES
See attributes(5) for descriptions of the following
attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | text/groff |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
Groff Version 1.19.2Last change: 27 June 2001 2
User Commands GINDXBIB(1)
SEE ALSO
grefer(1), lkbib(1), glookbib(1)
NOTES
This software was built from source available at
https://java.net/projects/solaris-userland. The original
community source was downloaded from
http://ftp.gnu.org/gnu/groff/groff-1.19.2.tar.gz
Further information about this software can be found on the
open source community website at http://www.gnu.org/soft-
ware/groff/.
Groff Version 1.19.2Last change: 27 June 2001 3