Debian Codegraph @

upstream/debian-unstable/man1/lkbib.1

raw
1 .TH lkbib 1 "2026-04-22" "groff 1.24.1"
2 .SH Name
3 lkbib \- search bibliographic databases
4 .
5 .
6 .\" ====================================================================
7 .\" Legal Terms
8 .\" ====================================================================
9 .\"
10 .\" Copyright (C) 1989-2024 Free Software Foundation, Inc.
11 .\"
12 .\" Permission is granted to make and distribute verbatim copies of this
13 .\" manual provided the copyright notice and this permission notice are
14 .\" preserved on all copies.
15 .\"
16 .\" Permission is granted to copy and distribute modified versions of
17 .\" this manual under the conditions for verbatim copying, provided that
18 .\" the entire resulting derived work is distributed under the terms of
19 .\" a permission notice identical to this one.
20 .\"
21 .\" Permission is granted to copy and distribute translations of this
22 .\" manual into another language, under the above conditions for
23 .\" modified versions, except that this permission notice may be
24 .\" included in translations approved by the Free Software Foundation
25 .\" instead of in the original English.
26 .
27 .
28 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
29 .do nr *groff_lkbib_1_man_C \n[.cp]
30 .cp 0
31 .
32 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
33 .nr do-fallback 0
34 .if !\n(.f .nr do-fallback 1 \" mandoc
35 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
36 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
37 .if \n[do-fallback] \{\
38 . de MR
39 . ie \\n(.$=1 \
40 . I \%\\$1
41 . el \
42 . IR \%\\$1 (\\$2)\\$3
43 . .
44 .\}
45 .rr do-fallback
46 .
47 .
48 .\" ====================================================================
49 .SH Synopsis
50 .\" ====================================================================
51 .
52 .SY lkbib
53 .RB [ \-n ]
54 .RB [ \-i\~\c
55 .IR fields ]
56 .RB [ \-p\~\c
57 .IR file ]
58 \&.\|.\|.\&
59 .RB [ \-t\~\c
60 .IR n ]
61 .I key
62 \&.\|.\|.
63 .YS
64 .
65 .
66 .P
67 .SY lkbib
68 .B \-\-help
69 .YS
70 .
71 .
72 .P
73 .SY lkbib
74 .B \-v
75 .YS
76 .
77 .SY lkbib
78 .B \%\-\-version
79 .YS
80 .
81 .
82 .\" ====================================================================
83 .SH Description
84 .\" ====================================================================
85 .
86 .I \%lkbib
87 searches bibliographic databases for references matching all
88 keywords
89 .I key
90 and writes any references found to the standard output
91 stream.
92 .
93 It reads databases given by
94 .B \-p
95 options
96 and then
97 (unless
98 .B \-n
99 is given)
100 a default database.
101 .
102 The default database is taken from the
103 .I \%REFER
104 environment variable if it is set,
105 otherwise it is
106 .IR /usr/\:\%dict/\:\%papers/\:\%Ind .
107 .
108 For each database
109 .I file
110 to be searched,
111 if an index
112 .RI file \%.i
113 created by
114 .MR \%indxbib 1
115 exists,
116 then it will be searched instead;
117 each index can cover multiple databases.
118 .
119 .
120 .\" ====================================================================
121 .SH Options
122 .\" ====================================================================
123 .
124 .B \-\-help
125 displays a usage message,
126 while
127 .B \-v
128 and
129 .B \%\-\-version
130 show version information;
131 all exit afterward.
132 .
133 .
134 .TP
135 .BI \-i\~ string
136 When searching files for which no index exists,
137 ignore the contents of fields whose names are in
138 .IR string .
139 .
140 .
141 .TP
142 .B \-n
143 Suppress search of default database.
144 .
145 .
146 .TP
147 .BI \-p\~ file
148 Search
149 .IR file .
150 .
151 Multiple
152 .B \-p
153 options can be used.
154 .
155 .
156 .TP
157 .BI \-t\~ n
158 Require only the first
159 .I n
160 characters of keys to be given.
161 .
162 The default
163 is\~6.
164 .
165 .
166 .\" ====================================================================
167 .SH "Exit status"
168 .\" ====================================================================
169 .
170 .I \%lkbib
171 exits with
172 .RB status\~ 0
173 on successful operation,
174 .RB status\~ 2
175 if the program cannot interpret its command-line arguments,
176 and
177 .RB status\~ 1
178 if it encounters an error during operation.
179 .
180 .
181 .\" ====================================================================
182 .SH Environment
183 .\" ====================================================================
184 .
185 .TP
186 .I REFER
187 Assign this variable a file name to override the default database.
188 .
189 .
190 .\" ====================================================================
191 .SH Files
192 .\" ====================================================================
193 .
194 .TP
195 .I \%/usr/\:\%dict/\:\%papers/\:\%Ind
196 Default database to be used if the
197 .I \%REFER
198 environment variable is not set.
199 .
200 .
201 .TP
202 .RI file \%.i
203 Index files.
204 .
205 .
206 .\" ====================================================================
207 .SH "See also"
208 .\" ====================================================================
209 .
210 \[lq]Some Applications of Inverted Indexes on the Unix System\[rq],
211 by M.\& E.\& Lesk,
212 1978,
213 AT&T Bell Laboratories Computing Science Technical Report No.\& 69.
214 .
215 .
216 .LP
217 .MR \%refer 1 ,
218 .MR \%lookbib 1 ,
219 .MR \%indxbib 1
220 .
221 .
222 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
223 .cp \n[*groff_lkbib_1_man_C]
224 .do rr *groff_lkbib_1_man_C
225 .
226 .
227 .\" Local Variables:
228 .\" fill-column: 72
229 .\" mode: nroff
230 .\" End:
231 .\" vim: set filetype=groff textwidth=72: