lkbib.man revision 75584
1.ig \"-*- nroff -*-
2Copyright (C) 1989-2000 Free Software Foundation, Inc.
3
4Permission is granted to make and distribute verbatim copies of
5this manual provided the copyright notice and this permission notice
6are preserved on all copies.
7
8Permission is granted to copy and distribute modified versions of this
9manual under the conditions for verbatim copying, provided that the
10entire resulting derived work is distributed under the terms of a
11permission notice identical to this one.
12
13Permission is granted to copy and distribute translations of this
14manual into another language, under the above conditions for modified
15versions, except that this permission notice may be included in
16translations approved by the Free Software Foundation instead of in
17the original English.
18..
19.ds g \" empty
20.ds G \" empty
21.\" Like TP, but if specified indent is more than half
22.\" the current line-length - indent, use the default indent.
23.de Tp
24.ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
25.el .TP "\\$1"
26..
27.TH LKBIB @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
28.SH NAME
29lkbib \- search bibliographic databases
30.SH SYNOPSIS
31.B lkbib
32[
33.B \-v
34]
35[
36.BI \-i fields
37]
38[
39.BI \-p filename
40]
41[
42.BI \-t n
43]
44.IR key \|.\|.\|.
45.PP
46It is possible to have whitespace between a command line option and its
47parameter.
48.SH DESCRIPTION
49.B lkbib
50searches bibliographic databases for references that contain the keys
51.IR key \|.\|.\|.
52and prints any references found on the standard output.
53.B lkbib
54will search any databases given by
55.B \-p
56options, and then a default database.
57The default database is taken from the
58.SB REFER
59environment variable if it is set,
60otherwise it is
61.BR @DEFAULT_INDEX@ .
62For each database
63.I filename
64to be searched,
65if an index
66.IB filename @INDEX_SUFFIX@
67created by
68.BR @g@indxbib (@MAN1EXT@)
69exists, then it will be searched instead;
70each index can cover multiple databases.
71.SH OPTIONS
72.TP
73.B \-v
74Print the version number.
75.TP
76.BI \-p filename
77Search
78.IR filename .
79Multiple
80.B \-p
81options can be used.
82.TP
83.BI \-i string
84When searching files for which no index exists,
85ignore the contents of fields whose names are in
86.IR string .
87.TP
88.BI \-t n
89Only require the first
90.I n
91characters of keys to be given.
92Initially
93.I n
94is 6.
95.SH ENVIRONMENT
96.TP \w'\fBREFER'u+2n
97.SB REFER
98Default database.
99.SH FILES
100.Tp \w'\fB@DEFAULT_INDEX@'u+2n
101.B @DEFAULT_INDEX@
102Default database to be used if the
103.SB REFER
104environment variable is not set.
105.IB filename @INDEX_SUFFIX@
106Index files.
107.SH "SEE ALSO"
108.BR @g@refer (@MAN1EXT@),
109.BR @g@lookbib (@MAN1EXT@),
110.BR @g@indxbib (@MAN1EXT@)
111