source: pst/typesetting/biber.xml@ 15f411e

<?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        "2bbaffa7af5fedbcede60cfeaf56cd7c">
  <!ENTITY biber-size          "1.3 MB">
  <!-- buildsize includes the installed biblatex -->
  <!ENTITY biber-buildsize     "36 MB">
  <!ENTITY biber-time          "0.4 SBU including tests">

  <!-- Check path.  Directory might not be &biblatex-version; if a suffixed update -->
  <!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          "b15453a9b9aa7df55e0a9f82a50c8ffa">
  <!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>

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

      <para>
       If you have updated to a new release of texlive-source, biber and its
       perl dependencies are still in present in <filename
       class="directory">/usr</filename> and do not need to be rebuilt. However,
       biblatex installs in <filename
       class="directory">/opt/texlive/&texlive-year;</filename> and does need to
       be reinstalled.
      </para>
    </note>

    <bridgehead renderas="sect3">Required Additional Downloads</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>
      <listitem>
        <para>
          Patch to make the tests work correctly with perl-5.30.0.
          <ulink url="&patch-root;/biber-&biber-version;-upstream_fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Biber Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <!-- KFM: the order listed in Build.PL is not alphabetical -->
      <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-slurper"/>
      <!-- IPC::Cmd is a part of core perl -->
      <xref linkend="perl-ipc-run3"/>
      <xref linkend="perl-lingua-translit"/>
      <xref linkend="perl-list-allutils"/>
      <xref linkend="perl-list-moreutils"/>
      <!-- perl-list-moreutils-xs is a dep of perl-list-moreutils -->
      <xref linkend="perl-log-log4perl"/>
      <xref linkend="perl-lwp-protocol-https"/>
      <!-- LWP::Simple is part of perl-libwww-perl,
      that is pulled in by perl-lwp-protocol-https
      and that pulls in perl-uri -->
      <xref linkend="perl-module-build"/>
      <xref linkend="perl-perlio-utf8_strict"/>
      <!-- Mozilla::CA should not be needed when using system certificates -->
      <xref linkend="perl-regexp-common"/>
      <xref linkend="perl-sort-key"/>
      <xref linkend="perl-text-bibtex"/>
      <xref linkend="perl-text-csv"/>
      <!-- perl-text-csv_xs is a recommended dependency for perl-text-csv -->
      <xref linkend="perl-text-roman"/>
      <!-- Unicode-Collate usually needs to be latest when biber is released,
        core perl is usually older. To read the core version, look at
        /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Collate.pm -->
      <xref linkend="perl-unicode-collate"/>
      <!-- Unicode::GCstring is part of Unicode::LineBreak -->
      <xref linkend="perl-unicode-linebreak"/>
      <!-- Unicode::Normalize is part of core perl, found in
        /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Normalize.pm -->
      <!-- perl-xml-libxml is a dependency of perl-xml-libxml-simple -->
      <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"/>, but for that you can use
       <command>tlmgr update </command>)
    </para>

    <note> <!-- assume people with an old release may be slowly building things -->
      <para>
        If you are using perl 5.26 or 5.28, please omit the patch (or follow the
        instructions in the BLFS-8.4 book for this package).</para>
    </note>

    <bridgehead renderas="sect4">Recommended (required for the testsuite)</bridgehead>
    <para role="recommended">
      <xref linkend="perl-file-which"/> and
      <xref linkend="perl-test-differences"/>
    </para>

    <note>
      <para>
        It is possible to install all missing dependencies automatically. You
        must first install <xref linkend="perl-module-build"/> 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>patch -Np1 -i ../biber-&biber-version;-upstream_fixes-1.patch &amp;&amp;
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>patch -Np1 -i ../biber-&biber-version;-upstream_fixes-1.patch</command>:
      Perl version 5.30.0 shipped a new version of core module Unicode::Collate which
      changed sortinit hashes. That broke many tests, the patch fixes them.
    </para>

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