glfs/pst/typesetting/biber.xml

266 lines
9.9 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;.tar.gz">
<!ENTITY biber-download-ftp " ">
<!ENTITY biber-md5sum "4956fbf23546b6325647b6c81b2b4bea">
<!ENTITY biber-size "1.3 MB">
<!-- buildsize includes the installed biblatex -->
<!ENTITY biber-buildsize "36 MB">
<!ENTITY biber-time "0.3 SBU including tests">
<!ENTITY biblatex-download-http "http://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz">
<!ENTITY biblatex-download-ftp "">
<!ENTITY biblatex-md5sum "0aa6937010eaaf2154e3ebd00a2fae77">
<!ENTITY biblatex-size "19 MB">
]>
<sect1 id="biber" xreflabel="biber-&biber-version;">
<?dbhtml filename="biber.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>biber-&biber-version;</title>
<indexterm zone="biber">
<primary sortas="a-biber">Biber</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to biber</title>
<para>Biber is a BibTeX replacement for users of biblatex, written in
<application>Perl</application>, with full Unicode support.</para>
&lfs80_checked;
&gcc7_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&biber-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&biber-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &biber-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &biber-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &biber-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &biber-time;</para>
</listitem>
</itemizedlist>
<note>
<para>
The <application>biber</application> source tarball shown above
downloads with the correct name, biber-&biber-version;.tar.gz,
if using a browser such as Firefox. If you prefer to use a command line
program such as wget, you normally would obtain
v&biber-version;.tar.gz. To obtain this package with the proper
filename, run:
<screen><userinput>wget -c &biber-download-http; \
-O biber-&biber-version;.tar.gz</userinput></screen>.
</para>
</note>
<bridgehead renderas="sect3">Required Additional Download</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>The corresponding version of <application>biblatex</application> is
a separate project - the tds tarball is pre-packaged for untarring into
the <filename class="directory">texmf-dist</filename> directory.
Download (HTTP): <ulink url="&biblatex-download-http;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &biblatex-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &biblatex-size;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Biber Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<!-- KFM: because I always get confused by these deps, I've decided
to add some comments.
Both Config::AutoConf and ExtUtils::LibBuilder are listed as build
requirements in Build.PL, the rest are just requirements, but the
difference seems moot. Those two are needed to build Text::BibTeX
so not listed separately. -->
<xref linkend="perl-autovivification"/>
<xref linkend="perl-business-isbn"/>
<xref linkend="perl-business-ismn"/>
<xref linkend="perl-business-issn"/>
<xref linkend="perl-class-accessor"/>
<xref linkend="perl-data-compare"/>
<xref linkend="perl-data-dump"/>
<xref linkend="perl-data-uniqid"/>
<xref linkend="perl-datetime-calendar-julian"/>
<xref linkend="perl-datetime-format-builder"/>
<xref linkend="perl-encode-eucjpascii"/>
<xref linkend="perl-encode-hanextra"/>
<xref linkend="perl-encode-jis2k"/>
<xref linkend="perl-file-slurp"/>
<!-- IPC::Cmd is a part of core perl -->
<xref linkend="perl-ipc-run3"/>
<xref linkend="perl-lingua-translit"/>
<xref linkend="perl-list-allutils"/>
<!-- List::MoreUtils was pulled in for the testsuite of List::AllUtils,
but it needs to be present even if people do not run the tests -->
<xref linkend="perl-list-moreutils"/>
<!-- List::MoreUtils::XS is listed as a dep, but it is part of
List::MoreUtils -->
<xref linkend="perl-log-log4perl"/>
<!-- I initially misread LWP-Protocol-https as part of libwww-perl
when I was preparing this list. In fact, it depends on that -->
<xref linkend="perl-lwp-protocol-https"/>
<!-- LWP::Simple is part of libwww-perl,
that is pulled in by LWP::Protocol::https -->
<!-- Module::Build is pulled in by perl-text-bibtex, but mention it explicitly
so that the note on automatically installing missing dependencies can be run -->
<xref linkend="perl-module-build"/>
<!-- Mozilla::CA is a dependency of LWP-Protocol-https -->
<xref linkend="perl-regexp-common"/>
<xref linkend="perl-sort-key"/>
<xref linkend="perl-text-bibtex"/>
<xref linkend="perl-text-csv"/>
<!-- Text-CSV_XS is a recommended dependency for Text-CSV -->
<xref linkend="perl-text-roman"/>
<!-- Unicode-Collate usually needs to be latest, core perl is older -->
<xref linkend="perl-unicode-collate"/>
<!-- Unicode::GCstring is part of Unicode::LineBreak -->
<xref linkend="perl-unicode-linebreak"/>
<xref linkend="perl-xml-libxml-simple"/>
<xref linkend="perl-xml-libxslt"/>
<xref linkend="perl-xml-writer"/> and
<!-- untarring biblatex requires that the texmf directories already exist -->
<xref linkend="texlive"/>
(or <xref linkend="tl-installer"/>)
</para>
<note> <!-- FIXME remove this after our 8.0 release, so that it is noted
in at least one release of the book -->
<para>This version of <application>biber</application> requires at least
<application>perl-5.24.0</application>. If you are using an older version
of <command>perl</command> you may prefer to install v2.5 - for that see
the BLFS-7.10 book (that source is now in
<filename class="directory">files/biblatex-biber/2.5/</filename> instead of
<filename class="directory">files/biblatex-biber/current/</filename>).</para>
</note>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="perl-file-which"/> and
<xref linkend="perl-test-differences"/> to run the testsuite
</para>
<note>
<para>
It is possible to install all missing dependencies automatically.
But from <application>perl-5.22.0</application> onwards,
<xref linkend="perl-module-build"/> is no longer part of the core perl
distribution. And for <xref linkend="perl-data-uniqid"/> we have to
patch it to skip over a test which always fails - that failing test may
break the automatic install. To automatically install the remaining perl
dependencies you can install those two modules first using <xref
linkend="perl-auto-install"/>. then run <command>perl ./Build.PL</command>
and when it prompts you, become the root user and run
<command>./Build installdeps</command>
</para>
</note>
<para condition="html" role="usernotes">User Notes:
<ulink url='&blfs-wiki;/biber'/></para>
</sect2>
<sect2 role="installation">
<title>Installation of Biber</title>
<para>Install <application>Biber</application> by running the following
commands:</para>
<screen><userinput>perl ./Build.PL &amp;&amp;
./Build</userinput></screen>
<para>To test the results, enter: <command>./Build test</command></para>
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &amp;&amp;
texhash &amp;&amp;
./Build install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
/opt/texlive/&texlive-year;/texmf-dist</command>:
this installs the new <application>biblatex</application> files over those
installed by <application>texlive</application>.
</para>
<para>
<command>texhash</command> : this updates the file hash tables (otherwise
known as the file name database).
</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>biber</seg>
<seg>None</seg>
<seg>/usr/lib/perl5/site_perl/5.*{,/&lt;arch&gt;-linux/auto}/Biber</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="biber-prog">
<term><command>biber</command></term>
<listitem>
<para>is used for producing bibliographies in LaTeX documents.</para>
<indexterm zone="biber biber-prog">
<primary sortas="b-biber">biber</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>