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

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 136 lines · 133 code · 3 blank · 0 comment · 0 complexity · fe12ed13e0f47429e97cbc35e5af4375 MD5 · raw file

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