man/gindxbib.man

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