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 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 --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 --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 --debug|-D
74 Turn on debugging for "biber".
75 --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 --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 --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 --help|-h
95 Show this help message.
96 --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 --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 --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 --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 --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 --isbn-normalise
128 Normalise ISBNs with hyphens in the correct places on output.
129 --logfile [file]
131 Use file.blg as the name of the logfile.
132 --listsep=[sep]
134 Use sep as the separator for BibTeX data source list fields.
135 Defaults to BibTeX's usual 'and'.
136 --mincrossrefs|-m [number]
138 Set threshold for crossrefs.
139 --named-annotation-marker=[marker]
141 Sets the separator between the "--annotation-marker" and the name
142 of a named annotation. The default is ":".
143 --namesep=[sep]
145 Use sep as the separator for BibTeX data source name fields.
146 Defaults to BibTeX's usual 'and'.
147 --no-bblxml-schema
149 When writing bblxml output, don't generate an RNG XML schema from
150 the data model.
151 --no-bltxml-schema
153 When reading or writing biblatexml data sources, don't generate an
154 RNG XML schema from the data model.
155 --noconf
157 Don't look for a configfile.
158 --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 --nolog
166 Do not write any logfile.
167 --nostdmacros
169 Don't automatically define any standard macros like month
170 abbreviations. If you also define these yourself, this option can
171 be used to suppress macro redefinition warnings.
172 --noxname
174 Disable exended name processing in bibtex data sources. Can be
175 useful if you don't use this and it causes problems due to auto-
176 detection of extended name format.
177 --onlylog
179 Do not write any message to screen.
180 --others-string=[string]
182 Use string as the final name in a name field which implies "et al".
183 Defaults to BibTeX's usual 'others'.
184 --output-align
186 Align field values in neat columns in output. Effect depends on the
187 output format. Default is false. The legacy option --tool_align is
188 supported as an alias.
189 --output-annotation-marker=[marker]
191 As --annotation-marker but for tool mode bibtex output. The default
192 is "+an".
193 --output-named-annotation-marker=[marker]
195 As --named-annotation-marker but for tool mode bibtex output. The
196 default is ":".
197 --output-directory [directory]
199 Output files (including log files) are output to directory instead
200 of the current directory. Input files are also looked for in
201 directory before current directory (but after "--input_directory"
202 if that is specified).
203 --output-encoding|-E [encoding]
205 Specify the encoding of the output ".bbl" file. Default is "UTF-8".
206 Normally it's not necessary to set this as it's passed via the .bcf
207 file from biblatex's "texencoding" option. See "perldoc
208 Encode::Supported" for a list of supported encodings. The legacy
209 option --bblencoding is supported as an alias.
210 --output-indent=[num]
212 Indentation for body of entries in output. Effect depends on the
213 output format. Defaults to 2. The legacy option --tool_indent is
214 supported as an alias.
215 --output-fieldcase=upper|lower|title
217 Case for field names output. Effect depends on the output format.
218 Defaults to 'upper'. The legacy option --tool_fieldcase is
219 supported as an alias.
220 --output-field-order=[field1, ... fieldn]
222 When outputting bibtex format data in tool mode, this option allows
223 the customisation of the order of fields within entries. The value
224 is a comma-separated string of field names or classes of fields.
225 Fields not mentioned in the list are output in sorted name order
226 after the explicitly specified fields. The classes of fields are:
227 'names' - All name list fields 'lists' - All non-name list fields
229 'dates' - All date fields
230 By default, its value is 'options,abstract,names,lists,dates'.
232 --output-file|-O [file]
234 Output to file instead of basename.bbl file is relative to
235 --output_directory, if set (absolute paths in this case are
236 stripped to filename only). file can be absolute if
237 --output_directory is not set. file can be '-' to output directly
238 to STDOUT. The legacy option --outfile is supported as an alias.
239 --output-format=dot|bibtex|biblatexml|bbl|bblxml
241 Biber output format. Default if not specified is of course, bbl.
242 Use dot to output a GraphViz DOT file instead of .bbl. This is a
243 directed graph of the bibliography data showing entries and, as
244 requested, sections and fields. You must process this file with
245 "dot", e.g. "dot -Tsvg test.dot -o test.svg" to render the graph.
246 See the --dot_include option to select what is included in the DOT
247 output. bblxml is an XML version of the bbl format which you could
248 transform using XSLT. By default, when outputting bblxml, a RelaxNG
249 XML schema is generated from the active data modeal and saved with
250 a rng extension along with the output file name (unless the
251 --no-bblxml-schema option is specified). You may validate the
252 bblxml using the schema with the --validate-bblxml option. The
253 legacy option --outformat is supported as an alias.
254 --output-listsep=[sep]
256 As --listsep but for tool mode bibtex output. Defaults to BibTeX's
257 usual 'and'.
258 --output-macro-fields=[field1, ... fieldn]
260 A comma-separated list of field names whose values are, on output,
261 treated as BibTeX macros. Effectively this means that they are not
262 wrapped in braces. Effect depends on the output format. The legacy
263 option --tool_macro_fields is supported as an alias.
264 --output-namesep=[sep]
266 As --namesep but for tool mode bibtex output. Defaults to BibTeX's
267 usual 'and'.
268 --output-resolve
270 Convenience option to set all of the --output-resolve-* options to
271 'true'. The legacy option --tool-resolve is supported as an alias.
272 --output-resolve-xdata
274 Whether to resolve XDATA inheritance in tool mode. Defaults to
275 'false'.
276 --output-resolve-crossrefs
278 Whether to resolve CROSSREF/XREF inheritance in tool mode. Defaults
279 to 'false'.
280 --output-resolve-sets
282 Whether to resolve data sets in tool mode. Defaults to 'false'.
283 --output-safechars
285 Try to convert UTF-8 chars into LaTeX macros when writing the
286 output. This can prevent unknown char errors when using PDFLaTeX
287 and inputenc as this doesn't understand all of UTF-8. Note, it is
288 better to switch to XeTeX or LuaTeX to avoid this situation. By
289 default uses the --output_safecharsset "base" set of characters.
290 The legacy option --bblsafechars is supported as an alias.
291 --output-safecharsset=[recode set name]
293 The set of characters included in the conversion routine for
294 --output_safechars. Set to "full" to try harder with a much larger
295 set or "base" to use a basic set. Default is "base" which is fine
296 for most use cases. You may need to load more macro packages to
297 deal with the results of "full" (Dings, Greek characters, special
298 symbols etc.). The recode sets are defined in the reencoding data
299 file which can be customised. See the --recodedata option and the
300 PDF manual. The legacy option --bblsafecharsset is supported as an
301 alias. The virtual set name "null" may be specified which
302 effectively turns off macro encoding.
303 --output-xname
305 When output is a .bib BibTeX file in tool mode, whether to output
306 names the eXtended BibTeX name field format.
307 --output-xnamesep=[sep]
309 As --xnamesep but for tool mode bibtex output. Default is '='.
310 --quiet|-q
312 Log only errors. If this option is used more than once, don't even
313 log errors.
314 --recodedata=[file]
316 The data file to use for the reencoding between UTF-8 and LaTeX
317 macros. It defines the sets specified with the
318 --output_safecharsset and --decodecharsset options. It defaults to
319 recode_data.xml in the same directory as Biber's Recode.pm module.
320 See the PDF documentation for the format of this file. If this
321 option is used, then file should be somewhere "kpsewhich" can find
322 it.
323 --noskipduplicates
325 Don't skip duplicate bibliography keys if found. The detection of
326 duplicate keys is done across all data sources. Sometimes you might
327 need duplicates when using several data sources across several
328 refsections in which case you might need to use this option.
329 --sortdebug
331 Add comments to output with sorting keys. Useful for debugging.
332 --sortcase=true|false
334 Case-sensitive sorting (default is true).
335 --sortlocale|-l [locale]
337 Set the locale to be used for sorting. The locale is used to add
338 CLDR tailoring to the sort (if available for the locale).
339 --sortupper=true|false
341 Whether to sort uppercase before lowercase when sorting (default is
342 true).
343 --ssl-nointernalca
345 Don't try to use the default Mozilla CA certificates when using
346 HTTPS to fetch remote data. This assumes that the user will set
347 one of the perl LWP::UserAgent module environment variables to find
348 the CA certs.
349 --ssl-noverify-host
351 Turn off host verification when using HTTPS to fetch remote data
352 sources. You may need this if the SSL certificate is self-signed
353 for example.
354 --strip-comments
356 In tool mode, strip all comments from the output file.
357 --tool
359 Run in tool mode. This mode is datasource centric rather than
360 document centric. biber reads a datasource (and a config file if
361 specified), applies the command-line and config file options to the
362 datasource and writes a new datasource. Essentially, this allows
363 you to change your data sources using biber's transformation
364 options (such as source mapping, sorting etc.)
365 --tool-config
367 Show the location of the default tool mode config file and exit.
368 Useful when you need to copy this file and customise it.
369 --trace|T
371 Turn on tracing. Also turns on --debug|d and additionally provides
372 a lot of low-level tracing information in the log.
373 -u Alias for --input-encoding=UTF-8
375 -U Alias for --output-encoding=UTF-8
377 --validate-bblxml
379 Schema validate bblXML output against a schema auto-generated from
380 the BibLaTeX datamodel. The schema will be auto-generated with the
381 name of the .bbl file with a .rng extension. The generated schema
382 can be kept and used with standard XML editors to validate the
383 output during XSL development.
384 --validate-bltxml
386 Schema validate BibLaTeXML datasources against a schema auto-
387 generated from the BibLaTeX datamodel. The schema will be auto-
388 generated with the name of the .bcf file with a .rng extension. The
389 generated schema can be kept and used with standard XML editors to
390 validate the datasource during datasource development. The schema
391 validation does not validate all semantic aspects of the datamodel
392 (i.e. the data model constraints)---for this use the
393 "--validate-datamodel" option.
394 --validate-config
396 Schema validate the biber config file.
397 --validate-control
399 Schema validate the .bcf biblatex control file.
400 --validate-datamodel|-V
402 Validate the data against a data model.
403 --version|-v
405 Display version number.
406 --wraplines|-w
408 Wrap lines in the .bbl file.
409 --xnamesep=[sep]
411 Use sep as the separator between namepart names and the namepart
412 values in the eXtended name format. See biber docs. Default is '='.
413 --xsvsep=[sep]
415 Use sep as the separator for fields of format type "xsv" in the
416 data model. A Perl regexp can be specified. Defaults to a single
417 comma surround by optional whitespace (\s*,\s*).
418
420 Francois Charette, "firmicus at ankabut.net"
421 Philip Kime, "Philip at kime.org.uk"
423
425 To see the full documentation, run texdoc biber or get the biber.pdf
426 manual from SourceForge.
427 Please report any bugs or feature requests on our Github tracker at
429 <https://github.com/plk/biber/issues>.
430
432 Copyright 2009-2018 Francois Charette and Philip Kime, all rights
433 reserved.
434 This module is free software. You can redistribute it and/or modify it
436 under the terms of the Artistic License 2.0.
437 This program is distributed in the hope that it will be useful, but
439 without any warranty; without even the implied warranty of
440 merchantability or fitness for a particular purpose.
441perl v5.30.1 2020-01-28 BIBER(1)