[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 |
|
---|
[10e632f] | 7 | <!ENTITY biber-download-http "http://sourceforge.net/projects/biblatex-biber/files/biblatex-biber/&biber-version;/biblatex-biber.tar.gz">
|
---|
| 8 | <!ENTITY biber-download-ftp " ">
|
---|
| 9 | <!ENTITY biber-md5sum "c46979acce3befdb3431ffadcc81bdf3">
|
---|
| 10 | <!ENTITY biber-size "2.0 MB">
|
---|
[9385c0fe] | 11 | <!-- buildsize includes the installed biblatex -->
|
---|
[10e632f] | 12 | <!ENTITY biber-buildsize "37 MB">
|
---|
| 13 | <!ENTITY biber-time "less than 0.1 SBU (0.6 SBU to run the tests)">
|
---|
[9385c0fe] | 14 |
|
---|
| 15 | <!ENTITY biblatex-download-http "http://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz">
|
---|
[c5a4b23] | 16 | <!ENTITY biblatex-download-ftp "">
|
---|
[9385c0fe] | 17 | <!ENTITY biblatex-md5sum "c6dad1c1f8a46785981610b5165d9fe5">
|
---|
| 18 | <!ENTITY biblatex-size "19 MB">
|
---|
[c5a4b23] | 19 |
|
---|
[a9ee0599] | 20 | ]>
|
---|
| 21 |
|
---|
| 22 | <sect1 id="biber" xreflabel="biber-&biber-version;">
|
---|
| 23 | <?dbhtml filename="biber.html"?>
|
---|
| 24 |
|
---|
| 25 | <sect1info>
|
---|
| 26 | <othername>$LastChangedBy$</othername>
|
---|
| 27 | <date>$Date$</date>
|
---|
| 28 | </sect1info>
|
---|
| 29 |
|
---|
| 30 | <title>biblatex-biber-&biber-version;</title>
|
---|
| 31 |
|
---|
| 32 | <indexterm zone="biber">
|
---|
| 33 | <primary sortas="a-biber">Biber</primary>
|
---|
| 34 | </indexterm>
|
---|
| 35 |
|
---|
| 36 | <sect2 role="package">
|
---|
| 37 | <title>Introduction to biber</title>
|
---|
| 38 |
|
---|
| 39 | <para>Biber is a BibTeX replacement for users of biblatex, written in
|
---|
[10e632f] | 40 | <application>Perl</application>, with full Unicode support.</para>
|
---|
[a9ee0599] | 41 |
|
---|
[01e6b294] | 42 | &lfs78_checked;
|
---|
[a9ee0599] | 43 |
|
---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download (HTTP): <ulink url="&biber-download-http;"/></para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download (FTP): <ulink url="&biber-download-ftp;"/></para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download MD5 sum: &biber-md5sum;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Download size: &biber-size;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Estimated disk space required: &biber-buildsize;</para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>Estimated build time: &biber-time;</para>
|
---|
| 63 | </listitem>
|
---|
| 64 | </itemizedlist>
|
---|
| 65 |
|
---|
[10e632f] | 66 | <bridgehead renderas="sect3">Required Additional Downloads</bridgehead>
|
---|
[c5a4b23] | 67 |
|
---|
| 68 | <itemizedlist spacing="compact">
|
---|
[10e632f] | 69 | <listitem>
|
---|
| 70 | <para>The corresponding version of <application>biblatex</application> is
|
---|
| 71 | a separate project - the tds tarball is pre-packaged for untarring into
|
---|
| 72 | the <filename class="directory">texmf-dist</filename> directory.
|
---|
| 73 | Download (HTTP): <ulink url="&biblatex-download-http;"/></para>
|
---|
[c5a4b23] | 74 | </listitem>
|
---|
| 75 | <listitem>
|
---|
| 76 | <para>Download MD5 sum: &biblatex-md5sum;</para>
|
---|
| 77 | </listitem>
|
---|
| 78 | <listitem>
|
---|
| 79 | <para>Download size: &biblatex-size;</para>
|
---|
| 80 | </listitem>
|
---|
[987cd78] | 81 | <listitem>
|
---|
| 82 | <para>
|
---|
| 83 | Required patch:
|
---|
| 84 | <ulink url="&patch-root;/biblatex-biber-&biber-version;-upstream_fixes-1.patch"/>
|
---|
| 85 | </para>
|
---|
| 86 | </listitem>
|
---|
[c5a4b23] | 87 | </itemizedlist>
|
---|
| 88 |
|
---|
[a9ee0599] | 89 | <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
|
---|
| 90 |
|
---|
| 91 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 92 | <para role="required">
|
---|
| 93 | <xref linkend="perl-autovivification"/>
|
---|
| 94 | <xref linkend="perl-business-isbn"/>
|
---|
| 95 | <xref linkend="perl-business-ismn"/>
|
---|
| 96 | <xref linkend="perl-business-issn"/>
|
---|
| 97 | <xref linkend="perl-data-compare"/>
|
---|
[1c80c2c] | 98 | <xref linkend="perl-data-dump"/>
|
---|
[a9ee0599] | 99 | <xref linkend="perl-date-simple"/>
|
---|
| 100 | <xref linkend="perl-encode-eucjpascii"/>
|
---|
| 101 | <xref linkend="perl-encode-hanextra"/>
|
---|
| 102 | <xref linkend="perl-encode-jis2k"/>
|
---|
| 103 | <xref linkend="perl-file-slurp"/>
|
---|
| 104 | <xref linkend="perl-ipc-run3"/>
|
---|
| 105 | <xref linkend="perl-log-log4perl"/>
|
---|
| 106 | <xref linkend="perl-lwp"/>
|
---|
| 107 | <xref linkend="perl-list-allutils"/>
|
---|
[10e632f] | 108 | <!-- this is pulled in by perl-text-bibtex, but mention it explicitly
|
---|
| 109 | so that the note on automatically installing missing dependencies makes
|
---|
| 110 | more sense -->
|
---|
| 111 | <xref linkend="perl-module-build"/>
|
---|
[a9ee0599] | 112 | <xref linkend="perl-regexp-common"/>
|
---|
| 113 | <xref linkend="perl-text-bibtex"/>
|
---|
[9385c0fe] | 114 | <xref linkend="perl-text-roman"/>
|
---|
[d0070d69] | 115 | <!-- Collate.pm ships in perl, but is sometimes too old, and we like current
|
---|
| 116 | versions. Make the latest version required so that everyone is using the
|
---|
[9385c0fe] | 117 | same version. In fact, the version in perl-5.20.2 is indeed too old for
|
---|
| 118 | biber-2.0 -->
|
---|
[d0070d69] | 119 | <xref linkend="perl-unicode-collate"/>
|
---|
[a9ee0599] | 120 | <xref linkend="perl-unicode-linebreak"/>
|
---|
| 121 | <xref linkend="perl-xml-libxml-simple"/>
|
---|
[c5a4b23] | 122 | <xref linkend="perl-xml-libxslt"/>
|
---|
| 123 | <xref linkend="perl-xml-writer"/> and
|
---|
[9385c0fe] | 124 | <!-- untarring biblatex requires that the texmf directories already exist -->
|
---|
[c5a4b23] | 125 | <xref linkend="texlive"/>
|
---|
[a9ee0599] | 126 | </para>
|
---|
| 127 |
|
---|
| 128 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 129 | <para role="required">
|
---|
[9385c0fe] | 130 | <xref linkend="perl-file-which"/>,
|
---|
| 131 | <xref linkend="perl-test-differences"/>,
|
---|
| 132 | <xref linkend="perl-test-pod"/> and
|
---|
| 133 | <xref linkend="perl-test-pod-coverage"/> (all needed to run the testsuite)
|
---|
[a9ee0599] | 134 | </para>
|
---|
| 135 |
|
---|
| 136 | <note>
|
---|
[10e632f] | 137 | <para>
|
---|
| 138 | Although the tarball name is unversioned, it will untar to a
|
---|
| 139 | correctly-versioned biblatex-biber-&biber-version; directory.
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
[a9ee0599] | 142 | <para>
|
---|
| 143 | It is possible to install (all) missing dependencies automatically.
|
---|
[10e632f] | 144 | From <application>perl-5.22.0</application> onwards,
|
---|
| 145 | <xref linkend="perl-module-build"/> is no longer part of
|
---|
| 146 | the core distribution. To automatically install the remaining perl
|
---|
| 147 | dependencies you will need to install that first.
|
---|
| 148 | You can then run <command>perl ./Build.PL</command> and when it
|
---|
[a9ee0599] | 149 | prompts you, become the root user and run
|
---|
| 150 | <command>./Build installdeps</command>
|
---|
| 151 | </para>
|
---|
[10e632f] | 152 |
|
---|
| 153 | <para>
|
---|
| 154 | If you run <command>./Build.PL</command> under versions of
|
---|
| 155 | <application>perl</application> after 5.20.2 it will tell you that the
|
---|
| 156 | version of <application>Unicode::Normalize</application> is too
|
---|
| 157 | <emphasis>new</emphasis>. In fact, the new version works, but is now
|
---|
| 158 | pure perl and takes longer to run : <emphasis>much</emphasis> longer
|
---|
| 159 | if you have a large bibliography. You can find the old version at <ulink
|
---|
| 160 | url="http://backpan.perl.org/authors/id/S/SA/SADAHIRO/Unicode-Normalize-1.17.tar.gz"/>
|
---|
| 161 | and use the standard <xref linkend="perl-standard-install"/>
|
---|
| 162 | to install it if you wish. Further details are in the User Notes.
|
---|
| 163 | </para>
|
---|
[a9ee0599] | 164 | </note>
|
---|
| 165 |
|
---|
| 166 | <para condition="html" role="usernotes">User Notes:
|
---|
[3e90bfe] | 167 | <ulink url='&blfs-wiki;/biber'/></para>
|
---|
[a9ee0599] | 168 |
|
---|
| 169 | </sect2>
|
---|
| 170 |
|
---|
| 171 | <sect2 role="installation">
|
---|
| 172 | <title>Installation of Biber</title>
|
---|
| 173 |
|
---|
| 174 | <para>Install <application>Biber</application> by running the following
|
---|
[10e632f] | 175 | commands (patching the read-only files will produce warnings):</para>
|
---|
[a9ee0599] | 176 |
|
---|
[4097f8d] | 177 | <screen><userinput>patch -Np1 -i ../biblatex-biber-&biber-version;-upstream_fixes-1.patch &&
|
---|
[10e632f] | 178 | sed -i 's/ 44/ 43/' t/bcfvalidation.t &&
|
---|
| 179 | perl ./Build.PL &&
|
---|
[0f304418] | 180 | ./Build</userinput></screen>
|
---|
[a9ee0599] | 181 |
|
---|
[10e632f] | 182 | <para>To test the results, enter: <command>./Build test</command> - you will
|
---|
| 183 | require the en_GB.UTF-8 and sv_SE.UTF-8 locales. Two tests (and two subtests)
|
---|
| 184 | will fail : for speed the tests use system locales instead of the default
|
---|
| 185 | Unicode::Collation algorithm, and some minor details of the locales in OSX
|
---|
| 186 | (where development takes place) differ from those in
|
---|
| 187 | <application>glibc</application></para>
|
---|
[a9ee0599] | 188 |
|
---|
| 189 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 190 |
|
---|
[59e61f7] | 191 | <screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &&
|
---|
[c5a4b23] | 192 | texhash &&
|
---|
| 193 | ./Build install</userinput></screen>
|
---|
| 194 |
|
---|
| 195 | </sect2>
|
---|
| 196 |
|
---|
| 197 | <sect2 role="commands">
|
---|
| 198 | <title>Command Explanations</title>
|
---|
| 199 |
|
---|
[10e632f] | 200 | <para>
|
---|
| 201 | <parameter>patch -Np1 -i
|
---|
| 202 | ../biblate-biber-&biber-version;-upstream_fixes-1.patch</parameter>:
|
---|
| 203 | <application>perl-5.22</application> has become more strict about
|
---|
| 204 | what needs to be escaped.
|
---|
| 205 | </para>
|
---|
| 206 |
|
---|
| 207 | <para>
|
---|
| 208 | <parameter>sed -i 's/ 44/ 43/' t/bcfvalidation.t</parameter>: Although
|
---|
| 209 | the git master branch has 44 pairs of files for this test, the shipped
|
---|
| 210 | tarball only contains 43. The sed prevents it failing.
|
---|
| 211 | </para>
|
---|
| 212 |
|
---|
[c5a4b23] | 213 | <para>
|
---|
| 214 | <parameter>tar -xf biblatex-&biblatex-version;a.tds.tar.gz -C
|
---|
| 215 | /opt/texlive/&texlive-year;/texmf-dist</parameter>:
|
---|
[9385c0fe] | 216 | this installs the new <application>biblatex</application> files over those
|
---|
| 217 | installed by <application>texlive</application>.
|
---|
[c5a4b23] | 218 | </para>
|
---|
| 219 |
|
---|
| 220 | <para>
|
---|
| 221 | <parameter>texhash</parameter> : this updates the file hash tables (otherwise
|
---|
| 222 | known as the file name database).
|
---|
| 223 | </para>
|
---|
[a9ee0599] | 224 |
|
---|
| 225 | </sect2>
|
---|
| 226 |
|
---|
| 227 | <sect2 role="content">
|
---|
| 228 | <title>Contents</title>
|
---|
| 229 |
|
---|
| 230 | <segmentedlist>
|
---|
| 231 | <segtitle>Installed Programs</segtitle>
|
---|
| 232 | <segtitle>Installed Library</segtitle>
|
---|
| 233 | <segtitle>Installed Directory</segtitle>
|
---|
| 234 |
|
---|
| 235 | <seglistitem>
|
---|
| 236 | <seg>biber</seg>
|
---|
| 237 | <seg>None</seg>
|
---|
| 238 | <seg>/usr/lib/site_perl/5.*/Biber</seg>
|
---|
| 239 | </seglistitem>
|
---|
| 240 | </segmentedlist>
|
---|
| 241 |
|
---|
| 242 | <variablelist>
|
---|
| 243 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 244 | <?dbfo list-presentation="list"?>
|
---|
| 245 | <?dbhtml list-presentation="table"?>
|
---|
| 246 |
|
---|
| 247 | <varlistentry id="biber-prog">
|
---|
[3e90bfe] | 248 | <term><command>biber</command></term>
|
---|
[a9ee0599] | 249 | <listitem>
|
---|
| 250 | <para>is used for producing bibliographies in LaTeX documents.</para>
|
---|
[3e90bfe] | 251 | <indexterm zone="biber biber-prog">
|
---|
[a9ee0599] | 252 | <primary sortas="b-biber">biber</primary>
|
---|
| 253 | </indexterm>
|
---|
| 254 | </listitem>
|
---|
| 255 | </varlistentry>
|
---|
| 256 |
|
---|
| 257 | </variablelist>
|
---|
| 258 |
|
---|
| 259 | </sect2>
|
---|
| 260 |
|
---|
| 261 | </sect1>
|
---|