src/utils/indxbib/indxbib.1.man

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