summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-leap-15-6/man1/indxbib.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/opensuse-leap-15-6/man1/indxbib.1
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/opensuse-leap-15-6/man1/indxbib.1')
-rw-r--r--upstream/opensuse-leap-15-6/man1/indxbib.1276
1 files changed, 276 insertions, 0 deletions
diff --git a/upstream/opensuse-leap-15-6/man1/indxbib.1 b/upstream/opensuse-leap-15-6/man1/indxbib.1
new file mode 100644
index 00000000..bb58698a
--- /dev/null
+++ b/upstream/opensuse-leap-15-6/man1/indxbib.1
@@ -0,0 +1,276 @@
+.TH INDXBIB 1 "7 February 2022" "groff 1.22.4"
+.SH NAME
+indxbib \- make inverted index for bibliographic databases
+.
+.
+.\" ====================================================================
+.\" Legal Terms
+.\" ====================================================================
+.\"
+.\" Copyright (C) 1989-2018 Free Software Foundation, Inc.
+.\"
+.\" Permission is granted to make and distribute verbatim copies of this
+.\" manual provided the copyright notice and this permission notice are
+.\" preserved on all copies.
+.\"
+.\" Permission is granted to copy and distribute modified versions of
+.\" this manual under the conditions for verbatim copying, provided that
+.\" the entire resulting derived work is distributed under the terms of
+.\" a permission notice identical to this one.
+.\"
+.\" Permission is granted to copy and distribute translations of this
+.\" manual into another language, under the above conditions for
+.\" modified versions, except that this permission notice may be
+.\" included in translations approved by the Free Software Foundation
+.\" instead of in the original English.
+.
+.
+.\" ====================================================================
+.SH SYNOPSIS
+.\" ====================================================================
+.
+.SY indxbib
+.OP \-w
+.OP \-c file
+.OP \-d dir
+.OP \-f file
+.OP \-h n
+.OP \-i string
+.OP \-k n
+.OP \-l n
+.OP \-n n
+.OP \-o file
+.OP \-t n
+.RI [ filename
+\&.\|.\|.\&]
+.YS
+.
+.SY indxbib
+.B \-\-help
+.YS
+.
+.SY indxbib
+.B \-v
+.SY indxbib
+.B \-\-version
+.YS
+.
+.\" ====================================================================
+.SH DESCRIPTION
+.\" ====================================================================
+.
+.B indxbib
+makes an inverted index for the bibliographic databases in
+.IR filename \|.\|.\|.
+for use with
+.BR refer (1),
+.BR lookbib (1),
+and
+.BR lkbib (1).
+.
+The index will be named
+.RI filename .i ;
+the index is written to a temporary file which is then renamed to
+this.
+.
+If no filenames are given on the command line because the
+.B \-f
+option has been used, and no
+.B \-o
+option is given, the index will be named
+.IR Ind.i .
+.
+.
+.LP
+Bibliographic databases are divided into records by blank lines.
+Within a record, each fields starts with a
+.B %
+character at the beginning of a line.
+.
+Fields have a one letter name which follows the
+.B %
+character.
+.
+.
+.LP
+The values set by the
+.BR \-c ,
+.BR \-n ,
+.BR \-l ,
+and
+.B \-t
+options are stored in the index;
+when the index is searched, keys will be discarded and truncated in a
+manner appropriate to these options;
+the original keys will be used for verifying that any record
+found using the index actually contains the keys.
+.
+This means that a user of an index need not know whether these
+options were used in the creation of the index,
+provided that not all the keys to be searched for
+would have been discarded during indexing
+and that the user supplies at least the part of each key
+that would have remained after being truncated during indexing.
+.
+The value set by the
+.B \-i
+option is also stored in the index
+and will be used in verifying records found using the index.
+.
+.
+.\" ====================================================================
+.SH OPTIONS
+.\" ====================================================================
+.
+Whitespace is permitted between a command-line option and its argument.
+.
+.
+.TP
+.B \-v
+Print the version number.
+.
+.TP
+.B \-w
+Index whole files.
+.
+Each file is a separate record.
+.
+.TP
+.BI \-c file
+Read the list of common words from
+.I file
+instead of
+.IR /usr/\:share/\:groff/\:1.22.4/\:eign .
+.
+.TP
+.BI \-d dir
+Use
+.I dir
+as the pathname of the current working directory to store in the index,
+instead of the path printed by
+.BR pwd (1).
+.
+Usually
+.I dir
+will be a symbolic link that points to the directory printed by
+.BR pwd (1).
+.
+.TP
+.BI \-f file
+Read the files to be indexed from
+.IR file .
+.
+If
+.I file
+is
+.BR \- ,
+files will be read from the standard input.
+The
+.B \-f
+option can be given at most once.
+.
+.TP
+.BI \-i string
+Don't index the contents of fields whose names are in
+.IR string .
+.
+Initially
+.I string
+is
+.BR XYZ .
+.
+.TP
+.BI \-h n
+Use the first prime greater than or equal to
+.I n
+for the size of the hash table.
+.
+Larger values of
+.I n
+will usually make searching faster,
+but will make the index larger
+and
+.B indxbib
+use more memory.
+.
+Initially
+.I n
+is 997.
+.
+.TP
+.BI \-k n
+Use at most
+.I n
+keys per input record.
+.
+Initially
+.I n
+is 100.
+.
+.TP
+.BI \-l n
+Discard keys that are shorter than
+.IR n .
+.
+Initially
+.I n
+is 3.
+.
+.TP
+.BI \-n n
+Discard the
+.I n
+most common words.
+.
+Initially
+.I n
+is 100.
+.
+.TP
+.BI \-o basename
+The index should be named
+.RI basename .i .
+.
+.TP
+.BI \-t n
+Truncate keys to
+.IR n .
+.
+Initially
+.I n
+is 6.
+.
+.
+.\" ====================================================================
+.SH FILES
+.\" ====================================================================
+.
+.TP
+.RI filename .i
+Index.
+.
+.TP
+.I Ind.i
+Default index name.
+.
+.TP
+.I /usr/\:share/\:groff/\:1.22.4/\:eign
+List of common words.
+.
+.TP
+.IR indxbib XXXXXX
+Temporary file.
+.
+.
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.BR refer (1),
+.BR lkbib (1),
+.BR lookbib (1)
+.
+.
+.\" Local Variables:
+.\" mode: nroff
+.\" End:
+.\" vim: set filetype=groff: