src/utils/indxbib/indxbib.man

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