179543Sru.ig 279543SruCopyright (C) 1989-2000, 2001 Free Software Foundation, Inc. 375584Sru 475584SruPermission is granted to make and distribute verbatim copies of 575584Sruthis manual provided the copyright notice and this permission notice 675584Sruare preserved on all copies. 775584Sru 875584SruPermission is granted to copy and distribute modified versions of this 975584Srumanual under the conditions for verbatim copying, provided that the 1075584Sruentire resulting derived work is distributed under the terms of a 1175584Srupermission notice identical to this one. 1275584Sru 1375584SruPermission is granted to copy and distribute translations of this 1475584Srumanual into another language, under the above conditions for modified 1575584Sruversions, except that this permission notice may be included in 1675584Srutranslations approved by the Free Software Foundation instead of in 1775584Sruthe original English. 1875584Sru.. 1975584Sru.TH @G@INDXBIB @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@" 2075584Sru.SH NAME 2175584Sru@g@indxbib \- make inverted index for bibliographic databases 2275584Sru.SH SYNOPSIS 2375584Sru.nr a \n(.j 2475584Sru.ad l 2575584Sru.nr i \n(.i 2675584Sru.in +\w'\fB@g@indxbib 'u 2775584Sru.ti \niu 2875584Sru.B @g@indxbib 2975584Sru.de OP 3075584Sru.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]" 3175584Sru.el .RB "[\ " "\\$1" "\ ]" 3275584Sru.. 3375584Sru.OP \-vw 3475584Sru.OP \-c file 3575584Sru.OP \-d dir 3675584Sru.OP \-f file 3775584Sru.OP \-h n 3875584Sru.OP \-i string 3975584Sru.OP \-k n 4075584Sru.OP \-l n 4175584Sru.OP \-n n 4275584Sru.OP \-o file 4375584Sru.OP \-t n 4475584Sru.RI [\ filename \|.\|.\|.\ ] 4575584Sru.ad \na 4675584Sru.PP 4775584SruIt is possible to have whitespace between a command line option and its 4875584Sruparameter. 4975584Sru.SH DESCRIPTION 5075584Sru.B @g@indxbib 5175584Srumakes an inverted index for the bibliographic databases in 5275584Sru.IR filename \|.\|.\|. 5375584Srufor use with 5475584Sru.BR @g@refer (@MAN1EXT@), 5575584Sru.BR @g@lookbib (@MAN1EXT@), 5675584Sruand 5775584Sru.BR lkbib (@MAN1EXT@). 5875584SruThe index will be named 5975584Sru.IB filename @INDEX_SUFFIX@\fR; 6075584Sruthe index is written to a temporary file which is then renamed to this. 6175584SruIf no filenames are given on the command line because the 6275584Sru.B \-f 6375584Sruoption has been used, and no 6475584Sru.B \-o 6575584Sruoption is given, the index will be named 6675584Sru.BR @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@ . 6775584Sru.LP 6875584SruBibliographic databases are divided into records by blank lines. 6975584SruWithin a record, each fields starts with a 7075584Sru.B % 7175584Srucharacter at the beginning of a line. 7275584SruFields have a one letter name which follows the 7375584Sru.B % 7475584Srucharacter. 7575584Sru.LP 7675584SruThe values set by the 7775584Sru.BR \-c , 7875584Sru.BR \-n , 7975584Sru.BR \-l 8075584Sruand 8175584Sru.B \-t 8275584Sruoptions are stored in the index; 8375584Sruwhen the index is searched, keys will be discarded and truncated in a 8475584Srumanner appropriate to these options; 8575584Sruthe original keys will be used for verifying that any record 8675584Srufound using the index actually contains the keys. 8775584SruThis means that a user of an index need not know whether these 8875584Sruoptions were used in the creation of the index, 8975584Sruprovided that not all the keys to be searched for 9075584Sruwould have been discarded during indexing 9175584Sruand that the user supplies at least the part of each key 9275584Sruthat would have remained after being truncated during indexing. 9375584SruThe value set by the 9475584Sru.B \-i 9575584Sruoption is also stored in the index 9675584Sruand will be used in verifying records found using the index. 9775584Sru.SH OPTIONS 9875584Sru.TP 9975584Sru.B \-v 10075584SruPrint the version number. 10175584Sru.TP 10275584Sru.B \-w 10375584SruIndex whole files. 10475584SruEach file is a separate record. 10575584Sru.TP 10675584Sru.BI \-c file 10775584SruRead the list of common words from 10875584Sru.I file 10975584Sruinstead of 11075584Sru.BR @COMMON_WORDS_FILE@ . 11175584Sru.TP 11275584Sru.BI \-d dir 11375584SruUse 11475584Sru.I dir 11575584Sruas the pathname of the current working directory to store in the index, 11675584Sruinstead of the path printed by 11775584Sru.BR pwd (1). 11875584SruUsually 11975584Sru.I dir 12075584Sruwill be a symbolic link that points to the directory printed by 12175584Sru.BR pwd (1). 12275584Sru.TP 12375584Sru.BI \-f file 12475584SruRead the files to be indexed from 12575584Sru.IR file . 12675584SruIf 12775584Sru.I file 12875584Sruis 12975584Sru.BR \- , 13075584Srufiles will be read from the standard input. 13175584SruThe 13275584Sru.B \-f 13375584Sruoption can be given at most once. 13475584Sru.TP 13575584Sru.BI \-i string 13675584SruDon't index the contents of fields whose names are in 13775584Sru.IR string . 13875584SruInitially 13975584Sru.I string 14075584Sruis 14175584Sru.BR XYZ . 14275584Sru.TP 14375584Sru.BI \-h n 14475584SruUse the first prime greater than or equal to 14575584Sru.I n 14675584Srufor the size of the hash table. 14775584SruLarger values of 14875584Sru.I n 14975584Sruwill usually make searching faster, 15075584Srubut will make the index larger 15175584Sruand 15275584Sru.B @g@indxbib 15375584Sruuse more memory. 15475584SruInitially 15575584Sru.I n 15675584Sruis 997. 15775584Sru.TP 15875584Sru.BI \-k n 15975584SruUse at most 16075584Sru.I n 16175584Srukeys per input record. 16275584SruInitially 16375584Sru.I n 16475584Sruis 100. 16575584Sru.TP 16675584Sru.BI \-l n 16775584SruDiscard keys that are shorter than 16875584Sru.IR n . 16975584SruInitially 17075584Sru.I n 17175584Sruis 3. 17275584Sru.TP 17375584Sru.BI \-n n 17475584SruDiscard the 17575584Sru.I n 17675584Srumost common words. 17775584SruInitially 17875584Sru.I n 17975584Sruis 100. 18075584Sru.TP 18175584Sru.BI \-o basename 18275584SruThe index should be named 18375584Sru.IB basename @INDEX_SUFFIX@\fR. 18475584Sru.TP 18575584Sru.BI \-t n 18675584SruTruncate keys to 18775584Sru.IR n . 18875584SruInitially 18975584Sru.I n 19075584Sruis 6. 19175584Sru.SH FILES 19275584Sru.TP \w'\fBindxbib\fIXXXXXX'u+2n 19375584Sru.IB filename @INDEX_SUFFIX@ 19475584SruIndex. 19575584Sru.TP 19675584Sru.B @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@ 19775584SruDefault index name. 19875584Sru.TP 19975584Sru.B @COMMON_WORDS_FILE@ 20075584SruList of common words. 20175584Sru.TP 20275584Sru.BI indxbib XXXXXX 20375584SruTemporary file. 20475584Sru.SH "SEE ALSO" 20575584Sru.BR @g@refer (@MAN1EXT@), 20675584Sru.BR lkbib (@MAN1EXT@), 20775584Sru.BR @g@lookbib (@MAN1EXT@) 20879543Sru. 20979543Sru.\" Local Variables: 21079543Sru.\" mode: nroff 21179543Sru.\" End: 212