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