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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
|
.TH BIBTOOL 1 "24 February 2012" "Debian"
.SH NAME
BibTool \- BibTeX file manipulation tool
.SH SYNOPSIS
.B bibtool
[options] [files]
.SH DESCRIPTION
This manual is not meant to be exhaustive.
The complete documentation for
.B BibTool
can be found in the
.IR "BibTool Manual" .
BibTeX provides an easy to use means to integrate citations and
bibliographies into LaTeX documents. But the user is left alone with
the management of the BibTeX files.
.B BibTool
is intended to fill this gap.
.B BibTool
allows the manipulation of BibTeX files which goes
beyond the possibilities - and intentions - of BibTeX.
.PP
.B BibTool
manipulates BibTeX database files through
the command line front\-end
.B bibtool
which accepts numerous options.
Modifications are performed through
resource instructions
that allow the modification of the various internal parameters
determining the behavior of
.BR BibTool ;
resource instructions can be grouped in resource files.
The original
.B BibTool
distribution contains a sufficient set of resource file samples
to perform basic, relevant manipulations.
.SH OPTIONS
.B bibtool
accepts the following options.
.SS "Resource files"
.TP
\fB\-R\fR
Immediately evaluate the instructions from the default resource file.
.TP
.BI \fB\-r\ rsc_file
Immediately evaluate the instructions from the resource file
.IR rsc_file .
.TP
.BI \fB\-\-\ rsc_cmd
Evaluate the resource instruction
.IR rsc_cmd .
.SS "Input file"
.TP
.BI \fB\-i\ bib_file
Add the BibTeX database file
.IR bib_file
to the list of input files.
If \fB\-i\fR omitted the file name may not start with a \-.
If absent stdin is taken to read from.
.\"Multiple input files may be given.
Input files should follow the
.BR bibtex (1)
conventions.
.SS "Output file"
.TP
.BI \fB\-o\ output_file
Direct output to the file
.IR output_file .
If absent the output is directed to stdout.
.SS "Status reporting"
.TP
\fB\-q\fR
Suppress warnings. Errors can not be suppressed.
.TP
\fB\-v\fR
Enable informative messages on the activities of BibTool.
.SS "Sorting"
.TP
\fB\-s\fR
Enable sorting of entries.
.TP
\fB\-S\fR
Enable sorting of entries in reverse order.
.TP
.BI \fB\-A\ type
Determine key disambuguation;
.IR type
in 0, a, A.
.SS "Selecting items"
.TP
.BI \fB\-x\ aux_file
Extract the entries from the auxiliary
.RI ( .aux )
.\".BR latex (1)
LaTeX
.IR aux_file
file.
.TP
.BI \fB\-X\ regex
Select certain entries according to the regular expression
.IR regex .
.TP
\fB\-c\fR
Turn on the additional selection of crossreferenced entries.
.SS "Key generation"
.TP
.BI \fB\-f\ key_format
Set the specification for key generation to
.IR key_format .
.TP
\fB\-F\fR
Turn on key generation.
.TP
\fB\-k\fR
Generate short format keys.
.TP
\fB\-K\fR
Generate long format keys.
.SS "Semantic checks"
.TP
\fB\-d\fR
Find and mark (or delete) entries with identical sort keys.
.SS "Strings/Macros"
.TP
.BI \fB\-m\ mac_file
Write the macro definitions to the file
.IR mac_file
(\- is stdout).
.TP
.BI \fB\-M\ mac_file
Write the used macro definitions to the file
.IR mac_file
(\- is stdout).
.SS "Getting help"
.TP
\fB\-h\fR
Print short help and exit.
.TP
\fB\-V\fR
Print version and exit.
.SS "Statistics"
.TP
\fB\-#\fR
Print statistics about all known entry types (long).
.TP
\fB\-@\fR
Print statistics about the used entry types only (short).
.SH ENVIRONMENT
.TP
.B BIBINPUTS
Search path for BibTeX database
.RI ( .bib )
files.
.TP
.B BIBTOOL
Search path for BibTool resource
.RI ( .rsc )
files.
.TP
.B BIBTOOLRSC
List of resource file names separated by colon.
.SH FILES
.TP
.I ./.bibtoolrsc
The default current directory
BibTool
resource file.
.TP
.I ~/.bibtoolrsc
The default individual
BibTool
resource file.
.TP
.I
/usr/share/bibtool/*.rsc
The BibTool resource files included in the original distribution.
.TP
.I
/usr/share/doc/bibtool/bibtool.pdf
The
.IR "BibTool Manual" .
.TP
.I
/usr/share/doc/bibtool/ref_card.pdf
The
.IR "BibTool Quick Reference Card".
.SH SEE ALSO
.BR bibtex (1),
.BR latex (1),
.BR tex (1)
.br
The
.IR "BibTool Manual" .
.SH BUGS
Some arrays are allocated statically which may result in an overflow.
.br
Most memory is allocated but not returned to the OS:
A garbage collection algorithm might be integrated in a future release.
.br
This man page is updated only occasionally,
so it is very likely out of date.
For complete, current documentation, refer to the
.IR "BibTool Manual"
which is distributed as LaTeX source file
.RB ( bibtool.tex )
in the original
.BR BibTool
source distribution.
.SH AUTHOR
BibTool is designed and maintained by Gerd Neugebauer.
.\".SH COPYRIGHT
.\"Copyright (C) 1996\-2012 Gerd Neugebauer <gene@gerd-neugebauer.de>
|