source: pst/typesetting/biber.xml@ cad8418

<?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-md5sum          "aa2857f3a4b0c2ab2dfe3c4f657cbb50">
  <!ENTITY biber-size            "2.0 MB">
  <!-- for 1.9/2.9a buildsize includes extra space used by biblatex -->
  <!ENTITY biber-buildsize       "25 MB">
  <!ENTITY biber-time            "less than 0.1 SBU (0.6 SBU to run the tests)">

  <!-- biblatex directory is 2.9, filename is 2.9a -->
  <!ENTITY biblatex-download-http   "http://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;a.tds.tgz">
  <!ENTITY biblatex-download-ftp    "">
  <!ENTITY biblatex-md5sum          "955662dca33f8256933745c51ccd0af9">
  <!ENTITY biblatex-size            "18 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>. Unusually, the tarball itself is
    called just biblatex-biber.tar.gz but it will extract to a versioned
    directory. Please ensure you download it from the correct versioned
    directory at sourceforge.</para>

    <para>This version fixes a problem when certain UTF-8 codepoints are
    used in the "key" value of a bibliography entry and current
    <application>perl</application> is used. It is shipped in current binary
    versions of <application>texlive</application> but requires a newer
    version of <application>biblatex</application> than is in the
    <application>texlive</application> source.</para>

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

      <para>The corresponding version of <application>biblatex</application> is
      a separate project - the tds version is pre-packaged for untarring into
      the <filename class="directory">texmf-dist</filename> directory.</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>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">
      <xref linkend="perl-autovivification"/>
      <xref linkend="perl-business-isbn"/>
      <xref linkend="perl-business-ismn"/>
      <xref linkend="perl-business-issn"/>
      <xref linkend="perl-data-compare"/>
      <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"/>
      <xref linkend="perl-ipc-run3"/>
      <xref linkend="perl-log-log4perl"/>
      <xref linkend="perl-lwp"/>
      <xref linkend="perl-list-allutils"/>
      <xref linkend="perl-regexp-common"/>
      <xref linkend="perl-text-bibtex"/>
      <!-- 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 -->
      <xref linkend="perl-unicode-collate"/>
      <xref linkend="perl-unicode-linebreak"/>
      <xref linkend="perl-xml-libxml-simple"/>
      <xref linkend="perl-xml-libxslt"/>
      <xref linkend="perl-xml-writer"/> and
      <!-- biblatex requires that the texmf directories already exist -->
      <xref linkend="texlive"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="required">
      <xref linkend="perl-readonly-xs"/>, and
      <xref linkend="perl-file-which"/> (to run the testsuite)
    </para>

    <!-- commented while separate biblatex is used
    <bridgehead renderas="sect4">Required (at runtime)</bridgehead>
    <para role="optional">
      <xref linkend="texlive"/>
    </para> -->

    <note>
      <para>
        It is possible to install (all) missing dependencies automatically.
        Begin by running <command>perl ./Build.PL</command> and then 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>sed -i 's/use Encode;/&amp;\nuse File::Slurp;\nuse File::Spec;/' \
  lib/Biber/LaTeX/Recode.pm &amp;&amp;
perl ./Build.PL &amp;&amp;
./Build.PL</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;a.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>
      <parameter>sed -i 's/use Encode;/&amp;\nuse File::Slurp;\nuse File::Spec;/' ...</parameter>:
      this sed fixes a runtime error with current <application>perl</application>.
    </para>

    <para>
      <parameter>tar -xf biblatex-&biblatex-version;a.tds.tar.gz -C
      /opt/texlive/&texlive-year;/texmf-dist</parameter>:
      this installs the new <application>biblatex</application> files over the
      previous version.
    </para>

    <para>
      <parameter>texhash</parameter> : 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/site_perl/5.*/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>