contrib/groff/src/utils/lkbib/lkbib.man

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