source/texk/web2c/man/bibtex.man

   1 .TH BIBTEX 1 "16 June 2015" "bibtex 0.99d" "Web2C @VERSION@"
   2 .\"=====================================================================
   3 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
   4 .if n .ds TX TeX
   5 .ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP
   6 .el .ds OX TeX
   7 .\" BX definition must follow TX so BX can use TX
   8 .if t .ds BX \fRB\s-2IB\s0\fP\*(TX
   9 .if n .ds BX BibTeX
  10 .\" LX definition must follow TX so LX can use TX
  11 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\\s-2A\\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
  12 .if n .ds LX LaTeX
  13 .\"=====================================================================
  14 .SH NAME
  15 bibtex \- make a bibliography for (La)TeX
  16 .SH SYNOPSIS
  17 .B bibtex
  18 .RB [ \-min-crossrefs=\fInumber\fP ]
  19 .RB [ \-terse ]
  20 .IR auxname [ \fB.aux\fP ]
  21 .\"=====================================================================
  22 .SH DESCRIPTION
  23 This manual page is not meant to be exhaustive.  The complete
  24 documentation for this version of \*(TX can be found in the info file
  25 or manual
  26 .IR "Web2C: A TeX implementation" .
  27 .PP
  28 \*(BX reads the top-level auxiliary
  29 .RB ( .aux )
  30 file
  31 .I auxname
  32 that was output during the running of
  33 .BR latex (1)
  34 or
  35 .BR tex (1)
  36 and creates a bibliography
  37 .RB ( .bbl )
  38 file that will be incorporated into the document on subsequent runs of
  39 \*(LX or \*(TX.
  40 .PP
  41 \*(BX looks up, in bibliographic database
  42 .RB ( .bib )
  43 files specified by the \\bibliography command,
  44 the entries specified by the \\cite and \\nocite commands
  45 in the \*(LX or \*(TX source file.
  46 It formats the information from those entries
  47 according to instructions in a bibliography style
  48 .RB ( .bst )
  49 file (specified by the \\bibliographystyle command,
  50 and it outputs the results to the
  51 .B .bbl
  52 file.
  53 .PP
  54 The \*(LX manual
  55 explains what a \*(LX source file must contain to work with \*(BX.
  56 Appendix B of the manual describes the format of the
  57 .B .bib
  58 files. The `\*(BXing' document describes extensions and details of
  59 this format, and it gives other useful hints for using \*(BX.
  60 .\"=====================================================================
  61 .SH OPTIONS
  62 The
  63 .B \-min-crossrefs
  64 option defines the minimum number of
  65 .B crossref
  66 required for automatic inclusion of the crossref'd entry on the citation
  67 list; the default is two.
  68 With the
  69 .B \-terse
  70 option, \*(BX operates silently.  Without it, a banner and progress
  71 reports are printed on
  72 .IR stdout .
  73 .PP
  74 .\"=====================================================================
  75 .SH ENVIRONMENT
  76 \*(BX searches the directories in the
  77 path defined by the BSTINPUTS environment variable for
  78 .B .bst
  79 files. If BSTINPUTS is not set, it uses the system default.
  80 For
  81 .B .bib
  82 files, it uses the BIBINPUTS environment variable if that is set,
  83 otherwise the default.
  84 See
  85 .BR tex (1)
  86 for the details of the searching.
  87 .PP
  88 If the environment variable
  89 TEXMFOUTPUT is set, \*(BX attempts to put its output
  90 files in it, if they cannot be put in the current directory.  Again, see
  91 .BR tex (1).
  92 No special searching is done for the
  93 .B .aux
  94 file.
  95 .\"=====================================================================
  96 .SH FILES
  97 .TP
  98 .I *.bst
  99 Bibliography style files.
 100 .TP
 101 .I btxdoc.tex
 102 ``\*(BXing'' \- \*(LXable documentation for general \*(BX users
 103 .TP
 104 .I btxhak.tex
 105 ``Designing \*(BX Styles'' \- \*(LXable documentation for style designers
 106 .TP
 107 .I btxdoc.bib
 108 database file for those two documents
 109 .TP
 110 .I xampl.bib
 111 database file giving examples of all standard entry types
 112 .TP
 113 .I btxbst.doc
 114 template file and documentation for the standard styles
 115 .PP
 116 All those files should be available somewhere on your system.
 117 .PP
 118 The host math.utah.edu has a vast collection of
 119 .B .bib
 120 files available for anonymous ftp, including references for all the
 121 standard \*(TX books and a complete bibliography for TUGboat.
 122 .\"=====================================================================
 123 .SH "SEE ALSO"
 124 .BR latex (1),
 125 .BR tex (1).
 126 .br
 127 Leslie Lamport,
 128 .IR "\*(LX \- A Document Preparation System" ,
 129 Addison-Wesley, 1985, ISBN 0-201-15790-X.
 130 .\"=====================================================================
 131 .SH AUTHOR
 132 Oren Patashnik, Stanford University.  This man page describes the web2c
 133 version of \*(BX.  Other ports of \*(BX, such as Donald Knuth's version
 134 using the Sun Pascal compiler, do not have the same path searching
 135 implementation, or the command-line options.