1BIBER(1) User Contributed Perl Documentation BIBER(1)
2
3
4
6 "biber" - A bibtex replacement for users of biblatex
7
9 biber [options] file[.bcf]
10 biber [options] --tool <datasource>
11
12 Creates "file.bbl" using control file "file.bcf" (".bcf" extension is
13 optional). Normally use with biblatex requires no options as they are
14 all set in biblatex and passed via the ".bcf" file
15
16 In "tool" mode (see B<--tool> option), takes a datasource (defaults to
17 "bibtex" datasource) and outputs a copy of the datasource with any command-line
18 or config file options applied.
19
20 Please run "biber --help" for option details
21
23 "biber" provides a replacement of the bibtex processor for users of
24 biblatex.
25
27 --annotation-marker=[marker]
28 Sets the suffix which can be appended to a BibTeX data source field
29 name to indicate that the value of the field is a data annotation.
30 The default is "+an".
31
32 --cache
33 If running as a PAR::Packer binary, show the cache location and
34 exit.
35
36 --clrmacros
37 Clears any BibTeX macros (@STRING) between BibLaTeX refsections.
38 This prevents BibTeX warnings about macro redefinitions if you are
39 using the same datasource several times for different refsections.
40
41 --collate-options|-c [options]
42 Options to pass to the "Unicode::Collate" object used for sorting
43 (default is 'level => "4", variable => "non-ignorable"'). See
44 "perldoc Unicode::Collate" for details.
45
46 --configfile|-g [file]
47 Use file as configuration file for "biber". The default is the
48 first file found among biber.conf in the current directory,
49 "$HOME/.biber.conf", or else the output of "kpsewhich biber.conf".
50 In tool mode, (--tool) the biber-tool.conf installed with Biber is
51 always used to set default options if a user-defined config file is
52 not specified. Use the --tool-config option to view the location of
53 the default tool mode config file, copy this file and edit it to
54 your requirements for use with this option. The options in the
55 default config file reflect the options set by biblatex by default.
56
57 --convert-control
58 Converts the .bcf control file into html using an XSLT transform.
59 Can be useful for debugging. File is named by appending ".html" to
60 .bcf file.
61
62 --decodecharsset=[recode set name]
63 The set of characters included in the conversion routine when
64 decoding LaTeX macros into UTF-8 (which happens when
65 --bblencoding|-E is set to UTF-8). Set to "full" to try harder with
66 a much larger set or "base" to use a smaller basic set. Default is
67 "base". You may want to try "full" if you have less common UTF-8
68 characters in your data source. The recode sets are defined in the
69 reencoding data file which can be customised. See the --recodedata
70 option and the PDF manual. The virtual set name "null" may be
71 specified which effectively turns off macro decoding.
72
73 --debug|-D
74 Turn on debugging for "biber".
75
76 --dieondatamodel
77 Exit immediately with error if using "--validate-datamodel" and a
78 datamodel validation error is found. Default is to warn and
79 continue.
80
81 --dot-include=section,field,xdata,crossref,xref,related
82 Specifies the element to include in GraphViz DOT output format if
83 the output format is 'dot'. You can also choose to display
84 crossref, xref, xdata and/or related entry connections. The
85 default if not specified is
86 "--dot_include=section,xdata,crossref,xref".
87
88 --fixinits
89 Try to fix broken multiple initials when they have no space between
90 them in BibTeX data sources. That is, "A.B. Clarke" becomes "A. B.
91 Clarke" before name parsing. This can slightly mess up things like
92 "{U.K. Government}" and other esoteric cases.
93
94 --help|-h
95 Show this help message.
96
97 --input-directory [directory]
98 .bcf and data files will be looked for first in the directory. See
99 the biber PDF documentation for the other possibilities and how
100 this interacts with the "--output_directory" option.
101
102 --input-encoding|-e [encoding]
103 Specify the encoding of the data source file(s). Default is "UTF-8"
104 Normally it's not necessary to set this as it's passed via the .bcf
105 file from biblatex's "bibencoding" option. See "perldoc
106 Encode::Supported" for a list of supported encodings. The legacy
107 option --bibencoding is supported as an alias.
108
109 --input-format=bibtex|biblatexml
110 Biber input format. This option only means something in tool mode
111 (see tool option) since normally the input format of a data source
112 is specified in the .bcf file and therefore from the \addbibresouce
113 macro in BibLaTeX. The default value when in tool mode is 'bibtex'
114
115 --isbn10
116 Force all ISBNs to 10-digit versions on output. This will convert
117 the ISBN internally to an ISBN object which will not have hyphens
118 on output. If you use this option and want an ISBN with hyphens in
119 the correct place on output, use the --isbn-normalise option.
120
121 --isbn13
122 Force all ISBNs to 13-digit versions on output. This will convert
123 the ISBN internally to an ISBN object which will not have hyphens
124 on output. If you use this option and want an ISBN with hyphens in
125 the correct place on output, use the --isbn-normalise option.
126
127 --isbn-normalise
128 Normalise ISBNs with hyphens in the correct places on output.
129
130 --logfile [file]
131 Use file.blg as the name of the logfile.
132
133 --listsep=[sep]
134 Use sep as the separator for BibTeX data source list fields.
135 Defaults to BibTeX's usual 'and'.
136
137 --mincrossrefs|-m [number]
138 Set threshold for crossrefs.
139
140 --named-annotation-marker=[marker]
141 Sets the separator between the "--annotation-marker" and the name
142 of a named annotation. The default is ":".
143
144 --namesep=[sep]
145 Use sep as the separator for BibTeX data source name fields.
146 Defaults to BibTeX's usual 'and'.
147
148 --no-bblxml-schema
149 When writing bblxml output, don't generate an RNG XML schema from
150 the data model.
151
152 --no-bltxml-schema
153 When reading or writing biblatexml data sources, don't generate an
154 RNG XML schema from the data model.
155
156 --noconf
157 Don't look for a configfile.
158
159 --nodieonerror
160 Don't exit on errors, just log and continue as far as possible.
161 This can be useful if the error is something from, for example, the
162 underlying BibTeX parsing C library which can complain about
163 parsing errors which can be ignored.
164
165 --nolog
166 Do not write any logfile.
167
168 --noskipduplicates
169 Don't skip duplicate bibliography keys if found. The detection of
170 duplicate keys is done across all data sources. Sometimes you might
171 need duplicates when using several data sources across several
172 refsections in which case you might need to use this option.
173
174 --nostdmacros
175 Don't automatically define any standard macros like month
176 abbreviations. If you also define these yourself, this option can
177 be used to suppress macro redefinition warnings.
178
179 --noremove-tmp-dir
180 Do not remove the temporary directory used for various intermediate
181 files and data before exit (default is false). Name of the
182 directory can be obtained with the --show-tmp-dir option.
183
184 --noxname
185 Disable exended name processing in bibtex data sources. Can be
186 useful if you don't use this and it causes problems due to auto-
187 detection of extended name format.
188
189 --onlylog
190 Do not write any message to screen.
191
192 --others-string=[string]
193 Use string as the final name in a name field which implies "et al".
194 Defaults to BibTeX's usual 'others'.
195
196 --output-align
197 Align field values in neat columns in output. Effect depends on the
198 output format. Default is false. The legacy option --tool_align is
199 supported as an alias.
200
201 --output-annotation-marker=[marker]
202 As --annotation-marker but for tool mode bibtex output. The default
203 is "+an".
204
205 --output-named-annotation-marker=[marker]
206 As --named-annotation-marker but for tool mode bibtex output. The
207 default is ":".
208
209 --output-directory [directory]
210 Output files (including log files) are output to directory instead
211 of the current directory. Input files are also looked for in
212 directory before current directory (but after "--input_directory"
213 if that is specified).
214
215 --output-encoding|-E [encoding]
216 Specify the encoding of the output ".bbl" file. Default is "UTF-8".
217 Normally it's not necessary to set this as it's passed via the .bcf
218 file from biblatex's "texencoding" option. See "perldoc
219 Encode::Supported" for a list of supported encodings. The legacy
220 option --bblencoding is supported as an alias.
221
222 --output-indent=[num]
223 Indentation for body of entries in output. Effect depends on the
224 output format. Defaults to 2. The legacy option --tool_indent is
225 supported as an alias.
226
227 --output-fieldcase=upper|lower|title
228 Case for field names output. Effect depends on the output format.
229 Defaults to 'upper'. The legacy option --tool_fieldcase is
230 supported as an alias.
231
232 --output-field-order=[field1, ... fieldn]
233 When outputting bibtex format data in tool mode, this option allows
234 the customisation of the order of fields within entries. The value
235 is a comma-separated string of field names or classes of fields.
236 Fields not mentioned in the list are output in sorted name order
237 after the explicitly specified fields. The classes of fields are:
238
239 'names' - All name list fields 'lists' - All non-name list fields
240 'dates' - All date fields
241
242 By default, its value is 'options,abstract,names,lists,dates'.
243
244 --output-file|-O [file]
245 Output to file instead of basename.bbl file is relative to
246 --output_directory, if set (absolute paths in this case are
247 stripped to filename only). file can be absolute if
248 --output_directory is not set. file can be '-' to output directly
249 to STDOUT. The legacy option --outfile is supported as an alias.
250
251 --output-format=dot|bibtex|biblatexml|bbl|bblxml
252 Biber output format. Default if not specified is of course, bbl.
253 Use dot to output a GraphViz DOT file instead of .bbl. This is a
254 directed graph of the bibliography data showing entries and, as
255 requested, sections and fields. You must process this file with
256 "dot", e.g. "dot -Tsvg test.dot -o test.svg" to render the graph.
257 See the --dot_include option to select what is included in the DOT
258 output. bblxml is an XML version of the bbl format which you could
259 transform using XSLT. By default, when outputting bblxml, a RelaxNG
260 XML schema is generated from the active data modeal and saved with
261 a rng extension along with the output file name (unless the
262 --no-bblxml-schema option is specified). You may validate the
263 bblxml using the schema with the --validate-bblxml option. The
264 legacy option --outformat is supported as an alias.
265
266 --output-listsep=[sep]
267 As --listsep but for tool mode bibtex output. Defaults to BibTeX's
268 usual 'and'.
269
270 --output-macro-fields=[field1, ... fieldn]
271 A comma-separated list of field names whose values are, on output,
272 treated as BibTeX macros. Effectively this means that they are not
273 wrapped in braces. Effect depends on the output format. The legacy
274 option --tool_macro_fields is supported as an alias.
275
276 --output-namesep=[sep]
277 As --namesep but for tool mode bibtex output. Defaults to BibTeX's
278 usual 'and'.
279
280 --output-resolve
281 Convenience option to set all of the --output-resolve-* options to
282 'true'. The legacy option --tool-resolve is supported as an alias.
283
284 --output-resolve-xdata
285 Whether to resolve XDATA inheritance in tool mode. Defaults to
286 'false'.
287
288 --output-resolve-crossrefs
289 Whether to resolve CROSSREF/XREF inheritance in tool mode. Defaults
290 to 'false'.
291
292 --output-resolve-sets
293 Whether to resolve data sets in tool mode. Defaults to 'false'.
294
295 --output-safechars
296 Try to convert UTF-8 chars into LaTeX macros when writing the
297 output. This can prevent unknown char errors when using PDFLaTeX
298 and inputenc as this doesn't understand all of UTF-8. Note, it is
299 better to switch to XeTeX or LuaTeX to avoid this situation. By
300 default uses the --output_safecharsset "base" set of characters.
301 The legacy option --bblsafechars is supported as an alias.
302
303 --output-safecharsset=[recode set name]
304 The set of characters included in the conversion routine for
305 --output_safechars. Set to "full" to try harder with a much larger
306 set or "base" to use a basic set. Default is "base" which is fine
307 for most use cases. You may need to load more macro packages to
308 deal with the results of "full" (Dings, Greek characters, special
309 symbols etc.). The recode sets are defined in the reencoding data
310 file which can be customised. See the --recodedata option and the
311 PDF manual. The legacy option --bblsafecharsset is supported as an
312 alias. The virtual set name "null" may be specified which
313 effectively turns off macro encoding.
314
315 --output-xdatamarker=[marker]
316 As --xdatamarker but for tool mode output. Default is 'xdata'.
317
318 --output-xdatasep=[sep]
319 As --xdatasep but for tool mode output. Default is '-'.
320
321 --output-xname
322 When output is a .bib BibTeX file in tool mode, whether to output
323 names the eXtended BibTeX name field format.
324
325 --output-xnamesep=[sep]
326 As --xnamesep but for tool mode bibtex output. Default is '='.
327
328 --quiet|-q
329 Log only errors. If this option is used more than once, don't even
330 log errors.
331
332 --recodedata=[file]
333 The data file to use for the reencoding between UTF-8 and LaTeX
334 macros. It defines the sets specified with the
335 --output_safecharsset and --decodecharsset options. It defaults to
336 recode_data.xml in the same directory as Biber's Recode.pm module.
337 See the PDF documentation for the format of this file. If this
338 option is used, then file should be somewhere "kpsewhich" can find
339 it.
340
341 --show-tmp-dir
342 Prints the location of the temporary directory used for various
343 intermediate files and data. Only useful if --remove-tmp-dir is set
344 to true.
345
346 --sortdebug
347 Add comments to output with sorting keys. Useful for debugging.
348
349 --sortcase=true|false
350 Case-sensitive sorting (default is true).
351
352 --sortlocale|-l [locale]
353 Set the locale to be used for sorting. The locale is used to add
354 CLDR tailoring to the sort (if available for the locale).
355
356 --sortupper=true|false
357 Whether to sort uppercase before lowercase when sorting (default is
358 true).
359
360 --ssl-nointernalca
361 Don't try to use the default Mozilla CA certificates when using
362 HTTPS to fetch remote data. This assumes that the user will set
363 one of the perl LWP::UserAgent module environment variables to find
364 the CA certs.
365
366 --ssl-noverify-host
367 Turn off host verification when using HTTPS to fetch remote data
368 sources. You may need this if the SSL certificate is self-signed
369 for example.
370
371 --strip-comments
372 In tool mode, strip all comments from the output file.
373
374 --tool
375 Run in tool mode. This mode is datasource centric rather than
376 document centric. biber reads a datasource (and a config file if
377 specified), applies the command-line and config file options to the
378 datasource and writes a new datasource. Essentially, this allows
379 you to change your data sources using biber's transformation
380 options (such as source mapping, sorting etc.)
381
382 --tool-config
383 Show the location of the default tool mode config file and exit.
384 Useful when you need to copy this file and customise it.
385
386 --tool-noremove-missing-dependants
387 Use this option in tool mode if you don't want to remove "XREF",
388 "CROSSREF" and "XDATA" fields from the output which point to a
389 missing entry. Useful if you have split datafiles where the e.g.
390 "CROSSREF"s are in another file that you are not including in the
391 tool mode run.
392
393 --trace|T
394 Turn on tracing. Also turns on --debug|d and additionally provides
395 a lot of low-level tracing information in the log.
396
397 -u Alias for --input-encoding=UTF-8
398
399 -U Alias for --output-encoding=UTF-8
400
401 --validate-bblxml
402 Schema validate bblXML output against a schema auto-generated from
403 the BibLaTeX datamodel. The schema will be auto-generated with the
404 name of the .bbl file with a .rng extension. The generated schema
405 can be kept and used with standard XML editors to validate the
406 output during XSL development.
407
408 --validate-bltxml
409 Schema validate BibLaTeXML datasources against a schema auto-
410 generated from the BibLaTeX datamodel. The schema will be auto-
411 generated with the name of the .bcf file with a .rng extension. The
412 generated schema can be kept and used with standard XML editors to
413 validate the datasource during datasource development. The schema
414 validation does not validate all semantic aspects of the datamodel
415 (i.e. the data model constraints)---for this use the
416 "--validate-datamodel" option.
417
418 --validate-config
419 Schema validate the biber config file.
420
421 --validate-control
422 Schema validate the .bcf biblatex control file.
423
424 --validate-datamodel|-V
425 Validate the data against a data model.
426
427 --version|-v
428 Display version number.
429
430 --wraplines|-w
431 Wrap lines in the .bbl file.
432
433 --xdatamarker=[marker]
434 Use marker as the string before "--xdatasep" which introduces an
435 XDATA reference in BibTeX format data sources. Not used in
436 BibLaTeXML data sources as it has a dedicated XML attribute
437 "xdata"' for this. Default is 'xdata'.
438
439 --xdatasep=[sep]
440 Use sep as the separator between XDATA sub-entry parts in the
441 eXtended name format. See biber docs. Default is '-'.
442
443 --xnamesep=[sep]
444 Use sep as the separator between namepart names and the namepart
445 values in the eXtended name format. Also applies to XDATA
446 references as the separator between "--xdatamarker" and the XDATA
447 reference. See biber docs. Default is '='.
448
449 --xsvsep=[sep]
450 Use sep as the separator for fields of format type "xsv" in the
451 data model. A Perl regexp can be specified. Defaults to a single
452 comma surround by optional whitespace (\s*,\s*).
453
455 Philip Kime, "Philip at kime.org.uk"
456
458 To see the full documentation, run texdoc biber or get the biber.pdf
459 manual from SourceForge.
460
461 Please report any bugs or feature requests on our Github tracker at
462 <https://github.com/plk/biber/issues>.
463
465 Copyright 2009-2012 Francois Charette and Philip Kime, all rights
466 reserved. Copyright 2012-2019 Philip Kime, all rights reserved.
467
468 This module is free software. You can redistribute it and/or modify it
469 under the terms of the Artistic License 2.0.
470
471 This program is distributed in the hope that it will be useful, but
472 without any warranty; without even the implied warranty of
473 merchantability or fitness for a particular purpose.
474
475
476
477perl v5.32.1 2021-05-18 BIBER(1)