src/utils/lkbib/lkbib.man

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