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

   1 .ig
   2 Copyright (C) 1989-2000, 2001 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 .ds g \" empty
  20 .ds G \" empty
  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 .TH LKBIB @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  28 .SH NAME
  29 lkbib \- search bibliographic databases
  30 .SH SYNOPSIS
  31 .B lkbib
  32 [
  33 .B \-v
  34 ]
  35 [
  36 .BI \-i fields
  37 ]
  38 [
  39 .BI \-p filename
  40 ]
  41 [
  42 .BI \-t n
  43 ]
  44 .IR key \|.\|.\|.
  45 .PP
  46 It is possible to have whitespace between a command line option and its
  47 parameter.
  48 .SH DESCRIPTION
  49 .B lkbib
  50 searches bibliographic databases for references that contain the keys
  51 .IR key \|.\|.\|.
  52 and prints any references found on the standard output.
  53 .B lkbib
  54 will search any databases given by
  55 .B \-p
  56 options, and then a default database.
  57 The default database is taken from the
  58 .SB REFER
  59 environment variable if it is set,
  60 otherwise it is
  61 .BR @DEFAULT_INDEX@ .
  62 For each database
  63 .I filename
  64 to be searched,
  65 if an index
  66 .IB filename @INDEX_SUFFIX@
  67 created by
  68 .BR @g@indxbib (@MAN1EXT@)
  69 exists, then it will be searched instead;
  70 each index can cover multiple databases.
  71 .SH OPTIONS
  72 .TP
  73 .B \-v
  74 Print the version number.
  75 .TP
  76 .BI \-p filename
  77 Search
  78 .IR filename .
  79 Multiple
  80 .B \-p
  81 options can be used.
  82 .TP
  83 .BI \-i string
  84 When searching files for which no index exists,
  85 ignore the contents of fields whose names are in
  86 .IR string .
  87 .TP
  88 .BI \-t n
  89 Only require the first
  90 .I n
  91 characters of keys to be given.
  92 Initially
  93 .I n
  94 is 6.
  95 .SH ENVIRONMENT
  96 .TP \w'\fBREFER'u+2n
  97 .SB REFER
  98 Default database.
  99 .SH FILES
 100 .Tp \w'\fB@DEFAULT_INDEX@'u+2n
 101 .B @DEFAULT_INDEX@
 102 Default database to be used if the
 103 .SB REFER
 104 environment variable is not set.
 105 .IB filename @INDEX_SUFFIX@
 106 Index files.
 107 .SH "SEE ALSO"
 108 .BR @g@refer (@MAN1EXT@),
 109 .BR @g@lookbib (@MAN1EXT@),
 110 .BR @g@indxbib (@MAN1EXT@)
 111 .
 112 .\" Local Variables:
 113 .\" mode: nroff
 114 .\" End: