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

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