GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  BIBER (1)

.ds Aq ’

NAME

"biber" - A bibtex replacement for users of biblatex

CONTENTS

SYNOPSIS

biber [options] file[.bcf] biber [options] --tool <datasource>



  Creates "file.bbl" using control file "file.bcf" (".bcf" extension is
  optional). Normaly use with biblatex requires no options as they are
  all set in biblatex and passed via the ".bcf" file

  In "tool" mode (see B<--tool> option), takes a datasource (defaults to
  "bibtex" datasource) and outputs a copy of the datasource with any command-line
  or config file options applied.

  Please run "biber --help" for option details



DESCRIPTION

biber provides a replacement of the bibtex processor for users of biblatex.

OPTIONS

<B>--cacheB> If running as a PAR::Packer binary, show the cache location and exit.
<B>--clrmacrosB> Clears any BibTeX macros (@STRING) between BibLaTeX refsections. This prevents BibTeX warnings about macro redefinitions if you are using the same datasource several times for different refsections.
<B>--collate|-CB> Sort with Unicode::Collate instead of the built-in sort function. This is the default.
<B>--collate-options|-c [options]B> Options to pass to the Unicode::Collate object used for sorting (default is ’level => 4, variable => non-ignorable’). See perldoc Unicode::Collate for details.
<B>--configfile|-g [file]B> Use file as configuration file for biber. The default is the first file found among biber.conf in the current directory, $HOME/.biber.conf, or else the output of kpsewhich biber.conf. In tool mode, (<B>--toolB>) the biber-tool.conf installed with Biber is always used to set defaults before potentially overriding the defaults with a user-defined config specified with this option. Use the <B>--tool-configB> option to view the location of the default tool mode config file.
<B>--convert-controlB> Converts the .bcf control file into html using an XSLT transform. Can be useful for debugging. File is named by appending .html to .bcf file.
<B>--decodecharsset=[recode set name]B> The set of characters included in the conversion routine when decoding LaTeX macros into UTF-8 (which happens when <B>--bblencoding|-EB> is set to UTF-8). Set to full to try harder with a much larger set or base to use a smaller basic set. Default is base. You may want to try full if you have less common UTF-8 characters in your data source. The recode sets are defined in the reencoding data file which can be customised. See the --recodedata option and the PDF manual. The virtual set name null may be specified which effectively turns off macro decoding.
<B>--debug|-DB> Turn on debugging for biber.
<B>--dot-include=section,field,xdata,crossref,xref,relatedB> Specifies the element to include in GraphViz DOT output format if the output format is ’dot’. You can also choose to display crossref, xref, xdata and/or related entry connections. The default if not specified is --dot_include=section,xdata,crossref,xref.
<B>--fastsort|-fB> Use Perl’s sort instead of Unicode::Collate for sorting. Also uses OS locale definitions (which may be broken for some languages ...).
<B>--fixinitsB> Try to fix broken multiple initials when they have no space between them in BibTeX data sources. That is, A.B. Clarke becomes A. B. Clarke before name parsing. This can slightly mess up things like {U.K. Government} and other esoteric cases.
<B>--help|-hB> Show this help message.
<B>--input-directory [directory]B> .bcf and data files will be looked for first in the directory. See the biber PDF documentation for the other possibilities and how this interacts with the --output_directory option.
<B>--input-encoding|-e [encoding]B> Specify the encoding of the data source file(s). Default is UTF-8 Normally it’s not necessary to set this as it’s passed via the .bcf file from biblatex’s bibencoding option. See perldoc Encode::Supported for a list of supported encodings. The legacy option <B>--bibencodingB> is supported as an alias.
<B>--input-format=bibtex|biblatexmlB> Biber input format. This option only means something in tool mode (see <B>toolB> option) since normally the input format of a data source is specified in the .bcf file and therefore from the <B>\addbibresouceB> macro in BibLaTeX. The default value when in tool mode is ’bibtex’
<B>--logfile [file]B> Use file.blg as the name of the logfile.
<B>--listsep=[sep]B> Use sep as the separator for BibTeX data source list fields. Defaults to BibTeX’s usual ’and’.
<B>--mincrossrefs|-m [number]B> Set threshold for crossrefs.
<B>--namesep=[sep]B> Use sep as the separator for BibTeX data source name fields. Defaults to BibTeX’s usual ’and’.
<B>--noconfB> Don’t look for a configfile.
<B>--nodieonerrorB> Don’t exit on errors, just log and continue as far as possible. This can be useful if the error is something from, for example, the underlying BibTeX parsing C library which can complain about parsing errors which can be ignored.
<B>--nologB> Do not write any logfile.
<B>--nostdmacrosB> Don’t automatically define any standard macros like month abbreviations. If you also define these yourself, this option can be used to suppress macro redefinition warnings.
<B>--onlylogB> Do not write any message to screen.
<B>--others-string=[string]B> Use string as the final name in a name field which implies et al. Defaults to BibTeX’s usual ’others’.
<B>--output-alignB> Align field values in neat columns in output. Effect depends on the output format. Default is true. The legacy option <B>--tool_alignB> is supported as an alias.
<B>--output-directory [directory]B> Output files (including log files) are output to directory instead of the current directory. Input files are also looked for in directory before current directory (but after --input_directory if that is specified).
<B>--output-encoding|-E [encoding]B> Specify the encoding of the output .bbl file. Default is UTF-8. Normally it’s not necessary to set this as it’s passed via the .bcf file from biblatex’s texencoding option. See perldoc Encode::Supported for a list of supported encodings. The legacy option <B>--bblencodingB> is supported as an alias.
<B>--output-indent=[num]B> Indentation for body of entries in output. Effect depends on the output format. Defaults to 2. The legacy option <B>--tool_indentB> is supported as an alias.
<B>--output-fieldcase=upper|lower|titleB> Case for field names output. Effect depends on the output format. Defaults to ’upper’. The legacy option <B>--tool_fieldcaseB> is supported as an alias.
<B>--output-file|-O [file]B> Output to file instead of basename.bbl file is relative to <B>--output_directoryB>, if set (absolute paths in this case are stripped to filename only). file can be absolute if <B>--output_directoryB> is not set. The legacy option <B>--outfileB> is supported as an alias.
<B>--output-format=dot|bibtex|biblatexml|bblB> Biber output format. Default if not specified is of course, bbl. Use dot to output a GraphViz DOT file instead of .bbl. This is a directed graph of the bibliography data showing entries and, as requested, sections and fields. You must process this file with dot, e.g. dot -Tsvg test.dot -o test.svg to render the graph. See the <B>--dot_includeB> option to select what is included in the DOT output. The legacy option <B>--outformatB> is supported as an alias.
<B>--output-macro-fields=[field1, ... fieldn]B> A comma-separated list of field names whose values are, on output, treated as BibTeX macros. Effectively this means that they are not wrapped in braces. Effect depends on the output format. The legacy option <B>--tool_macro_fieldsB> is supported as an alias.
<B>--output-resolveB> Whether to resolve aliases and inheritance (XDATA, CROSSREF etc.) in tool mode. Defaults to ’false’. The legacy option <B>--tool_resolveB> is supported as an alias.
<B>--output-safecharsB> Try to convert UTF-8 chars into LaTeX macros when writing the output. This can prevent unknown char errors when using PDFLaTeX and inputenc as this doesn’t understand all of UTF-8. Note, it is better to switch to XeTeX or LuaTeX to avoid this situation. By default uses the --output_safecharsset base set of characters. The legacy option <B>--bblsafecharsB> is supported as an alias.
<B>--output-safecharsset=[recode set name]B> The set of characters included in the conversion routine for --output_safechars. Set to full to try harder with a much larger set or base to use a basic set. Default is base which is fine for most use cases. You may need to load more macro packages to deal with the results of full (Dings, Greek characters, special symbols etc.). The recode sets are defined in the reencoding data file which can be customised. See the --recodedata option and the PDF manual. The legacy option <B>--bblsafecharssetB> is supported as an alias. The virtual set name null may be specified which effectively turns off macro encoding.
<B>--quiet|-qB> Log only errors. If this option is used more than once, don’t even log errors.
<B>--recodedata=[file]B> The data file to use for the reencoding between UTF-8 and LaTeX macros. It defines the sets specified with the --output_safecharsset and --decodecharsset options. It defaults to recode_data.xml in the same directory as Biber’s Recode.pm module. See the PDF documentation for the format of this file. If this option is used, then file should be somewhere kpsewhich can find it.
<B>--sortcase=true|falseB> Case-sensitive sorting (default is true).
<B>--sortfirstinits=true|falseB> When sorting names, use only the first name initials, not full first name. Some people expect the biblatex <B>firstinitsB> option to do this but it needs to be a separate option in case users, for example, need to show only initials but sort with full first names (default is false).
<B>--sortlocale|-l [locale]B> Set the locale to be used for sorting. With default sorting (<B>--collate|-CB>), the locale is used to add CLDR tailoring to the sort (if available for the locale). With <B>--fastsort|-fB> this sets the OS locale for sorting.
<B>--sortupper=true|falseB> Whether to sort uppercase before lowercase when using default sorting (<B>--collate|-CB>). When using <B>--fastsort|-fB>, your OS collation locale determines this and this option is ignored (default is true).
<B>--ssl-nointernalcaB> Don’t try to use the default Mozilla CA certificates when using HTTPS to fetch remote data. This assumes that the user will set one of the perl LWP::UserAgent module environment variables to find the CA certs.
<B>--ssl-noverify-hostB> Turn off host verification when using HTTPS to fetch remote data sources. You may need this if the SSL certificate is self-signed for example.
<B>--toolB> Run in tool mode. This mode is datasource centric rather than document centric. biber reads a datasource (and a config file if specified), applies the command-line and config file options to the datasource and writes a new datasource. Essentially, this allows you to change your data sources using biber’s transformation options (such as source mapping, sorting etc.)
<B>--tool-configB> Show the location of the default tool mode config file and exit. Useful when you need to copy this file and customise it.
<B>--trace|TB> Turn on tracing. Also turns on <B>--debug|dB> and additionally provides a lot of low-level tracing information in the log.
<B>-uB> Alias for <B>--input_encoding=UTF-8B>
<B>-UB> Alias for <B>--output_encoding=UTF-8B>
<B>--validate-configB> Schema validate the biber config file.
<B>--validate-controlB> Schema validate the .bcf biblatex control file.
<B>--validate-datamodel|-VB> Validate the data against a data model.
<B>--version|-vB> Display version number.
<B>--wraplines|-wB> Wrap lines in the .bbl file.
<B>--xsvsep=[sep]B> Use sep as the separator for fields of format type xsv in the data model. A Perl regexp can be specified. Defaults to a single comma surround by optional whitespace (\s*,\s*).

AUTHOR

Franc\k:,ois Charette, firmicus at ankabut.net

Philip Kime, Philip at kime.org.uk

BUGS & DOCUMENTATION

To see the full documentation, run <B>texdoc biberB> or get the biber.pdf manual from SourceForge.

Please report any bugs or feature requests on our Github tracker at <https://github.com/plk/biber/issues>.

COPYRIGHT & LICENSE

Copyright 2009-2015 Franc\k:,ois Charette and Philip Kime, all rights reserved.

This module is free software. You can redistribute it and/or modify it under the terms of the Artistic License 2.0.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

Search for    or go to Top of page |  Section 1 |  Main Index


perl v5.20.3 BIBER (1) 2016-04-05

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.