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