DOKK / manpages / debian 10 / biber / Biber::Config.3pm.en
Biber::Config(3pm) User Contributed Perl Documentation Biber::Config(3pm)

Biber::Config - Configuration items which need to be saved across the
lifetime of a Biber object

  This class contains a static object and static methods to access
  configuration and state data. There are several classes of data in here
  which have separate accessors:
  * Biber options
  * Biblatex options
  * State information used by Biber as it processes entries
  * displaymode date

    Reset internal hashes to defaults.

    Initialise default options, optionally with config file as argument

Returns the full path of the Biber configuration file. If returns the first file found among:

  • "biber.conf" in the current directory
  • "$HOME/.biber.conf"
  • "$ENV{XDG_CONFIG_HOME}/biber/biber.conf"
  • "$HOME/Library/biber/biber.conf" (Mac OSX only)
  • "$ENV{APPDATA}/biber.conf" (Windows only)
  • the output of "kpsewhich biber.conf" (if available on the system).

If no file is found, it returns "undef".

    Track uniqueness ignore settings found in inheritance data

    Retrieve uniqueness ignore settings found in inheritance data

    Place to postprocess biber options when they have been
    gathered from all the possible places that set them

    Sets the data model information object

    Gets the data model information object

    Sets the datamodel helper lists

    Stores the path to the control file

    Retrieved the path to the control file

    Store a Biber config option

    Get a Biber option

    Store a Biber command-line option

    Store a Biber config-file option

    Check if an option is explicitly set by user on the command
    line

    Check if an option is explicitly set by user in their
    config file

    Check if an option is explicitly set by user on the command
    line or in the config file

    Set a biblatex option on the appropriate scope

    Get a biblatex option from the global, per-type or per entry scope
    getblxoption('option', ['entrytype'], ['citekey'])
    Returns the value of option. In order of decreasing preference, returns:
    1. Biblatex option defined for entry
    2. Biblatex option defined for entry type
    3. Biblatex option defined globally

    Get all per-entry options for an entry

   Record node and arc connection types for .dot output

    Return an inheritance graph data structure for an inheritance type

  Record a parent->child set relationship

  Record a child->parent set relationship

  Return a boolean saying if there is a parent->child set relationship

  Return a boolean saying if there is a child->parent set relationship

  Return a list of children for a parent set

  Return a list of parents for a child of a set

    Record that $target inherited information from $source
    Can be used for crossrefs and xdata. This just records that an entry
    inherited from another entry, for loop detection.

    Check if $target directly inherited information from $source
    Can be used for crossrefs and xdata

  Checks for an inheritance path from entry $e1 to $e2
  Can be used for crossrefs and xdata

[
{s => 'A',
t => 'B'},
{s => 'A',
t => 'E'},
{s => 'B',
t => 'C'},
{s => 'C',
t => 'D'} ];

  Set some key order information

  Get some key order information

  Get maximum key order number for a section

  Reset keyorder - for use in tests where we switch to allkeys

    Get the count of a key

    Increment the seen count of a key

    Return ref to array of keys which are crossref targets

    Return ref to array of keys which are xref targets

    Return an integer representing the number of times a
    crossref target key has been ref'ed

    Return an integer representing the number of times a
    xref target key has been ref'ed

    Remove a crossref target key from the crossrefkeys state

    Remove a xref target key from the xrefkeys state

    Increment the crossreferences count for a target crossref key

    Increment the xreferences count for a target xref key

    Dump config information (for debugging)

Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at kime.org.uk>"

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

Copyright 2009-2018 Francois 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.

2019-02-28 perl v5.28.1