1BIBER(1)              User Contributed Perl Documentation             BIBER(1)
2
3
4

NAME

6       "biber" - A bibtex replacement for users of biblatex
7

SYNOPSIS

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

DESCRIPTION

23       "biber" provides a replacement of the bibtex processor for users of
24       biblatex.
25

OPTIONS

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       --namesep=[sep]
141           Use sep as the separator for BibTeX data source name fields.
142           Defaults to BibTeX's usual 'and'.
143
144       --no-bblxml-schema
145           When writing bblxml output, don't generate an RNG XML schema from
146           the data model.
147
148       --no-bltxml-schema
149           When reading or writing biblatexml data sources, don't generate an
150           RNG XML schema from the data model.
151
152       --noconf
153           Don't look for a configfile.
154
155       --nodieonerror
156           Don't exit on errors, just log and continue as far as possible.
157           This can be useful if the error is something from, for example, the
158           underlying BibTeX parsing C library which can complain about
159           parsing errors which can be ignored.
160
161       --nolog
162           Do not write any logfile.
163
164       --nostdmacros
165           Don't automatically define any standard macros like month
166           abbreviations.  If you also define these yourself, this option can
167           be used to suppress macro redefinition warnings.
168
169       --noxname
170           Disable exended name processing in bibtex data sources. Can be
171           useful if you don't use this and it causes problems due to auto-
172           detection of extended name format.
173
174       --onlylog
175           Do not write any message to screen.
176
177       --others-string=[string]
178           Use string as the final name in a name field which implies "et al".
179           Defaults to BibTeX's usual 'others'.
180
181       --output-align
182           Align field values in neat columns in output. Effect depends on the
183           output format. Default is false.  The legacy option --tool_align is
184           supported as an alias.
185
186       --output-annotation-marker=[marker]
187           As --annotation-marker but for tool mode bibtex output. The default
188           is "+an".
189
190       --output-directory [directory]
191           Output files (including log files) are output to directory instead
192           of the current directory. Input files are also looked for in
193           directory before current directory (but after "--input_directory"
194           if that is specified).
195
196       --output-encoding|-E [encoding]
197           Specify the encoding of the output ".bbl" file. Default is "UTF-8".
198           Normally it's not necessary to set this as it's passed via the .bcf
199           file from biblatex's "texencoding" option.  See "perldoc
200           Encode::Supported" for a list of supported encodings.  The legacy
201           option --bblencoding is supported as an alias.
202
203       --output-indent=[num]
204           Indentation for body of entries in output. Effect depends on the
205           output format. Defaults to 2.  The legacy option --tool_indent is
206           supported as an alias.
207
208       --output-fieldcase=upper|lower|title
209           Case for field names output. Effect depends on the output format.
210           Defaults to 'upper'.  The legacy option --tool_fieldcase is
211           supported as an alias.
212
213       --output-field-order=[field1, ... fieldn]
214           When outputting bibtex format data in tool mode, this option allows
215           the customisation of the order of fields within entries. The value
216           is a comma-separated string of field names or classes of fields.
217           Fields not mentioned in the list are output in sorted name order
218           after the explicitly specified fields. The classes of fields are:
219
220           'names' - All name list fields 'lists' - All non-name list fields
221           'dates' - All date fields
222
223           By default, its value is 'options,abstract,names,lists,dates'.
224
225       --output-file|-O [file]
226           Output to file instead of basename.bbl file is relative to
227           --output_directory, if set (absolute paths in this case are
228           stripped to filename only). file can be absolute if
229           --output_directory is not set. file can be '-' to output directly
230           to STDOUT. The legacy option --outfile is supported as an alias.
231
232       --output-format=dot|bibtex|biblatexml|bbl|bblxml
233           Biber output format. Default if not specified is of course, bbl.
234           Use dot to output a GraphViz DOT file instead of .bbl. This is a
235           directed graph of the bibliography data showing entries and, as
236           requested, sections and fields.  You must process this file with
237           "dot", e.g. "dot -Tsvg test.dot -o test.svg" to render the graph.
238           See the --dot_include option to select what is included in the DOT
239           output. bblxml is an XML version of the bbl format which you could
240           transform using XSLT. By default, when outputting bblxml, a RelaxNG
241           XML schema is generated from the active data modeal and saved with
242           a rng extension along with the output file name (unless the
243           --no-bblxml-schema option is specified). You may validate the
244           bblxml using the schema with the --validate-bblxml option.  The
245           legacy option --outformat is supported as an alias.
246
247       --output-listsep=[sep]
248           As --listsep but for tool mode bibtex output. Defaults to BibTeX's
249           usual 'and'.
250
251       --output-macro-fields=[field1, ... fieldn]
252           A comma-separated list of field names whose values are, on output,
253           treated as BibTeX macros.  Effectively this means that they are not
254           wrapped in braces. Effect depends on the output format.  The legacy
255           option --tool_macro_fields is supported as an alias.
256
257       --output-namesep=[sep]
258           As --namesep but for tool mode bibtex output. Defaults to BibTeX's
259           usual 'and'.
260
261       --output-resolve
262           Convenience option to set all of the --output-resolve-* options to
263           'true'. The legacy option --tool-resolve is supported as an alias.
264
265       --output-resolve-xdata
266           Whether to resolve XDATA inheritance in tool mode. Defaults to
267           'false'.
268
269       --output-resolve-crossrefs
270           Whether to resolve CROSSREF/XREF inheritance in tool mode. Defaults
271           to 'false'.
272
273       --output-resolve-sets
274           Whether to resolve data sets in tool mode. Defaults to 'false'.
275
276       --output-safechars
277           Try to convert UTF-8 chars into LaTeX macros when writing the
278           output.  This can prevent unknown char errors when using PDFLaTeX
279           and inputenc as this doesn't understand all of UTF-8. Note, it is
280           better to switch to XeTeX or LuaTeX to avoid this situation. By
281           default uses the --output_safecharsset "base" set of characters.
282           The legacy option --bblsafechars is supported as an alias.
283
284       --output-safecharsset=[recode set name]
285           The set of characters included in the conversion routine for
286           --output_safechars. Set to "full" to try harder with a much larger
287           set or "base" to use a basic set. Default is "base" which is fine
288           for most use cases. You may need to load more macro packages to
289           deal with the results of "full" (Dings, Greek characters, special
290           symbols etc.). The recode sets are defined in the reencoding data
291           file which can be customised. See the --recodedata option and the
292           PDF manual.  The legacy option --bblsafecharsset is supported as an
293           alias. The virtual set name "null" may be specified which
294           effectively turns off macro encoding.
295
296       --output-xname
297           When output is a .bib BibTeX file in tool mode, whether to output
298           names the eXtended BibTeX name field format.
299
300       --output-xnamesep=[sep]
301           As --xnamesep but for tool mode bibtex output. Default is '='.
302
303       --quiet|-q
304           Log only errors. If this option is used more than once, don't even
305           log errors.
306
307       --recodedata=[file]
308           The data file to use for the reencoding between UTF-8 and LaTeX
309           macros. It defines the sets specified with the
310           --output_safecharsset and --decodecharsset options.  It defaults to
311           recode_data.xml in the same directory as Biber's Recode.pm module.
312           See the PDF documentation for the format of this file. If this
313           option is used, then file should be somewhere "kpsewhich" can find
314           it.
315
316       --noskipduplicates
317           Don't skip duplicate bibliography keys if found. The detection of
318           duplicate keys is done across all data sources. Sometimes you might
319           need duplicates when using several data sources across several
320           refsections in which case you might need to use this option.
321
322       --sortdebug
323           Add comments to output with sorting keys. Useful for debugging.
324
325       --sortcase=true|false
326           Case-sensitive sorting (default is true).
327
328       --sortlocale|-l [locale]
329           Set the locale to be used for sorting. The locale is used to add
330           CLDR tailoring to the sort (if available for the locale).
331
332       --sortupper=true|false
333           Whether to sort uppercase before lowercase when sorting (default is
334           true).
335
336       --ssl-nointernalca
337           Don't try to use the default Mozilla CA certificates when using
338           HTTPS to fetch remote data.  This assumes that the user will set
339           one of the perl LWP::UserAgent module environment variables to find
340           the CA certs.
341
342       --ssl-noverify-host
343           Turn off host verification when using HTTPS to fetch remote data
344           sources.  You may need this if the SSL certificate is self-signed
345           for example.
346
347       --strip-comments
348           In tool mode, strip all comments from the output file.
349
350       --tool
351           Run in tool mode. This mode is datasource centric rather than
352           document centric. biber reads a datasource (and a config file if
353           specified), applies the command-line and config file options to the
354           datasource and writes a new datasource. Essentially, this allows
355           you to change your data sources using biber's transformation
356           options (such as source mapping, sorting etc.)
357
358       --tool-config
359           Show the location of the default tool mode config file and exit.
360           Useful when you need to copy this file and customise it.
361
362       --trace|T
363           Turn on tracing. Also turns on --debug|d and additionally provides
364           a lot of low-level tracing information in the log.
365
366       -u  Alias for --input-encoding=UTF-8
367
368       -U  Alias for --output-encoding=UTF-8
369
370       --validate-bblxml
371           Schema validate bblXML output against a schema auto-generated from
372           the BibLaTeX datamodel. The schema will be auto-generated with the
373           name of the .bbl file with a .rng extension. The generated schema
374           can be kept and used with standard XML editors to validate the
375           output during XSL development.
376
377       --validate-bltxml
378           Schema validate BibLaTeXML datasources against a schema auto-
379           generated from the BibLaTeX datamodel. The schema will be auto-
380           generated with the name of the .bcf file with a .rng extension. The
381           generated schema can be kept and used with standard XML editors to
382           validate the datasource during datasource development. The schema
383           validation does not validate all semantic aspects of the datamodel
384           (i.e. the data model constraints)---for this use the
385           "--validate-datamodel" option.
386
387       --validate-config
388           Schema validate the biber config file.
389
390       --validate-control
391           Schema validate the .bcf biblatex control file.
392
393       --validate-datamodel|-V
394           Validate the data against a data model.
395
396       --version|-v
397           Display version number.
398
399       --wraplines|-w
400           Wrap lines in the .bbl file.
401
402       --xnamesep=[sep]
403           Use sep as the separator between namepart names and the namepart
404           values in the eXtended name format. See biber docs. Default is '='.
405
406       --xsvsep=[sep]
407           Use sep as the separator for fields of format type "xsv" in the
408           data model. A Perl regexp can be specified. Defaults to a single
409           comma surround by optional whitespace (\s*,\s*).
410

AUTHOR

412       Francois Charette, "firmicus at ankabut.net"
413
414       Philip Kime, "Philip at kime.org.uk"
415

BUGS & DOCUMENTATION

417       To see the full documentation, run texdoc biber or get the biber.pdf
418       manual from SourceForge.
419
420       Please report any bugs or feature requests on our Github tracker at
421       <https://github.com/plk/biber/issues>.
422
424       Copyright 2009-2018 Francois Charette and Philip Kime, all rights
425       reserved.
426
427       This module is free software.  You can redistribute it and/or modify it
428       under the terms of the Artistic License 2.0.
429
430       This program is distributed in the hope that it will be useful, but
431       without any warranty; without even the implied warranty of
432       merchantability or fitness for a particular purpose.
433
434
435
436perl v5.28.1                      2019-02-12                          BIBER(1)
Impressum