Debian Codegraph @

upstream/debian-trixie/man1/lkbib.1

raw
1 .TH lkbib 1 "3 June 2025" "groff 1.23.0"
2 .SH Name
3 lkbib \- search bibliographic databases
4 .
5 .
6 .\" ====================================================================
7 .\" Legal Terms
8 .\" ====================================================================
9 .\"
10 .\" Copyright (C) 1989-2020 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 .SY lkbib
67 .B \-\-help
68 .YS
69 .
70 .
71 .SY lkbib
72 .B \-v
73 .
74 .SY lkbib
75 .B \-\-version
76 .YS
77 .
78 .
79 .\" ====================================================================
80 .SH Description
81 .\" ====================================================================
82 .
83 .I \%lkbib
84 searches bibliographic databases for references containing keywords
85 .I key
86 and writes any references found to the standard output
87 stream.
88 .
89 It reads databases given by
90 .B \-p
91 options
92 and then
93 (unless
94 .B \-n
95 is given)
96 a default database.
97 .
98 The default database is taken from the
99 .I \%REFER
100 environment variable if it is set,
101 otherwise it is
102 .IR /usr/\:\%dict/\:\%papers/\:\%Ind .
103 .
104 For each database
105 .I file
106 to be searched,
107 if an index
108 .RI file \%.i
109 created by
110 .MR \%indxbib 1
111 exists,
112 then it will be searched instead;
113 each index can cover multiple databases.
114 .
115 .
116 .\" ====================================================================
117 .SH Options
118 .\" ====================================================================
119 .
120 .B \-\-help
121 displays a usage message,
122 while
123 .B \-v
124 and
125 .B \-\-version
126 show version information;
127 all exit afterward.
128 .
129 .
130 .TP
131 .BI \-i\~ string
132 When searching files for which no index exists,
133 ignore the contents of fields whose names are in
134 .IR string .
135 .
136 .
137 .TP
138 .B \-n
139 Suppress search of default database.
140 .
141 .
142 .TP
143 .BI \-p\~ file
144 Search
145 .IR file .
146 .
147 Multiple
148 .B \-p
149 options can be used.
150 .
151 .
152 .TP
153 .BI \-t\~ n
154 Require only the first
155 .I n
156 characters of keys to be given.
157 .
158 The default
159 is\~6.
160 .
161 .
162 .\" ====================================================================
163 .SH Environment
164 .\" ====================================================================
165 .
166 .TP
167 .I REFER
168 Default database.
169 .
170 .
171 .\" ====================================================================
172 .SH Files
173 .\" ====================================================================
174 .
175 .TP
176 .I \%/usr/\:\%dict/\:\%papers/\:\%Ind
177 Default database to be used if the
178 .I \%REFER
179 environment variable is not set.
180 .
181 .
182 .TP
183 .RI file \%.i
184 Index files.
185 .
186 .
187 .\" ====================================================================
188 .SH "See also"
189 .\" ====================================================================
190 .
191 \[lq]Some Applications of Inverted Indexes on the Unix System\[rq],
192 by M.\& E.\& Lesk,
193 1978,
194 AT&T Bell Laboratories Computing Science Technical Report No.\& 69.
195 .
196 .
197 .LP
198 .MR \%refer 1 ,
199 .MR \%lookbib 1 ,
200 .MR \%indxbib 1
201 .
202 .
203 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
204 .cp \n[*groff_lkbib_1_man_C]
205 .do rr *groff_lkbib_1_man_C
206 .
207 .
208 .\" Local Variables:
209 .\" fill-column: 72
210 .\" mode: nroff
211 .\" End:
212 .\" vim: set filetype=groff textwidth=72: