source: pst/typesetting/biber.xml@ f624571

<?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   "http://sourceforge.net/projects/biblatex-biber/files/biblatex-biber/&biber-version;/biblatex-biber.tar.gz">
  <!ENTITY biber-download-ftp " ">
<!-- <!ENTITY biber-download-http   "&sources-anduin-http;/biblatex-biber/biblatex-biber-&biber-version;.tar.gz">
  <!ENTITY biber-download-ftp    "&sources-anduin-ftp;/biblatex-biber/biblatex-biber-&biber-version;.tar.gz">-->
  <!ENTITY biber-md5sum          "530368acb20b0881e13d7df0e5976e11">
  <!ENTITY biber-size            "1.1 MB">
  <!-- buildsize includes the installed biblatex -->
  <!ENTITY biber-buildsize       "32 MB">
  <!ENTITY biber-time            "less than 0.1 SBU (0.8 SBU to run the 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          "75321553c70697a213607b89f728e15d">
  <!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>biblatex-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>

    &lfs79_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>

    <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-date-simple"/>
      <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"/>
      <!-- LWP::Simple is part of libwww-perl,
      that is pulled in by LWP::Protocol::https -->
      <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"/>
      <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"/>
      <!-- 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-text-bibtex"/>
      <xref linkend="perl-text-roman"/>
      <!-- Collate.pm ships in perl, but is sometimes too old, and we like current
      versions.  Make the latest version required so that everyone is using the
      same version.  In fact, the version in perl-5.20.2 is indeed too old for
      biber-2.0 -->
      <xref linkend="perl-unicode-collate"/>
      <!-- Unicode::GCstring is part of Unicode::LineBreak -->
      <xref linkend="perl-unicode-linebreak"/>
      <xref linkend="perl-unicode-normalize"/>
      <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>

    <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>
<!-- when a new release appears, use this para and link to sourceforge,
     until we  have a versioned copy at anduin. -->
      <para>
        Although the tarball name is unversioned, it will untar to a
        correctly-versioned biblatex-biber-&biber-version; directory.
      </para>

      <para>
        It is almost possible to install all missing dependencies automatically.
        Except, 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 will probably break the automatic install.  To automatically install
        the remaining perl dependencies you will need to manually install those
        two modules first.
        You can then run <command>perl ./Build.PL</command> and when it
        prompts you, become the root user and run
        <command>./Build installdeps</command>
      </para>
    </note>

    <note> <!-- remove this note when texlive-2016 is released -->
      <para>
        If you use external modules with biber, a change in v2.4 (to
        \DeclareNameFormat) breaks at least some of them - if this applies to
        you, you will need to update the affected module from CTAN.
      </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> - you will
    require the en_GB.UTF-8 and sv_SE.UTF-8 locales. Test 12 of t/sort-order.t
    will fail : for
    speed the tests use system locales instead of the default Unicode::Collation
    algorithm, and some minor details of the locales in OSX (where development
    takes place) differ from those in <application>glibc</application></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>