.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Biber::Config 3pm"
.TH Biber::Config 3pm 2024-04-21 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Biber::Config \- Configuration items which need to be saved across the
                lifetime of a Biber object
.PP
.Vb 3
\&  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
.Ve
.SS _init
.IX Subsection "_init"
.Vb 1
\&    Reset internal hashes to defaults.
.Ve
.SS _initopts
.IX Subsection "_initopts"
.Vb 1
\&    Initialise default options, optionally with config file as argument
.Ve
.SS config_file
.IX Subsection "config_file"
Returns the full path of the \fBBiber\fR configuration file.
It returns the first file found among:
.IP \(bu 4
\&\f(CW\*(C`biber.conf\*(C'\fR or \f(CW\*(C`.biber.conf\*(C'\fR in the current directory
.IP \(bu 4
\&\f(CW\*(C`$HOME/.biber.conf\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`$ENV{XDG_CONFIG_HOME}/biber/biber.conf\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`$HOME/.config/biber/biber.conf\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`$HOME/Library/biber/biber.conf\*(C'\fR (Mac OSX only)
.IP \(bu 4
\&\f(CW\*(C`$ENV{APPDATA}/biber.conf\*(C'\fR (Windows only)
.IP \(bu 4
the output of \f(CW\*(C`kpsewhich biber.conf\*(C'\fR (if available on the system).
.PP
If no file is found, it returns \f(CW\*(C`undef\*(C'\fR.
.SS add_uniq_ignore
.IX Subsection "add_uniq_ignore"
.Vb 1
\&    Track uniqueness ignore settings found in inheritance data
.Ve
.SS get_uniq_ignore
.IX Subsection "get_uniq_ignore"
.Vb 1
\&    Retrieve uniqueness ignore settings found in inheritance data
.Ve
.SS postprocess_biber_opts
.IX Subsection "postprocess_biber_opts"
.Vb 2
\&    Place to postprocess biber options when they have been
\&    gathered from all the possible places that set them
.Ve
.SS set_dm
.IX Subsection "set_dm"
.Vb 1
\&    Sets the data model information object
.Ve
.SS get_dm
.IX Subsection "get_dm"
.Vb 1
\&    Gets the data model information object
.Ve
.SS get_dm_helpers
.IX Subsection "get_dm_helpers"
.Vb 1
\&    Sets the datamodel helper lists
.Ve
.SS set_ctrlfile_path
.IX Subsection "set_ctrlfile_path"
.Vb 1
\&    Stores the path to the control file
.Ve
.SS get_ctrlfile_path
.IX Subsection "get_ctrlfile_path"
.Vb 1
\&    Retrieved the path to the control file
.Ve
.SS setoption
.IX Subsection "setoption"
.Vb 1
\&    Store a Biber config option
.Ve
.SS getoption
.IX Subsection "getoption"
.Vb 1
\&    Get a Biber option
.Ve
.SS setcmdlineoption
.IX Subsection "setcmdlineoption"
.Vb 1
\&    Store a Biber command\-line option
.Ve
.SS setconfigfileoption
.IX Subsection "setconfigfileoption"
.Vb 1
\&    Store a Biber config\-file option
.Ve
.SS iscmdlineoption
.IX Subsection "iscmdlineoption"
.Vb 2
\&    Check if an option is explicitly set by user on the command
\&    line
.Ve
.SS isconfigfileoption
.IX Subsection "isconfigfileoption"
.Vb 2
\&    Check if an option is explicitly set by user in their
\&    config file
.Ve
.SS isexplicitoption
.IX Subsection "isexplicitoption"
.Vb 2
\&    Check if an option is explicitly set by user on the command
\&    line or in the config file
.Ve
.SS addtoblxoption
.IX Subsection "addtoblxoption"
.Vb 1
\&    Add to an array global biblatex option
.Ve
.SS setblxoption
.IX Subsection "setblxoption"
.Vb 1
\&    Set a biblatex option on the appropriate scope
.Ve
.SS getblxoption
.IX Subsection "getblxoption"
.Vb 1
\&    Get a biblatex option from the global, per\-type or per entry scope
\&
\&    getblxoption(\*(Aqsecnum\*(Aq, \*(Aqoption\*(Aq, [\*(Aqentrytype\*(Aq], [\*(Aqcitekey\*(Aq])
\&
\&    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
\&
\&    section number needs to be present only for per\-entry options as these might
\&    differ between sections
.Ve
.SS getblxentryoptions
.IX Subsection "getblxentryoptions"
.Vb 1
\&    Get all per\-entry options for an entry
.Ve
.SS set_graph
.IX Subsection "set_graph"
.Vb 1
\&   Record node and arc connection types for .dot output
.Ve
.SS get_graph
.IX Subsection "get_graph"
.Vb 1
\&    Return an inheritance graph data structure for an inheritance type
.Ve
.SS set_inheritance
.IX Subsection "set_inheritance"
.Vb 3
\&    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.
.Ve
.SS get_inheritance
.IX Subsection "get_inheritance"
.Vb 2
\&    Check if $target directly inherited information from $source
\&    Can be used for crossrefs and xdata
.Ve
.SS is_inheritance_path
.IX Subsection "is_inheritance_path"
.Vb 2
\&  Checks for an inheritance path from entry $e1 to $e2
\&  Can be used for crossrefs and xdata
.Ve
.PP
[
             {s => 'A',
              t => 'B'},
             {s => 'A',
              t => 'E'},
             {s => 'B',
              t => 'C'},
             {s => 'C',
              t => 'D'}
];
.SH keyorder
.IX Header "keyorder"
.SS set_keyorder
.IX Subsection "set_keyorder"
.Vb 1
\&  Set key order information
.Ve
.SS set_internal_keyorder
.IX Subsection "set_internal_keyorder"
.Vb 1
\&  Set key order information for keys with the same order
.Ve
.SS get_keyorder
.IX Subsection "get_keyorder"
.Vb 1
\&  Get key order information
.Ve
.SS get_internal_keyorder
.IX Subsection "get_internal_keyorder"
.Vb 1
\&  Get key order information for keys with the same order
.Ve
.SS get_keyorder_max
.IX Subsection "get_keyorder_max"
.Vb 1
\&  Get maximum key order number for a section
.Ve
.SS reset_keyorder
.IX Subsection "reset_keyorder"
.Vb 1
\&  Reset keyorder \- for use in tests where we switch to allkeys
.Ve
.SH crossrefkeys
.IX Header "crossrefkeys"
.SS get_crossrefkeys
.IX Subsection "get_crossrefkeys"
.Vb 1
\&    Return ref to array of keys which are crossref targets
.Ve
.SH xrefkeys
.IX Header "xrefkeys"
.SS get_xrefkeys
.IX Subsection "get_xrefkeys"
.Vb 1
\&    Return ref to array of keys which are xref targets
.Ve
.SS get_crossrefkey
.IX Subsection "get_crossrefkey"
.Vb 2
\&    Return an integer representing the number of times a
\&    crossref target key has been ref\*(Aqed
.Ve
.SS get_xrefkey
.IX Subsection "get_xrefkey"
.Vb 2
\&    Return an integer representing the number of times a
\&    xref target key has been ref\*(Aqed
.Ve
.SS del_crossrefkey
.IX Subsection "del_crossrefkey"
.Vb 1
\&    Remove a crossref target key from the crossrefkeys state
.Ve
.SS del_xrefkey
.IX Subsection "del_xrefkey"
.Vb 1
\&    Remove a xref target key from the xrefkeys state
.Ve
.SS incr_crossrefkey
.IX Subsection "incr_crossrefkey"
.Vb 1
\&    Increment the crossreferences count for a target crossref key
.Ve
.SS incr_xrefkey
.IX Subsection "incr_xrefkey"
.Vb 1
\&    Increment the xreferences count for a target xref key
.Ve
.SS dump
.IX Subsection "dump"
.Vb 1
\&    Dump config information (for debugging)
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
Philip Kime \f(CW\*(C`<philip at kime.org.uk>\*(C'\fR
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests on our Github tracker at
<https://github.com/plk/biber/issues>.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2012\-2024 Philip Kime, all rights reserved.
.PP
This module is free software.  You can redistribute it and/or
modify it under the terms of the Artistic License 2.0.
.PP
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.