.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Biber::Config 3pm" .TH Biber::Config 3pm "2019-02-28" "perl v5.28.1" "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. If returns the first file found among: .IP "\(bu" 4 \&\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/Library/biber/biber.conf\*(C'\fR (Mac \s-1OSX\s0 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 "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(\*(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 .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_set_pc" .IX Subsection "set_set_pc" .Vb 1 \& Record a parent\->child set relationship .Ve .SS "set_set_cp" .IX Subsection "set_set_cp" .Vb 1 \& Record a child\->parent set relationship .Ve .SS "get_set_pc" .IX Subsection "get_set_pc" .Vb 1 \& Return a boolean saying if there is a parent\->child set relationship .Ve .SS "get_set_cp" .IX Subsection "get_set_cp" .Vb 1 \& Return a boolean saying if there is a child\->parent set relationship .Ve .SS "get_set_children" .IX Subsection "get_set_children" .Vb 1 \& Return a list of children for a parent set .Ve .SS "get_set_parents" .IX Subsection "get_set_parents" .Vb 1 \& Return a list of parents for a child of a set .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 some key order information .Ve .SS "get_keyorder" .IX Subsection "get_keyorder" .Vb 1 \& Get some key order information .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 "seenkey" .IX Header "seenkey" .SS "get_seenkey" .IX Subsection "get_seenkey" .Vb 1 \& Get the count of a key .Ve .SS "incr_seenkey" .IX Subsection "incr_seenkey" .Vb 1 \& Increment the seen count of a key .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" Franc\*,ois Charette, \f(CW\*(C`\*(C'\fR Philip Kime \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests on our Github tracker at . .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2009\-2018 Franc\*,ois Charette and 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.