4 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
6 Copyright (C) 1989 - 2001 Free Software Foundation, Inc.
8 Permission is granted to make and distribute verbatim copies of
9 this manual provided the copyright notice and this permission notice
10 are preserved on all copies.
12 Permission is granted to copy and distribute modified versions of this
13 manual under the conditions for verbatim copying, provided that the
14 entire resulting derived work is distributed under the terms of a
15 permission notice identical to this one.
17 Permission is granted to copy and distribute translations of this
18 manual into another language, under the above conditions for modified
19 versions, except that this permission notice may be included in
20 translations approved by the Free Software Foundation instead of in
23 .TH @U_INDXBIB@ @MAN1EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
25 @L_INDXBIB@ \- make inverted index for bibliographic databases
30 .in +\w'\fB@L_INDXBIB@ 'u
34 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
35 .el .RB "[\ " "\\$1" "\ ]"
48 .RI [\ filename \|.\|.\|.\ ]
51 It is possible to have whitespace between a command line option and its
55 makes an inverted index for the bibliographic databases in
56 .IR filename \|.\|.\|.
58 .BR @L_P_REFER@ (@MAN1EXT@),
59 .BR @L_LOOKBIB@ (@MAN1EXT@),
61 .BR @L_LKBIB@ (@MAN1EXT@).
62 The index will be named
63 .IB filename @INDEX_SUFFIX@\fR;
64 the index is written to a temporary file which is then renamed to this.
65 If no filenames are given on the command line because the
67 option has been used, and no
69 option is given, the index will be named
70 .BR @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@ .
72 Bibliographic databases are divided into records by blank lines.
73 Within a record, each fields starts with a
75 character at the beginning of a line.
76 Fields have a one letter name which follows the
86 options are stored in the index;
87 when the index is searched, keys will be discarded and truncated in a
88 manner appropriate to these options;
89 the original keys will be used for verifying that any record
90 found using the index actually contains the keys.
91 This means that a user of an index need not know whether these
92 options were used in the creation of the index,
93 provided that not all the keys to be searched for
94 would have been discarded during indexing
95 and that the user supplies at least the part of each key
96 that would have remained after being truncated during indexing.
99 option is also stored in the index
100 and will be used in verifying records found using the index.
104 Print the version number.
108 Each file is a separate record.
111 Read the list of common words from
114 .BR @COMMON_WORDS_FILE@ .
119 as the pathname of the current working directory to store in the index,
120 instead of the path printed by
124 will be a symbolic link that points to the directory printed by
128 Read the files to be indexed from
134 files will be read from the standard input.
137 option can be given at most once.
140 Don't index the contents of fields whose names are in
148 Use the first prime greater than or equal to
150 for the size of the hash table.
153 will usually make searching faster,
154 but will make the index larger
165 keys per input record.
171 Discard keys that are shorter than
186 The index should be named
187 .IB basename @INDEX_SUFFIX@\fR.
196 .TP \w'\fB@L_INDXBIB@\fIXXXXXX'u+2n
197 .IB filename @INDEX_SUFFIX@
200 .B @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@
203 .B @COMMON_WORDS_FILE@
204 List of common words.
206 .BI @L_INDXBIB@ XXXXXX
210 .BR @L_P_REFER@ (@MAN1EXT@),
211 .BR @L_LKBIB@ (@MAN1EXT@),
212 .BR @L_LOOKBIB@ (@MAN1EXT@)