src/utils/lkbib/lkbib.1.man

   1 .TH LKBIB @MAN1EXT@ "@MDATE@" "groff @VERSION@"
   2 .SH NAME
   3 lkbib \- search bibliographic databases
   4 .
   5 .
   6 .\" ====================================================================
   7 .\" Legal Terms
   8 .\" ====================================================================
   9 .\"
  10 .\" Copyright (C) 1989-2018 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 .\" ====================================================================
  29 .SH SYNOPSIS
  30 .\" ====================================================================
  31 .
  32 .SY lkbib
  33 .OP \-n
  34 .OP \-i fields
  35 .OP \-p filename
  36 .OP \-t n
  37 .I key
  38 \&.\|.\|.\&
  39 .YS
  40 .
  41 .SY lkbib
  42 .B \-\-help
  43 .YS
  44 .
  45 .SY lkbib
  46 .B \-v
  47 .SY lkbib
  48 .B \-\-version
  49 .YS
  50 .
  51 .
  52 .\" ====================================================================
  53 .SH DESCRIPTION
  54 .\" ====================================================================
  55 .
  56 .I lkbib
  57 searches bibliographic databases for references that contain the keys
  58 .I key
  59 \&.\|.\|.\& and prints any references found on the standard output.
  60 .
  61 .I lkbib
  62 will search any databases given by
  63 .B \-p
  64 options, and then a default database.
  65 .
  66 The default database is taken from the
  67 .I \%REFER
  68 environment variable if it is set,
  69 otherwise it is
  70 .IR @DEFAULT_INDEX@ .
  71 .
  72 For each database
  73 .I filename
  74 to be searched,
  75 if an index
  76 .RI filename @INDEX_SUFFIX@
  77 created by
  78 .IR @g@indxbib (@MAN1EXT@)
  79 exists, then it will be searched instead;
  80 each index can cover multiple databases.
  81 .
  82 .
  83 .\" ====================================================================
  84 .SH OPTIONS
  85 .\" ====================================================================
  86 .
  87 Whitespace is permitted between a command-line option and its argument.
  88 .
  89 .
  90 .TP
  91 .B \-\-help
  92 Display a usage message and exit.
  93 .
  94 .
  95 .TP
  96 .BI \-i string
  97 When searching files for which no index exists,
  98 ignore the contents of fields whose names are in
  99 .IR string .
 100 .
 101 .
 102 .TP
 103 .BI \-p filename
 104 Search
 105 .IR filename .
 106 .
 107 Multiple
 108 .B \-p
 109 options can be used.
 110 .
 111 .
 112 .TP
 113 .BI \-t n
 114 Only require the first
 115 .I n
 116 characters of keys to be given.
 117 .
 118 Initially
 119 .I n
 120 is\~6.
 121 .
 122 .
 123 .TP
 124 .B \-v
 125 .TQ
 126 .B \-\-version
 127 Display version information and exit.
 128 .
 129 .
 130 .\" ====================================================================
 131 .SH ENVIRONMENT
 132 .\" ====================================================================
 133 .
 134 .TP
 135 .I REFER
 136 Default database.
 137 .
 138 .
 139 .\" ====================================================================
 140 .SH FILES
 141 .\" ====================================================================
 142 .
 143 .TP
 144 .I @DEFAULT_INDEX@
 145 Default database to be used if the
 146 .I \%REFER
 147 environment variable is not set.
 148 .
 149 .
 150 .TP
 151 .RI filename @INDEX_SUFFIX@
 152 Index files.
 153 .
 154 .
 155 .\" ====================================================================
 156 .SH "SEE ALSO"
 157 .\" ====================================================================
 158 .IR @g@refer (@MAN1EXT@),
 159 .IR @g@lookbib (@MAN1EXT@),
 160 .IR @g@indxbib (@MAN1EXT@)
 161 .
 162 .
 163 .\" Local Variables:
 164 .\" mode: nroff
 165 .\" End:
 166 .\" vim: set filetype=groff: