man/ute-lkbib.1.in

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