1BIBER(1) User Contributed Perl Documentation BIBER(1)
2
6 "biber" - A bibtex replacement for users of biblatex
7
9 biber [options] file[.bcf]
10 biber [options] --tool <datasource>
11 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 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 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 --cache
33 If running as a PAR::Packer binary, show the cache location and
34 exit.
35 --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 --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 --configfile|-g [file]
47 Use file as the configuration file for "biber" instead of looking
48 in the default locations (see "biber" PDF manual). In tool mode,
49 (--tool) the biber-tool.conf installed with Biber is always used to
50 set default options if a user-defined config file is not specified.
51 Use the --tool-config option to view the location of the default
52 tool mode config file--copy this file and edit it to your
53 requirements for use with this option in tool mode.
54 --convert-control
56 Converts the .bcf control file into html using an XSLT transform.
57 Can be useful for debugging. File is named by appending ".html" to
58 .bcf file.
59 --decodecharsset=[recode set name]
61 The set of characters included in the conversion routine when
62 decoding LaTeX macros into UTF-8 (which happens when
63 --bblencoding|-E is set to UTF-8). Set to "full" to try harder with
64 a much larger set or "base" to use a smaller basic set. Default is
65 "base". You may want to try "full" if you have less common UTF-8
66 characters in your data source. The recode sets are defined in the
67 reencoding data file which can be customised. See the --recodedata
68 option and the PDF manual. The virtual set name "null" may be
69 specified which effectively turns off macro decoding.
70 --debug|-D
72 Turn on debugging for "biber".
73 --dieondatamodel
75 Exit immediately with error if using "--validate-datamodel" and a
76 datamodel validation error is found. Default is to warn and
77 continue.
78 --dot-include=section,field,xdata,crossref,xref,related
80 Specifies the element to include in GraphViz DOT output format if
81 the output format is 'dot'. You can also choose to display
82 crossref, xref, xdata and/or related entry connections. The
83 default if not specified is
84 "--dot-include=section,xdata,crossref,xref".
85 --fixinits
87 Try to fix broken multiple initials when they have no space between
88 them in BibTeX data sources. That is, "A.B. Clarke" becomes "A. B.
89 Clarke" before name parsing. This can slightly mess up things like
90 "{U.K. Government}" and other esoteric cases.
91 --help|-h
93 Show this help message.
94 --input-directory [directory]
96 .bcf and data files will be looked for first in the directory. See
97 the biber PDF documentation for the other possibilities and how
98 this interacts with the "--output-directory" option.
99 --input-encoding|-e [encoding]
101 Specify the encoding of the data source file(s). Default is "UTF-8"
102 Normally it's not necessary to set this as it's passed via the .bcf
103 file from biblatex's "bibencoding" option. See "perldoc
104 Encode::Supported" for a list of supported encodings. The legacy
105 option --bibencoding is supported as an alias.
106 --input-format=bibtex|biblatexml
108 Biber input format. This option only means something in tool mode
109 (see tool option) since normally the input format of a data source
110 is specified in the .bcf file and therefore from the \addbibresouce
111 macro in BibLaTeX. The default value when in tool mode is 'bibtex'
112 --isbn10
114 Force all ISBNs to 10-digit versions on output. This will convert
115 the ISBN internally to an ISBN object which will not have hyphens
116 on output. If you use this option and want an ISBN with hyphens in
117 the correct place on output, use the --isbn-normalise option.
118 --isbn13
120 Force all ISBNs to 13-digit versions on output. This will convert
121 the ISBN internally to an ISBN object which will not have hyphens
122 on output. If you use this option and want an ISBN with hyphens in
123 the correct place on output, use the --isbn-normalise option.
124 --isbn-normalise
126 Normalise ISBNs with hyphens in the correct places on output.
127 --logfile [file]
129 Use file.blg as the name of the logfile.
130 --listsep=[sep]
132 Use sep as the separator for BibTeX data source list fields.
133 Defaults to BibTeX's usual 'and'.
134 --mincrossrefs|-m [number]
136 Set threshold for crossrefs.
137 --named-annotation-marker=[marker]
139 Sets the separator between the "--annotation-marker" and the name
140 of a named annotation. The default is ":".
141 --namesep=[sep]
143 Use sep as the separator for BibTeX data source name fields.
144 Defaults to BibTeX's usual 'and'.
145 --no-bblxml-schema
147 When writing bblxml output, don't generate an RNG XML schema from
148 the data model.
149 --no-bltxml-schema
151 When reading or writing biblatexml data sources, don't generate an
152 RNG XML schema from the data model.
153 --noconf
155 Don't look for a configfile.
156 --no-default-datamodel
158 Do not load the default datamodel coming from either the .bcf or,
159 when in tool mode, from the default tool mode config file. Use of
160 this option implies that you will provide a complete datamodel in a
161 config file. This option is useful when you wish to make major
162 modifications to the datamodel because the simple add/modify
163 operations to the default datamodel via a user config file are not
164 enough. For example, to remove things from the default datamodel,
165 you would use this option and supply a complete, reduced datamodel
166 in the user config file.
167 --nodieonerror
169 Don't exit on errors, just log and continue as far as possible.
170 This can be useful if the error is something from, for example, the
171 underlying BibTeX parsing C library which can complain about
172 parsing errors which can be ignored.
173 --glob-datasources
175 By default, glob (expand according to pattern) any data source
176 filenames. Allows data sources to be specified like *.bib to load
177 all .bib files in a directory. Can be overriden on a per-dataource
178 basis with the glob option to \addbibresource in biblatex.
179 --nolog
181 Do not write any logfile.
182 --noskipduplicates
184 Don't skip duplicate bibliography keys if found. The detection of
185 duplicate keys is done across all data sources. Sometimes you might
186 need duplicates when using several data sources across several
187 refsections in which case you might need to use this option.
188 --nostdmacros
190 Don't automatically define any standard macros like month
191 abbreviations. If you also define these yourself, this option can
192 be used to suppress macro redefinition warnings.
193 --noremove-tmp-dir
195 Do not remove the temporary directory used for various intermediate
196 files and data before exit (default is false). Name of the
197 directory can be obtained with the --show-tmp-dir option.
198 --noxname
200 Disable exended name processing in bibtex data sources. Can be
201 useful if you don't use this and it causes problems due to auto-
202 detection of extended name format.
203 --onlylog
205 Do not write any message to screen.
206 --others-string=[string]
208 Use string as the final name in a name field which implies "et al".
209 Defaults to BibTeX's usual 'others'.
210 --output-align
212 Align field values in neat columns in output. Effect depends on the
213 output format. Default is false. The legacy option --tool-align is
214 supported as an alias.
215 --output-all-macrodefs
217 When outputting bibtex format, whether to output all found macro
218 (@STRING entries) definitions rather than just definitions for
219 macros which are actually used in the output entries. Default is
220 false.
221 --output-annotation-marker=[marker]
223 As --annotation-marker but for tool mode bibtex output. The default
224 is "+an".
225 --output-named-annotation-marker=[marker]
227 As --named-annotation-marker but for tool mode bibtex output. The
228 default is ":".
229 --output-directory [directory]
231 Output files (including log files) are output to directory instead
232 of the current directory. Input files are also looked for in
233 directory before current directory unless "--input-directory" is
234 also specified in which case input files are only looked for in the
235 directory specified by "--input-directory".
236 --output-encoding|-E [encoding]
238 Specify the encoding of the output ".bbl" file. Default is "UTF-8".
239 Normally it's not necessary to set this as it's passed via the .bcf
240 file from biblatex's "texencoding" option. See "perldoc
241 Encode::Supported" for a list of supported encodings. The legacy
242 option --bblencoding is supported as an alias.
243 --output-fieldcase=upper|lower|title
245 Case for field names output. Effect depends on the output format.
246 Defaults to 'upper'. The legacy option --tool-fieldcase is
247 supported as an alias.
248 --output-field-order=[field1, ... fieldn]
250 When outputting bibtex format data in tool mode, this option allows
251 the customisation of the order of fields within entries. The value
252 is a comma-separated string of field names or classes of fields.
253 Fields not mentioned in the list are output in sorted name order
254 after the explicitly specified fields. The classes of fields are:
255 'names' - All name list fields 'lists' - All non-name list fields
257 'dates' - All date fields
258 By default, its value is 'options,abstract,names,lists,dates'.
260 --output-field-replace=[field1:replacefield1, ... fieldn:replacefieldn]
262 When outputting bibtex format output "replacefieldn" instead of
263 "fieldn". This can be used to output legacy formats which undo the
264 default driver source map e.g
265 --output-field-replace=location:address,journaltitle:journal. See
266 --output-legacy-dates if legacy (YEAR/MONTH) date fields are
267 required in bibtex format output.
268 --output-file|-O [file]
270 Output to file instead of basename.bbl file is relative to
271 --output-directory, if set (absolute paths in this case are
272 stripped to filename only). file can be absolute if
273 --output-directory is not set. file can be '-' to output directly
274 to STDOUT. The legacy option --outfile is supported as an alias.
275 --output-format=dot|bibtex|biblatexml|bbl|bblxml
277 Biber output format. Default if not specified is of course, bbl.
278 Use dot to output a GraphViz DOT file instead of .bbl. This is a
279 directed graph of the bibliography data showing entries and, as
280 requested, sections and fields. You must process this file with
281 "dot", e.g. "dot -Tsvg test.dot -o test.svg" to render the graph.
282 See the --dot-include option to select what is included in the DOT
283 output. bblxml is an XML version of the bbl format which you could
284 transform using XSLT. By default, when outputting bblxml, a RelaxNG
285 XML schema is generated from the active data model and saved with a
286 rng extension along with the output file name (unless the
287 --no-bblxml-schema option is specified). You may validate the
288 bblxml using the schema with the --validate-bblxml option. The
289 legacy option --outformat is supported as an alias.
290 --output-indent=[num]
292 Indentation for body of entries in output. Effect depends on the
293 output format. Defaults to 2. The legacy option --tool-indent is
294 supported as an alias.
295 --output-legacy-dates
297 When outputting bibtex format, output YEAR/MONTH fields instead of
298 DATE. This is not possible if the input is not convertible to
299 legacy format, meaning that any date to be output with legacy
300 fields can only have a YEAR part and perhaps a MONTH part. If a DAY
301 or ENDYEAR part are found, the date is not convertible and the
302 legacy output format will be skipped. Default is false.
303 --output-listsep=[sep]
305 As --listsep but for tool mode bibtex output. Defaults to BibTeX's
306 usual 'and'.
307 --output-namesep=[sep]
309 As --namesep but for tool mode bibtex output. Defaults to BibTeX's
310 usual 'and'.
311 --output-no-macrodefs
313 When outputting BibTeX format, don't output macro definitions
314 (@STRING entries). You might not want to output macro definitions
315 if you keep them in a separate file.
316 --output-resolve
318 Convenience option to set all of the --output-resolve-* options to
319 'true'. The legacy option --tool-resolve is supported as an alias.
320 --output-resolve-xdata
322 Whether to resolve XDATA inheritance in tool mode or when
323 --output-format=bibtex in non tool mode. Defaults to 'false'.
324 --output-resolve-crossrefs
326 Whether to resolve CROSSREF/XREF inheritance in tool mode or when
327 --output-format=bibtex in non tool mode. Defaults to 'false'.
328 --output-resolve-sets
330 Whether to resolve data sets in tool mode or when
331 --output-format=bibtex in non tool mode. Defaults to 'false'.
332 --output-safechars
334 Try to convert UTF-8 chars into LaTeX macros when writing the
335 output. This can prevent unknown char errors when using PDFLaTeX
336 and inputenc as this doesn't understand all of UTF-8. Note, it is
337 better to switch to XeTeX or LuaTeX to avoid this situation. By
338 default uses the --output-safecharsset "base" set of characters.
339 The legacy option --bblsafechars is supported as an alias.
340 --output-safecharsset=[recode set name]
342 The set of characters included in the conversion routine for
343 --output-safechars. Set to "full" to try harder with a much larger
344 set or "base" to use a basic set. Default is "base" which is fine
345 for most use cases. You may need to load more macro packages to
346 deal with the results of "full" (Dings, Greek characters, special
347 symbols etc.). The recode sets are defined in the reencoding data
348 file which can be customised. See the --recodedata option and the
349 PDF manual. The legacy option --bblsafecharsset is supported as an
350 alias. The virtual set name "null" may be specified which
351 effectively turns off macro encoding.
352 --output-xdatamarker=[marker]
354 As --xdatamarker but for tool mode output. Default is 'xdata'.
355 --output-xdatasep=[sep]
357 As --xdatasep but for tool mode output. Default is '-'.
358 --output-xname
360 When output is a .bib BibTeX file in tool mode, whether to output
361 names the eXtended BibTeX name field format.
362 --output-xnamesep=[sep]
364 As --xnamesep but for tool mode bibtex output. Default is '='.
365 --quiet|-q
367 Log only errors. If this option is used more than once, don't even
368 log errors.
369 --recodedata=[file]
371 The data file to use for the reencoding between UTF-8 and LaTeX
372 macros. It defines the sets specified with the
373 --output-safecharsset and --decodecharsset options. It defaults to
374 recode_data.xml in the same directory as Biber's Recode.pm module.
375 See the PDF documentation for the format of this file. If this
376 option is used, then file should be somewhere "kpsewhich" can find
377 it.
378 --show-tmp-dir
380 Prints the location of the temporary directory used for various
381 intermediate files and data. Only useful if --noremove-tmp-dir is
382 set to true.
383 --sortdebug
385 Add comments to output with sorting keys. Useful for debugging.
386 --sortcase=true|false
388 Case-sensitive sorting (default is true).
389 --sortlocale|-l [locale]
391 Set the locale to be used for sorting. The locale is used to add
392 CLDR tailoring to the sort (if available for the locale).
393 --sortupper=true|false
395 Whether to sort uppercase before lowercase when sorting (default is
396 true).
397 --ssl-nointernalca
399 Don't try to use the default Mozilla CA certificates when using
400 HTTPS to fetch remote data. This assumes that the user will set
401 one of the perl LWP::UserAgent module environment variables to find
402 the CA certs.
403 --ssl-noverify-host
405 Turn off host verification when using HTTPS to fetch remote data
406 sources. You may need this if the SSL certificate is self-signed
407 for example.
408 --strip-comments
410 In tool mode, strip all comments from the output file.
411 --tool
413 Run in tool mode. This mode is datasource centric rather than
414 document centric. biber reads a datasource (and a config file if
415 specified), applies the command-line and config file options to the
416 datasource and writes a new datasource. Essentially, this allows
417 you to change your data sources using biber's transformation
418 options (such as source mapping, sorting etc.)
419 --tool-config
421 Show the location of the default tool mode config file and exit.
422 Useful when you need to copy this file and customise it.
423 --tool-noremove-missing-dependants
425 Use this option in tool mode if you don't want to remove "XREF",
426 "CROSSREF" and "XDATA" fields from the output which point to a
427 missing entry. Useful if you have split datafiles where the e.g.
428 "CROSSREF"s are in another file that you are not including in the
429 tool mode run.
430 --trace|T
432 Turn on tracing. Also turns on --debug|d and additionally provides
433 a lot of low-level tracing information in the log.
434 -u Alias for --input-encoding=UTF-8
436 -U Alias for --output-encoding=UTF-8
438 --validate-bblxml
440 Schema validate bblXML output against a schema auto-generated from
441 the BibLaTeX datamodel. The schema will be auto-generated with the
442 name of the .bbl file with a .rng extension. The generated schema
443 can be kept and used with standard XML editors to validate the
444 output during XSL development.
445 --validate-bltxml
447 Schema validate BibLaTeXML datasources against a schema auto-
448 generated from the BibLaTeX datamodel. The schema will be auto-
449 generated with the name of the .bcf file with a .rng extension. The
450 generated schema can be kept and used with standard XML editors to
451 validate the datasource during datasource development. The schema
452 validation does not validate all semantic aspects of the datamodel
453 (i.e. the data model constraints)---for this use the
454 "--validate-datamodel" option.
455 --validate-config
457 Schema validate the biber config file.
458 --validate-control
460 Schema validate the .bcf biblatex control file.
461 --validate-datamodel|-V
463 Validate the data against a data model.
464 --version|-v
466 Display version number.
467 --winunicode|-W
469 In Windows 10 1803+, turning on the 'Use Unicode UTF8 for worldwide
470 language support' option makes Windows use UTF-8 instead of UTF-16
471 for many system APIs. If that option is enabled, use this option to
472 turn off biber's UTF-16 filename support on Windows. This will
473 result in much improved handling of Unicode filenames.
474 --wraplines|-w
476 Wrap lines in the .bbl file.
477 --xdatamarker=[marker]
479 Use marker as the string before "--xdatasep" which introduces an
480 XDATA reference in BibTeX format data sources. Not used in
481 BibLaTeXML data sources as it has a dedicated XML attribute
482 "xdata"' for this. Default is 'xdata'.
483 --xdatasep=[sep]
485 Use sep as the separator between XDATA sub-entry parts in the
486 eXtended name format. See biber docs. Default is '-'.
487 --xnamesep=[sep]
489 Use sep as the separator between namepart names and the namepart
490 values in the eXtended name format. Also applies to XDATA
491 references as the separator between "--xdatamarker" and the XDATA
492 reference. See biber docs. Default is '='.
493 --xsvsep=[sep]
495 Use sep as the separator for fields of format type "xsv" in the
496 data model. A Perl regexp can be specified. Defaults to a single
497 comma surround by optional whitespace (\s*,\s*).
498
500 Philip Kime, "Philip at kime.org.uk"
501
503 To see the full documentation, run texdoc biber or get the biber.pdf
504 manual from SourceForge.
505 Please report any bugs or feature requests on our Github tracker at
507 <https://github.com/plk/biber/issues>.
508
510 Copyright 2009-2012 Francois Charette and Philip Kime, all rights
511 reserved. Copyright 2012-2020 Philip Kime, all rights reserved.
512 This module is free software. You can redistribute it and/or modify it
514 under the terms of the Artistic License 2.0.
515 This program is distributed in the hope that it will be useful, but
517 without any warranty; without even the implied warranty of
518 merchantability or fitness for a particular purpose.
519perl v5.34.0 2021-07-21 BIBER(1)