1BIBTOOL(1) General Commands Manual BIBTOOL(1)
2
6 BibTool - BibTeX file manipulation tool
7
9 bibtool [options] [files]
10
12 This manual is not meant to be exhaustive. The complete documentation
13 for BibTool can be found in the BibTool Manual. BibTeX provides an
14 easy to use means to integrate citations and bibliographies into LaTeX
15 documents. But the user is left alone with the management of the BibTeX
16 files. BibTool is intended to fill this gap. BibTool allows the
17 manipulation of BibTeX files which goes beyond the possibilities - and
18 intentions - of BibTeX.
19 BibTool manipulates BibTeX database files through the command line
21 front-end bibtool which accepts numerous options. Modifications are
22 performed through resource instructions that allow the modification of
23 the various internal parameters determining the behavior of BibTool;
24 resource instructions can be grouped in resource files. The original
25 BibTool distribution contains a sufficient set of resource file samples
26 to perform basic, relevant manipulations.
27
29 bibtool accepts the following options.
30 Resource files
32 -R Immediately evaluate the instructions from the default resource
33 file.
34 -r rsc_file
36 Immediately evaluate the instructions from the resource file
37 rsc_file.
38 -- rsc_cmd
40 Evaluate the resource instruction rsc_cmd.
41 Input file
43 -i bib_file
44 Add the BibTeX database file bib_file to the list of input
45 files. If -i omitted the file name may not start with a -. If
46 absent stdin is taken to read from. Input files should follow
47 the bibtex(1) conventions.
48 Output file
50 -o output_file
51 Direct output to the file output_file. If absent the output is
52 directed to stdout.
53 Status reporting
55 -q Suppress warnings. Errors can not be suppressed.
56 -v Enable informative messages on the activities of BibTool.
58 Sorting
60 -s Enable sorting of entries.
61 -S Enable sorting of entries in reverse order.
63 -A type
65 Determine key disambuguation; type in 0, a, A.
66 Selecting items
68 -x aux_file
69 Extract the entries from the auxiliary (.aux) LaTeX aux_file
70 file.
71 -X regex
73 Select certain entries according to the regular expression
74 regex.
75 -c Turn on the additional selection of crossreferenced entries.
77 Key generation
79 -f key_format
80 Set the specification for key generation to key_format.
81 -F Turn on key generation.
83 -k Generate short format keys.
85 -K Generate long format keys.
87 Semantic checks
89 -d Find and mark (or delete) entries with identical sort keys.
90 Strings/Macros
92 -m mac_file
93 Write the macro definitions to the file mac_file (- is stdout).
94 -M mac_file
96 Write the used macro definitions to the file mac_file (- is std‐
97 out).
98 Getting help
100 -h Print short help and exit.
101 -V Print version and exit.
103 Statistics
105 -# Print statistics about all known entry types (long).
106 -@ Print statistics about the used entry types only (short).
108
110 BIBINPUTS
111 Search path for BibTeX database (.bib) files.
112 BIBTOOL
114 Search path for BibTool resource (.rsc) files.
115 BIBTOOLRSC
117 List of resource file names separated by colon.
118
120 ./.bibtoolrsc
121 The default current directory BibTool resource file.
122 ~/.bibtoolrsc
124 The default individual BibTool resource file.
125 /usr/local/lib/BibTool/*.rsc
127 The BibTool resource files included in the original distribu‐
128 tion.
129
131 bibtex(1), latex(1), tex(1)
132 The BibTool Manual.
133
135 Some arrays are allocated statically which may result in an overflow.
136 Most memory is allocated but not returned to the OS: A garbage collec‐
137 tion algorithm might be integrated in a future release.
138 This man page is updated only occasionally, so it is very likely out of
139 date. For complete, current documentation, refer to the BibTool Manual
140 which is distributed as LaTeX source file (bibtool.tex) in the original
141 BibTool source distribution.
142
144 BibTool is designed and maintained by Gerd Neugebauer.
145 local BIBTOOL(1)