man/ute-indxbib.1.in

   1 .ig
   2 @ @L_INDXBIB@.1
   3
   4 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
   5
   6 Copyright (C) 1989 - 2001 Free Software Foundation, Inc.
   7
   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.
  11
  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.
  16
  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
  21 the original English.
  22 ..
  23 .TH @U_INDXBIB@ @MAN1EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
  24 .SH NAME
  25 @L_INDXBIB@ \- make inverted index for bibliographic databases
  26 .SH SYNOPSIS
  27 .nr a \n(.j
  28 .ad l
  29 .nr i \n(.i
  30 .in +\w'\fB@L_INDXBIB@ 'u
  31 .ti \niu
  32 .B @L_INDXBIB@
  33 .de OP
  34 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
  35 .el .RB "[\ " "\\$1" "\ ]"
  36 ..
  37 .OP \-vw
  38 .OP \-c file
  39 .OP \-d dir
  40 .OP \-f file
  41 .OP \-h n
  42 .OP \-i string
  43 .OP \-k n
  44 .OP \-l n
  45 .OP \-n n
  46 .OP \-o file
  47 .OP \-t n
  48 .RI [\  filename \|.\|.\|.\ ]
  49 .ad \na
  50 .PP
  51 It is possible to have whitespace between a command line option and its
  52 parameter.
  53 .SH DESCRIPTION
  54 .B @L_INDXBIB@
  55 makes an inverted index for the bibliographic databases in
  56 .IR filename \|.\|.\|.
  57 for use with
  58 .BR @L_P_REFER@ (@MAN1EXT@),
  59 .BR @L_LOOKBIB@ (@MAN1EXT@),
  60 and
  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
  66 .B \-f
  67 option has been used, and no
  68 .B \-o
  69 option is given, the index will be named
  70 .BR @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@ .
  71 .LP
  72 Bibliographic databases are divided into records by blank lines.
  73 Within a record, each fields starts with a
  74 .B %
  75 character at the beginning of a line.
  76 Fields have a one letter name which follows the
  77 .B %
  78 character.
  79 .LP
  80 The values set by the
  81 .BR \-c ,
  82 .BR \-n ,
  83 .BR \-l
  84 and
  85 .B \-t
  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.
  97 The value set by the
  98 .B \-i
  99 option is also stored in the index
 100 and will be used in verifying records found using the index.
 101 .SH OPTIONS
 102 .TP
 103 .B \-v
 104 Print the version number.
 105 .TP
 106 .B \-w
 107 Index whole files.
 108 Each file is a separate record.
 109 .TP
 110 .BI \-c file
 111 Read the list of common words from
 112 .I file
 113 instead of
 114 .BR @COMMON_WORDS_FILE@ .
 115 .TP
 116 .BI \-d dir
 117 Use
 118 .I dir
 119 as the pathname of the current working directory to store in the index,
 120 instead of the path printed by
 121 .BR pwd (1).
 122 Usually
 123 .I dir
 124 will be a symbolic link that points to the directory printed by
 125 .BR pwd (1).
 126 .TP
 127 .BI \-f file
 128 Read the files to be indexed from
 129 .IR file .
 130 If
 131 .I file
 132 is
 133 .BR \- ,
 134 files will be read from the standard input.
 135 The
 136 .B \-f
 137 option can be given at most once.
 138 .TP
 139 .BI \-i string
 140 Don't index the contents of fields whose names are in
 141 .IR string .
 142 Initially
 143 .I string
 144 is
 145 .BR XYZ .
 146 .TP
 147 .BI \-h n
 148 Use the first prime greater than or equal to
 149 .I n
 150 for the size of the hash table.
 151 Larger values of
 152 .I n
 153 will usually make searching faster,
 154 but will make the index larger
 155 and
 156 .B @L_INDXBIB@
 157 use more memory.
 158 Initially
 159 .I n
 160 is 997.
 161 .TP
 162 .BI \-k n
 163 Use at most
 164 .I n
 165 keys per input record.
 166 Initially
 167 .I n
 168 is 100.
 169 .TP
 170 .BI \-l n
 171 Discard keys that are shorter than
 172 .IR n .
 173 Initially
 174 .I n
 175 is 3.
 176 .TP
 177 .BI \-n n
 178 Discard the
 179 .I n
 180 most common words.
 181 Initially
 182 .I n
 183 is 100.
 184 .TP
 185 .BI \-o basename
 186 The index should be named
 187 .IB basename @INDEX_SUFFIX@\fR.
 188 .TP
 189 .BI \-t n
 190 Truncate keys to
 191 .IR n .
 192 Initially
 193 .I n
 194 is 6.
 195 .SH FILES
 196 .TP \w'\fB@L_INDXBIB@\fIXXXXXX'u+2n
 197 .IB filename @INDEX_SUFFIX@
 198 Index.
 199 .TP
 200 .B @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@
 201 Default index name.
 202 .TP
 203 .B @COMMON_WORDS_FILE@
 204 List of common words.
 205 .TP
 206 .BI @L_INDXBIB@ XXXXXX
 207 Temporary file.
 208 .
 209 .SH "SEE ALSO"
 210 .BR @L_P_REFER@ (@MAN1EXT@),
 211 .BR @L_LKBIB@ (@MAN1EXT@),
 212 .BR @L_LOOKBIB@ (@MAN1EXT@)
 213 .
 214 .\" s-ts-mode