contrib/groff/src/utils/indxbib/indxbib.man

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