Debian Codegraph @

texmf-dist/doc/man/man1/bibtex.1

raw
1 .TH BIBTEX 1 "15 January 2026" "bibtex 0.99e" "Web2C 2026"
2 .\"=====================================================================
3 .if t .ds TX \fRT\\h'-0.10m'\\v'0.17v'E\\v'-0.17v'\\h'-0.06m'X\fP
4 .if n .ds TX TeX
5 .ie t .ds OX \fIT\h'-0.17m'\v'+0.21m'E\v'-0.21m'\h'-0.04m'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 .\" OX for oblique LaTeX
14 .if t .ds OL \fIL\\h'-0.19m'\\v'-0.15v'\s-2A\s0\\h'-0.09m'\\v'0.15v'\fP\*(OX
15 .if n .ds OL LaTeX
16 .\"=====================================================================
17 .SH NAME
18 bibtex \- make a bibliography for (La)TeX
19 .SH SYNOPSIS
20 .B bibtex
21 .RB [ -min-crossrefs=\fInumber\fP ]
22 .RB [ -terse ]
23 .IR auxname [ \fB.aux\fP ]
24 .\"=====================================================================
25 .SH DESCRIPTION
26 \*(BX reads the top-level auxiliary
27 .RB ( .aux )
28 file
29 .I auxname
30 that was output during (typically) the running of
31 .BR latex (1)
32 or
33 .BR tex (1),
34 and creates a bibliography
35 .RB ( .bbl )
36 file that will be incorporated into the document on subsequent runs of
37 \*(LX or \*(TX.
38 .PP
39 \*(BX looks up, in bibliographic database
40 .RB ( .bib )
41 files specified by the \ebibliography command,
42 the entries specified by the \ecite and \enocite commands
43 in the \*(LX or \*(TX source file.
44 It formats the information from those entries
45 according to instructions in a bibliography style
46 .RB ( .bst )
47 file (specified by the \ebibliographystyle command),
48 and it outputs the results to the
49 .B .bbl
50 file.
51 .PP
52 The \*(LX manual
53 explains what a \*(LX source file must contain to work with \*(BX.
54 Appendix B of the manual describes the format of the
55 .B .bib
56 files.
57 .PP
58 The short `\*(BXing' (``btxdoc'') document describes extensions and
59 details of this format, and gives other useful hints for using \*(BX.
60 .PP
61 \*(BX can also be used with plain TeX, via \\input btxmac; the
62 interface is essentially the same as \*(LX. The support is included in
63 .BR eplain (1),
64 and the Eplain manual explains the usage, which is essentially the same
65 as in \*(LX: https://tug.org/eplain/doc/eplain.html#Citations
66 .\"=====================================================================
67 .SH OPTIONS
68 See
69 .BR tex (1)
70 for details of command-line parsing.
71 .PP
72 The
73 .B -min-crossrefs
74 option defines the minimum number of
75 .B crossref
76 required for automatic inclusion of the crossref base entry in the citation
77 list; the default is two.
78 To avoid these automatic inclusions altogether, give this option
79 a sufficiently large number, and be sure to remove any
80 previous
81 .B .aux
82 and
83 .B .bbl
84 files. Otherwise the option may
85 appear to have no effect, since \*(BX will have added the citation
86 for the base entry to the
87 .B .aux
88 file, and nothing will remove it.
89 .PP
90 With the
91 .B -terse
92 option, \*(BX operates silently. Without it, a banner and progress
93 reports are printed on stdout.
94 .PP
95 The standard
96 .B -help
97 and
98 .B -version
99 options are also supported.
100 .\"=====================================================================
101 .SH ENVIRONMENT
102 \*(BX searches the directories in the
103 path defined by the BSTINPUTS environment variable for
104 .B .bst
105 files.
106 If BSTINPUTS is not set, it uses the system default.
107 For
108 .B .bib
109 files, it uses the BIBINPUTS environment variable if that is set,
110 otherwise the default.
111 See
112 .BR tex (1)
113 for the details of the searching.
114 .PP
115 If the environment variable
116 TEXMFOUTPUT is set, \*(BX attempts to put its output
117 files in it, if they cannot be put in the current directory. Again, see
118 .BR tex (1).
119 No special searching is done for the
120 .B .aux
121 file.
122 .\"=====================================================================
123 .SH FILES
124 .TP 10n
125 .I *.bst
126 Bibliography style files.
127 .TP
128 .I btxdoc.tex
129 ``\*(BXing'' \- documentation for \*(BX users
130 .TP
131 .I btxhak.tex
132 ``Designing \*(BX Styles'' \- documentation for .bst writers
133 .TP
134 .I btxdoc.bib
135 database file for those two documents
136 .TP
137 .I xampl.bib
138 database file giving examples of all standard entry types
139 .TP
140 .I btxbst.doc
141 template file and documentation for the standard styles
142 .TP
143 .I btxmac.tex
144 \*(BX for plain TeX
145 .PP
146 All those files should be available somewhere on your system. Running
147 .I texdoc btxdoc
148 (or \fIbtxhak\fR) may display the above documents.
149 .\"=====================================================================
150 .SH "SEE ALSO"
151 .BR latex (1),
152 .BR eplain (1),
153 .BR tex (1).
154 .PP
155 \*(BX home page: https://tug.org/bibtex
156 .br
157 Bib-related CTAN topics: https://ctan.org/topic/:B
158 .br
159 \*(BX package page on CTAN: https://ctan.org/pkg/bibtex
160 .br
161 (which has links to the above documents, among others).
162 .PP
163 Leslie Lamport,
164 .IR "\*(OL: A Document Preparation System" ,
165 Addison-Wesley.
166 .PP
167 Bibliography support in plain TeX:
168 https://tug.org/eplain/doc/eplain.html#Citations
169 .PP
170 \*(BX chapter in the Web2c manual:
171 https://tug.org/texinfohtml/web2c.html#BibTeX
172 .PP
173 Typeset source code for \*(BX:
174 https://ctan.org/pkg/knuth-pdf
175 .PP
176 Thanks to Nelson Beebe, the University of Utah has a vast collection of
177 .I .bib
178 files available, including entries for all the standard \*(TX
179 books and a complete bibliography for \fITUGboat\fP. Nelson also provides
180 this information page on \*(BX:
181 .br
182 https://ftp.math.utah.edu/pub/bibnet/bibtex-info.html
183 .br
184 and a large collection of \*(BX-related tools:
185 .br
186 https://www.math.utah.edu/~beebe/software/bibtex-bibliography-tools.html
187 .\"=====================================================================
188 .SH AUTHOR
189 Oren Patashnik, Stanford University. This man page describes the Web2c
190 (\*(TX Live) version of \*(BX. Other ports of \*(BX do not have the same
191 path searching implementation or the same command-line options.
192 .PP
193 Public discussion list and bug reports: https://lists.tug.org/biblio