src/utils/lookbib/lookbib.man

   1 .TH @G@LOOKBIB @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
   2 .SH NAME
   3 @g@lookbib \- 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 .SH SYNOPSIS
  31 .\" --------------------------------------------------------------------
  32 .
  33 .B @g@lookbib
  34 [
  35 .B \-v
  36 ]
  37 [
  38 .BI \-i string
  39 ]
  40 [
  41 .BI \-t n
  42 ]
  43 .IR filename \|.\|.\|.
  44 .
  45 .
  46 .\" --------------------------------------------------------------------
  47 .SH DESCRIPTION
  48 .\" --------------------------------------------------------------------
  49 .
  50 .B @g@lookbib
  51 prints a prompt on the standard error (unless the standard input is not
  52 a terminal),
  53 reads from the standard input a line containing a set of keywords,
  54 searches the bibliographic databases
  55 .IR filename \|.\|.\|.\&
  56 for references containing those keywords,
  57 prints any references found on the standard output,
  58 and repeats this process until the end of input.
  59 .
  60 For each database
  61 .I filename
  62 to be searched,
  63 if an index
  64 .IB filename @INDEX_SUFFIX@
  65 created by
  66 .BR @g@indxbib (@MAN1EXT@)
  67 exists, then it will be searched instead;
  68 each index can cover multiple databases.
  69 .
  70 .
  71 .\" --------------------------------------------------------------------
  72 .SH OPTIONS
  73 .\" --------------------------------------------------------------------
  74 .
  75 It is possible to have whitespace between a command line option and its
  76 parameter.
  77 .
  78 .TP
  79 .B \-v
  80 Print the version number.
  81 .
  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 .
  88 .TP
  89 .BI \-t n
  90 Only require the first
  91 .I n
  92 characters of keys to be given.
  93 Initially
  94 .I n
  95 is\~6.
  96 .
  97 .
  98 .\" --------------------------------------------------------------------
  99 .SH FILES
 100 .\" --------------------------------------------------------------------
 101 .
 102 .TP \w'\fIfilename\fB@INDEX_SUFFIX@'u+2n
 103 .IB filename @INDEX_SUFFIX@
 104 Index files.
 105 .
 106 .
 107 .\" --------------------------------------------------------------------
 108 .SH "SEE ALSO"
 109 .\" --------------------------------------------------------------------
 110 .BR @g@refer (@MAN1EXT@),
 111 .BR lkbib (@MAN1EXT@),
 112 .BR @g@indxbib (@MAN1EXT@)
 113 .
 114 .
 115 .\" --------------------------------------------------------------------
 116 .SH COPYING
 117 .\" --------------------------------------------------------------------
 118 .co
 119 .
 120 .
 121 .\" Local Variables:
 122 .\" mode: nroff
 123 .\" End: