[a9ee0599] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[140475a] | 7 | <!--
|
---|
[8558044] | 8 | When a proper url is not evident, github will download with
|
---|
[140475a] | 9 | https://github.com/ <path> /archive/<version>/<name>-<version>.tar.<compression>
|
---|
| 10 |
|
---|
[21007b1b] | 11 | <!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;.tar.gz">
|
---|
[140475a] | 12 | -->
|
---|
| 13 | <!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;/biber-&biber-version;.tar.gz">
|
---|
[21007b1b] | 14 | <!ENTITY biber-download-ftp " ">
|
---|
[372c2fb7] | 15 | <!ENTITY biber-md5sum "5a503052bf88aff12dcef7a2d8a8e4f2">
|
---|
[bc9fa73] | 16 | <!ENTITY biber-size "1.5 MB">
|
---|
[9b514136] | 17 | <!-- Buildsize includes the installed biblatex, except that what matters is
|
---|
| 18 | the difference from the files shipped by texlive, so usually the addition is
|
---|
| 19 | minimal. Copy full texmf to somewhere for working, measure with du -shm,
|
---|
[0b87037d] | 20 | then install biblatex over the top of it and remeasure.
|
---|
[6a1a657] | 21 | For 3.16, texmf grows by 3MB -->
|
---|
[40df807] | 22 | <!ENTITY biber-buildsize "14 MB"> <!-- only include biblatex size if texmf grows -->
|
---|
[bc9fa73] | 23 | <!ENTITY biber-time "0.4 SBU including tests">
|
---|
[9385c0fe] | 24 |
|
---|
[40df807] | 25 | <!-- FIXME - ok to comment biblatex when version for a new year matches
|
---|
| 26 | what is in texmf-dist. For new version, reinstate to avoid runtime error. -->
|
---|
[1740585] | 27 | <!-- Check path. Directory might not be &biblatex-version; if a suffixed update -->
|
---|
[6a1a657] | 28 | <!-- for normal unsuffixed version: e.g. for 3.15a
|
---|
[40df807] | 29 | <!ENTITY biblatex-download-http "https://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz"> -->
|
---|
[c5aa446c] | 30 | <!ENTITY biblatex-download-http "https://sourceforge.net/projects/biblatex/files/biblatex-3.18/biblatex-&biblatex-version;.tds.tgz">
|
---|
[c5a4b23] | 31 | <!ENTITY biblatex-download-ftp "">
|
---|
[40df807] | 32 | <!ENTITY biblatex-md5sum "cd4c996e5ad4431c9f89c6e6c37a38df">
|
---|
| 33 | <!ENTITY biblatex-size "18 MB">
|
---|
| 34 | <!-- this usually overwrites files in texmf-dist¸use du -sm to measure
|
---|
| 35 | before nad after - 'buildsize' might easily be unchanged, or add to biber above -->
|
---|
| 36 | <!-- end the comment-out here when next commenting out biblatex -->
|
---|
[a9ee0599] | 37 | ]>
|
---|
| 38 |
|
---|
| 39 | <sect1 id="biber" xreflabel="biber-&biber-version;">
|
---|
| 40 | <?dbhtml filename="biber.html"?>
|
---|
| 41 |
|
---|
| 42 | <sect1info>
|
---|
| 43 | <date>$Date$</date>
|
---|
| 44 | </sect1info>
|
---|
| 45 |
|
---|
[21007b1b] | 46 | <title>biber-&biber-version;</title>
|
---|
[a9ee0599] | 47 |
|
---|
| 48 | <indexterm zone="biber">
|
---|
| 49 | <primary sortas="a-biber">Biber</primary>
|
---|
| 50 | </indexterm>
|
---|
| 51 |
|
---|
| 52 | <sect2 role="package">
|
---|
| 53 | <title>Introduction to biber</title>
|
---|
| 54 |
|
---|
[fa3edfef] | 55 | <para>
|
---|
| 56 | Biber is a BibTeX replacement for users of biblatex, written in
|
---|
| 57 | <application>Perl</application>, with full Unicode support.
|
---|
| 58 | </para>
|
---|
[a9ee0599] | 59 |
|
---|
[8a2cb97] | 60 | &lfs112_checked;
|
---|
[a9ee0599] | 61 |
|
---|
[40df807] | 62 | <!-- note for editors: FIXME please test this by using the latest
|
---|
| 63 | version of the latex-test tarball from
|
---|
[c9aa980] | 64 | https://www.linuxfromscratch.org/~ken/tex-testfiles/
|
---|
[9b514136] | 65 | using ./configure (to create the Makefile) and then making the
|
---|
| 66 | following targets:
|
---|
| 67 | biblatex-unibiber and biblatex-biber (these just use pdflatex
|
---|
| 68 | and biber, biblatex-unibiber is more important, it uses UTF-8)
|
---|
| 69 | bibxelatex (uses xelatex and biber, needs TTF or OTF fonts and
|
---|
| 70 | in particular coverage of simplified Chinese and Japanese, and
|
---|
| 71 | optionally Korean - installed fonts for CJK can be specified to
|
---|
| 72 | configure if they are not found)
|
---|
| 73 | remote1 and remote2 (pdflatex and biber, for use with manually
|
---|
| 74 | installed perl modules, i.e. without Mozilla::CA, to prove that
|
---|
| 75 | remote references work).
|
---|
| 76 | In all cases the output PDF should include references at the
|
---|
[40df807] | 77 | end, the Makefile does not check that for the remote tests.
|
---|
| 78 | The biblatex-biber test only uses latex, trad markup, and
|
---|
| 79 | biber, biblatex.
|
---|
| 80 | -->
|
---|
[9b514136] | 81 |
|
---|
[a9ee0599] | 82 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 83 | <itemizedlist spacing="compact">
|
---|
| 84 | <listitem>
|
---|
[fa3edfef] | 85 | <para>
|
---|
| 86 | Download (HTTP): <ulink url="&biber-download-http;"/>
|
---|
| 87 | </para>
|
---|
[a9ee0599] | 88 | </listitem>
|
---|
| 89 | <listitem>
|
---|
[fa3edfef] | 90 | <para>
|
---|
| 91 | Download (FTP): <ulink url="&biber-download-ftp;"/>
|
---|
| 92 | </para>
|
---|
[a9ee0599] | 93 | </listitem>
|
---|
| 94 | <listitem>
|
---|
[fa3edfef] | 95 | <para>
|
---|
| 96 | Download MD5 sum: &biber-md5sum;
|
---|
| 97 | </para>
|
---|
[a9ee0599] | 98 | </listitem>
|
---|
| 99 | <listitem>
|
---|
[fa3edfef] | 100 | <para>
|
---|
| 101 | Download size: &biber-size;
|
---|
| 102 | </para>
|
---|
[a9ee0599] | 103 | </listitem>
|
---|
| 104 | <listitem>
|
---|
[fa3edfef] | 105 | <para>
|
---|
| 106 | Estimated disk space required: &biber-buildsize;
|
---|
| 107 | </para>
|
---|
[a9ee0599] | 108 | </listitem>
|
---|
| 109 | <listitem>
|
---|
[fa3edfef] | 110 | <para>
|
---|
| 111 | Estimated build time: &biber-time;
|
---|
| 112 | </para>
|
---|
[a9ee0599] | 113 | </listitem>
|
---|
| 114 | </itemizedlist>
|
---|
| 115 |
|
---|
[23d3b894] | 116 | <note>
|
---|
[140475a] | 117 | <!--
|
---|
[23d3b894] | 118 | <para>
|
---|
| 119 | The <application>biber</application> source tarball shown above
|
---|
| 120 | downloads with the correct name, biber-&biber-version;.tar.gz,
|
---|
| 121 | if using a browser such as Firefox. If you prefer to use a command line
|
---|
| 122 | program such as wget, you normally would obtain
|
---|
| 123 | v&biber-version;.tar.gz. To obtain this package with the proper
|
---|
| 124 | filename, run:
|
---|
| 125 |
|
---|
| 126 | <screen><userinput>wget -c &biber-download-http; \
|
---|
| 127 | -O biber-&biber-version;.tar.gz</userinput></screen>.
|
---|
[06fd9a2] | 128 | </para>
|
---|
[140475a] | 129 | -->
|
---|
[06fd9a2] | 130 | <para>
|
---|
[fa3edfef] | 131 | If you have updated to a new release of texlive-source, biber and its
|
---|
[0b87037d] | 132 | perl dependencies are still present in <filename
|
---|
[fa3edfef] | 133 | class="directory">/usr</filename> and do not need to be rebuilt.
|
---|
| 134 | However, biblatex installs in <filename
|
---|
| 135 | class="directory">/opt/texlive/&texlive-year;</filename> and does
|
---|
| 136 | need to be reinstalled.
|
---|
[06fd9a2] | 137 | </para>
|
---|
[9b514136] | 138 |
|
---|
| 139 | <para>
|
---|
[0b87037d] | 140 | If you installed the above dependencies using the BLFS instructions
|
---|
| 141 | for each of them, <command>perl ./Build.PL</command> will complain
|
---|
| 142 | that Mozilla::CA is not installed, but that is not needed unless
|
---|
| 143 | CPAN was used to install the modules. BLFS patches LWP::Protocol::https
|
---|
| 144 | to use the system certificates, Mozilla::CA uses old certificates.
|
---|
| 145 | </para>
|
---|
| 146 |
|
---|
| 147 | <!-- <para> ##commented as a reminder that sooner or later it will need a
|
---|
| 148 | newer version than our current or last but one release ##
|
---|
[fa3edfef] | 149 | This version of biber requires <application>perl-5.30</application>
|
---|
| 150 | or later. If you are still using the 8.4 version of BLFS you may
|
---|
| 151 | wish to build the 2.13 version: see the 8.4 book noting that
|
---|
| 152 | biblatex-3.13 has been replaced by biblatex-3.13a upstream.
|
---|
[0b87037d] | 153 | </para>-->
|
---|
[06fd9a2] | 154 | </note>
|
---|
[a0751bdc] | 155 |
|
---|
[9e95906] | 156 | <!-- TexLive 2022 already ships biblatex-3.17. Uncomment if a newer
|
---|
| 157 | biber requires a newer biblatex. -->
|
---|
| 158 |
|
---|
[40df807] | 159 | <!-- FIXME - ok to comment biblatex when version for a new year matches
|
---|
| 160 | what is in texmf-dist. For new version, reinstate to avoid runtime error. -->
|
---|
[6a1a657] | 161 | <bridgehead renderas="sect3">Required Additional Download</bridgehead>
|
---|
[a0751bdc] | 162 |
|
---|
| 163 | <itemizedlist spacing="compact">
|
---|
| 164 | <listitem>
|
---|
[fa3edfef] | 165 | <para>
|
---|
[c5aa446c] | 166 | Download (HTTP): <ulink url="&biblatex-download-http;"/>
|
---|
[fa3edfef] | 167 | </para>
|
---|
[a0751bdc] | 168 | </listitem>
|
---|
| 169 | <listitem>
|
---|
[fa3edfef] | 170 | <para>
|
---|
| 171 | Download MD5 sum: &biblatex-md5sum;
|
---|
| 172 | </para>
|
---|
[a0751bdc] | 173 | </listitem>
|
---|
| 174 | <listitem>
|
---|
[fa3edfef] | 175 | <para>
|
---|
| 176 | Download size: &biblatex-size;
|
---|
| 177 | </para>
|
---|
[a0751bdc] | 178 | </listitem>
|
---|
| 179 | </itemizedlist>
|
---|
[40df807] | 180 |
|
---|
[a9ee0599] | 181 | <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
|
---|
| 182 |
|
---|
| 183 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 184 | <para role="required">
|
---|
[a206343] | 185 | <!-- KFM: the order listed in Build.PL is not alphabetical -->
|
---|
[4392a40] | 186 | <xref linkend="perl-autovivification"/>
|
---|
| 187 | <xref linkend="perl-business-isbn"/>
|
---|
| 188 | <xref linkend="perl-business-ismn"/>
|
---|
| 189 | <xref linkend="perl-business-issn"/>
|
---|
| 190 | <xref linkend="perl-class-accessor"/>
|
---|
| 191 | <xref linkend="perl-data-compare"/>
|
---|
| 192 | <xref linkend="perl-data-dump"/>
|
---|
| 193 | <xref linkend="perl-data-uniqid"/>
|
---|
| 194 | <xref linkend="perl-datetime-calendar-julian"/>
|
---|
| 195 | <xref linkend="perl-datetime-format-builder"/>
|
---|
| 196 | <xref linkend="perl-encode-eucjpascii"/>
|
---|
| 197 | <xref linkend="perl-encode-hanextra"/>
|
---|
| 198 | <xref linkend="perl-encode-jis2k"/>
|
---|
| 199 | <xref linkend="perl-file-slurper"/>
|
---|
[e819e4f] | 200 | <xref linkend="perl-io-string"/>
|
---|
[145cccdf] | 201 | <!-- IPC::Cmd is a part of core perl -->
|
---|
[4392a40] | 202 | <xref linkend="perl-ipc-run3"/>
|
---|
| 203 | <xref linkend="perl-lingua-translit"/>
|
---|
| 204 | <xref linkend="perl-list-allutils"/>
|
---|
| 205 | <xref linkend="perl-list-moreutils"/>
|
---|
[a206343] | 206 | <!-- perl-list-moreutils-xs is a dep of perl-list-moreutils -->
|
---|
[4392a40] | 207 | <xref linkend="perl-log-log4perl"/>
|
---|
| 208 | <xref linkend="perl-lwp-protocol-https"/>
|
---|
[a206343] | 209 | <!-- LWP::Simple is part of perl-libwww-perl,
|
---|
| 210 | that is pulled in by perl-lwp-protocol-https
|
---|
| 211 | and that pulls in perl-uri -->
|
---|
[4392a40] | 212 | <xref linkend="perl-module-build"/>
|
---|
[4250ad5] | 213 | <xref linkend="perl-parse-recdescent"/>
|
---|
[52a7defa] | 214 | <xref linkend="perl-perlio-utf8_strict"/>
|
---|
[a206343] | 215 | <!-- Mozilla::CA should not be needed when using system certificates -->
|
---|
[4392a40] | 216 | <xref linkend="perl-regexp-common"/>
|
---|
| 217 | <xref linkend="perl-sort-key"/>
|
---|
| 218 | <xref linkend="perl-text-bibtex"/>
|
---|
| 219 | <xref linkend="perl-text-csv"/>
|
---|
[a206343] | 220 | <!-- perl-text-csv_xs is a recommended dependency for perl-text-csv -->
|
---|
[4392a40] | 221 | <xref linkend="perl-text-roman"/>
|
---|
[a206343] | 222 | <!-- Unicode-Collate usually needs to be latest when biber is released,
|
---|
| 223 | core perl is usually older. To read the core version, look at
|
---|
| 224 | /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Collate.pm -->
|
---|
[4392a40] | 225 | <xref linkend="perl-unicode-collate"/>
|
---|
[145cccdf] | 226 | <!-- Unicode::GCstring is part of Unicode::LineBreak -->
|
---|
[4392a40] | 227 | <xref linkend="perl-unicode-linebreak"/>
|
---|
[a206343] | 228 | <!-- Unicode::Normalize is part of core perl, found in
|
---|
| 229 | /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Normalize.pm -->
|
---|
| 230 | <!-- perl-xml-libxml is a dependency of perl-xml-libxml-simple -->
|
---|
[4392a40] | 231 | <xref linkend="perl-xml-libxml-simple"/>
|
---|
| 232 | <xref linkend="perl-xml-libxslt"/>
|
---|
| 233 | <xref linkend="perl-xml-writer"/> and
|
---|
[9385c0fe] | 234 | <!-- untarring biblatex requires that the texmf directories already exist -->
|
---|
[9e95906] | 235 | <!--
|
---|
[c5a4b23] | 236 | <xref linkend="texlive"/>
|
---|
[a206343] | 237 | (or <xref linkend="tl-installer"/>, but for that you can use
|
---|
[fa3edfef] | 238 | <command>tlmgr update</command>)
|
---|
[9e95906] | 239 | -->
|
---|
[a9ee0599] | 240 | </para>
|
---|
| 241 |
|
---|
[5dda4e2] | 242 | <bridgehead renderas="sect4">Recommended (required for the testsuite)</bridgehead>
|
---|
| 243 | <para role="recommended">
|
---|
[4392a40] | 244 | <xref linkend="perl-file-which"/> and
|
---|
[5dda4e2] | 245 | <xref linkend="perl-test-differences"/>
|
---|
[a9ee0599] | 246 | </para>
|
---|
| 247 |
|
---|
| 248 | <note>
|
---|
| 249 | <para>
|
---|
[d3930a7] | 250 | It is possible to install all missing dependencies automatically. You
|
---|
| 251 | must first install <xref linkend="perl-module-build"/> using <xref
|
---|
[fa3edfef] | 252 | linkend="perl-auto-install"/>. Then run <command>perl
|
---|
| 253 | ./Build.PL</command> and when it prompts you, become the root user
|
---|
[0b87037d] | 254 | and run <command>./Build installdeps</command> - this will use CPAN
|
---|
| 255 | and as noted above it will use Mozilla::CA instead of using system
|
---|
| 256 | certificates.
|
---|
[a9ee0599] | 257 | </para>
|
---|
[35b6a2e] | 258 | </note>
|
---|
| 259 |
|
---|
[a9ee0599] | 260 | <para condition="html" role="usernotes">User Notes:
|
---|
[3e90bfe] | 261 | <ulink url='&blfs-wiki;/biber'/></para>
|
---|
[a9ee0599] | 262 |
|
---|
| 263 | </sect2>
|
---|
| 264 |
|
---|
| 265 | <sect2 role="installation">
|
---|
| 266 | <title>Installation of Biber</title>
|
---|
| 267 |
|
---|
[af290af] | 268 | <!-- https://github.com/plk/biber/commit/d9e9617 -->
|
---|
[bc9fa73] | 269 | <!--
|
---|
[fa3edfef] | 270 | <para>
|
---|
[af290af] | 271 | Fix an issue building this package with Perl 5.36 or later:
|
---|
[fa3edfef] | 272 | </para>
|
---|
[a9ee0599] | 273 |
|
---|
[ea7594d] | 274 | <screen><userinput remap="pre">sed 's/undef$/&;/' -i lib/Biber/Section.pm</userinput></screen>
|
---|
[bc9fa73] | 275 | -->
|
---|
[af290af] | 276 | <para>
|
---|
| 277 | Install <application>Biber</application> by running the following
|
---|
| 278 | commands:
|
---|
| 279 | </para>
|
---|
[a41bb164] | 280 |
|
---|
[e819e4f] | 281 | <screen><userinput>perl ./Build.PL &&
|
---|
[0f304418] | 282 | ./Build</userinput></screen>
|
---|
[a9ee0599] | 283 |
|
---|
[fa3edfef] | 284 | <para>
|
---|
| 285 | To test the results, enter: <command>./Build test</command>
|
---|
| 286 | </para>
|
---|
[a9ee0599] | 287 |
|
---|
[fa3edfef] | 288 | <para>
|
---|
| 289 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 290 | </para>
|
---|
[9e95906] | 291 | <!--
|
---|
[59e61f7] | 292 | <screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &&
|
---|
[c5a4b23] | 293 | texhash &&
|
---|
[9e95906] | 294 | -->
|
---|
| 295 | <screen role="root"><userinput>./Build install</userinput></screen>
|
---|
[c5a4b23] | 296 |
|
---|
[c5aa446c] | 297 | <para>
|
---|
| 298 | The corresponding version of <application>biblatex</application> is
|
---|
| 299 | a separate project. The tarball is pre-packaged for untarring
|
---|
| 300 | into the <filename class="directory">texmf-dist</filename>
|
---|
| 301 | directory. Install it as the &root; user:
|
---|
| 302 | </para>
|
---|
| 303 |
|
---|
[bd0723e] | 304 | <screen role="root"><userinput>tar -C $TEXLIVE_PREFIX/texmf-dist -xf ../biblatex-3.18b.tds.tgz</userinput></screen>
|
---|
[c5aa446c] | 305 |
|
---|
[c5a4b23] | 306 | </sect2>
|
---|
[9e95906] | 307 | <!--
|
---|
[c5a4b23] | 308 | <sect2 role="commands">
|
---|
| 309 | <title>Command Explanations</title>
|
---|
[10e632f] | 310 |
|
---|
[c5a4b23] | 311 | <para>
|
---|
[0c54cea] | 312 | <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
|
---|
| 313 | /opt/texlive/&texlive-year;/texmf-dist</command>:
|
---|
[9385c0fe] | 314 | this installs the new <application>biblatex</application> files over those
|
---|
| 315 | installed by <application>texlive</application>.
|
---|
[c5a4b23] | 316 | </para>
|
---|
| 317 |
|
---|
| 318 | <para>
|
---|
[0c54cea] | 319 | <command>texhash</command> : this updates the file hash tables (otherwise
|
---|
[c5a4b23] | 320 | known as the file name database).
|
---|
| 321 | </para>
|
---|
[a9ee0599] | 322 |
|
---|
| 323 | </sect2>
|
---|
[9e95906] | 324 | -->
|
---|
[a9ee0599] | 325 | <sect2 role="content">
|
---|
| 326 | <title>Contents</title>
|
---|
| 327 |
|
---|
| 328 | <segmentedlist>
|
---|
| 329 | <segtitle>Installed Programs</segtitle>
|
---|
| 330 | <segtitle>Installed Library</segtitle>
|
---|
| 331 | <segtitle>Installed Directory</segtitle>
|
---|
| 332 |
|
---|
| 333 | <seglistitem>
|
---|
| 334 | <seg>biber</seg>
|
---|
| 335 | <seg>None</seg>
|
---|
[a953d7d5] | 336 | <seg>/usr/lib/perl5/site_perl/5.*{,/<arch>-linux/auto}/Biber</seg>
|
---|
[a9ee0599] | 337 | </seglistitem>
|
---|
| 338 | </segmentedlist>
|
---|
| 339 |
|
---|
| 340 | <variablelist>
|
---|
| 341 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 342 | <?dbfo list-presentation="list"?>
|
---|
| 343 | <?dbhtml list-presentation="table"?>
|
---|
| 344 |
|
---|
| 345 | <varlistentry id="biber-prog">
|
---|
[3e90bfe] | 346 | <term><command>biber</command></term>
|
---|
[a9ee0599] | 347 | <listitem>
|
---|
[fa3edfef] | 348 | <para>
|
---|
[4c24eb0a] | 349 | is used for producing bibliographies in LaTeX documents
|
---|
[fa3edfef] | 350 | </para>
|
---|
[3e90bfe] | 351 | <indexterm zone="biber biber-prog">
|
---|
[a9ee0599] | 352 | <primary sortas="b-biber">biber</primary>
|
---|
| 353 | </indexterm>
|
---|
| 354 | </listitem>
|
---|
| 355 | </varlistentry>
|
---|
| 356 |
|
---|
| 357 | </variablelist>
|
---|
| 358 |
|
---|
| 359 | </sect2>
|
---|
| 360 |
|
---|
| 361 | </sect1>
|
---|