1.ig 2Copyright (C) 1989-2000, 2001 Free Software Foundation, Inc. 3 4Permission is granted to make and distribute verbatim copies of 5this manual provided the copyright notice and this permission notice 6are preserved on all copies. 7 8Permission is granted to copy and distribute modified versions of this 9manual under the conditions for verbatim copying, provided that the 10entire resulting derived work is distributed under the terms of a 11permission notice identical to this one. 12 13Permission is granted to copy and distribute translations of this 14manual into another language, under the above conditions for modified 15versions, except that this permission notice may be included in 16translations approved by the Free Software Foundation instead of in 17the original English. 18.. 19.TH @G@INDXBIB @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@" 20.SH NAME 21@g@indxbib \- make inverted index for bibliographic databases 22.SH SYNOPSIS 23.nr a \n(.j 24.ad l 25.nr i \n(.i 26.in +\w'\fB@g@indxbib 'u 27.ti \niu 28.B @g@indxbib 29.de OP 30.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]" 31.el .RB "[\ " "\\$1" "\ ]" 32.. 33.OP \-vw 34.OP \-c file 35.OP \-d dir 36.OP \-f file 37.OP \-h n 38.OP \-i string 39.OP \-k n 40.OP \-l n 41.OP \-n n 42.OP \-o file 43.OP \-t n 44.RI [\ filename \|.\|.\|.\ ] 45.ad \na 46.PP 47It is possible to have whitespace between a command line option and its 48parameter. 49.SH DESCRIPTION 50.B @g@indxbib 51makes an inverted index for the bibliographic databases in 52.IR filename \|.\|.\|. 53for use with 54.BR @g@refer (@MAN1EXT@), 55.BR @g@lookbib (@MAN1EXT@), 56and 57.BR lkbib (@MAN1EXT@). 58The index will be named 59.IB filename @INDEX_SUFFIX@\fR; 60the index is written to a temporary file which is then renamed to this. 61If no filenames are given on the command line because the 62.B \-f 63option has been used, and no 64.B \-o 65option is given, the index will be named 66.BR @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@ . 67.LP 68Bibliographic databases are divided into records by blank lines. 69Within a record, each fields starts with a 70.B % 71character at the beginning of a line. 72Fields have a one letter name which follows the 73.B % 74character. 75.LP 76The values set by the 77.BR \-c , 78.BR \-n , 79.BR \-l 80and 81.B \-t 82options are stored in the index; 83when the index is searched, keys will be discarded and truncated in a 84manner appropriate to these options; 85the original keys will be used for verifying that any record 86found using the index actually contains the keys. 87This means that a user of an index need not know whether these 88options were used in the creation of the index, 89provided that not all the keys to be searched for 90would have been discarded during indexing 91and that the user supplies at least the part of each key 92that would have remained after being truncated during indexing. 93The value set by the 94.B \-i 95option is also stored in the index 96and will be used in verifying records found using the index. 97.SH OPTIONS 98.TP 99.B \-v 100Print the version number. 101.TP 102.B \-w 103Index whole files. 104Each file is a separate record. 105.TP 106.BI \-c file 107Read the list of common words from 108.I file 109instead of 110.BR @COMMON_WORDS_FILE@ . 111.TP 112.BI \-d dir 113Use 114.I dir 115as the pathname of the current working directory to store in the index, 116instead of the path printed by 117.BR pwd (1). 118Usually 119.I dir 120will be a symbolic link that points to the directory printed by 121.BR pwd (1). 122.TP 123.BI \-f file 124Read the files to be indexed from 125.IR file . 126If 127.I file 128is 129.BR \- , 130files will be read from the standard input. 131The 132.B \-f 133option can be given at most once. 134.TP 135.BI \-i string 136Don't index the contents of fields whose names are in 137.IR string . 138Initially 139.I string 140is 141.BR XYZ . 142.TP 143.BI \-h n 144Use the first prime greater than or equal to 145.I n 146for the size of the hash table. 147Larger values of 148.I n 149will usually make searching faster, 150but will make the index larger 151and 152.B @g@indxbib 153use more memory. 154Initially 155.I n 156is 997. 157.TP 158.BI \-k n 159Use at most 160.I n 161keys per input record. 162Initially 163.I n 164is 100. 165.TP 166.BI \-l n 167Discard keys that are shorter than 168.IR n . 169Initially 170.I n 171is 3. 172.TP 173.BI \-n n 174Discard the 175.I n 176most common words. 177Initially 178.I n 179is 100. 180.TP 181.BI \-o basename 182The index should be named 183.IB basename @INDEX_SUFFIX@\fR. 184.TP 185.BI \-t n 186Truncate keys to 187.IR n . 188Initially 189.I n 190is 6. 191.SH FILES 192.TP \w'\fBindxbib\fIXXXXXX'u+2n 193.IB filename @INDEX_SUFFIX@ 194Index. 195.TP 196.B @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@ 197Default index name. 198.TP 199.B @COMMON_WORDS_FILE@ 200List of common words. 201.TP 202.BI indxbib XXXXXX 203Temporary file. 204.SH "SEE ALSO" 205.BR @g@refer (@MAN1EXT@), 206.BR lkbib (@MAN1EXT@), 207.BR @g@lookbib (@MAN1EXT@) 208. 209.\" Local Variables: 210.\" mode: nroff 211.\" End: 212