[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 |
|
---|
[35b6a2e] | 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-download-http "&sources-anduin-http;/biblatex-biber/biblatex-biber-&biber-version;.tar.gz">
|
---|
| 10 | <!ENTITY biber-download-ftp "&sources-anduin-ftp;/biblatex-biber/biblatex-biber-&biber-version;.tar.gz">-->
|
---|
| 11 | <!ENTITY biber-md5sum "530368acb20b0881e13d7df0e5976e11">
|
---|
| 12 | <!ENTITY biber-size "1.1 MB">
|
---|
[9385c0fe] | 13 | <!-- buildsize includes the installed biblatex -->
|
---|
[35b6a2e] | 14 | <!ENTITY biber-buildsize "32 MB">
|
---|
| 15 | <!ENTITY biber-time "less than 0.1 SBU (0.8 SBU to run the tests)">
|
---|
[9385c0fe] | 16 |
|
---|
| 17 | <!ENTITY biblatex-download-http "http://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz">
|
---|
[c5a4b23] | 18 | <!ENTITY biblatex-download-ftp "">
|
---|
[f624571] | 19 | <!ENTITY biblatex-md5sum "75321553c70697a213607b89f728e15d">
|
---|
[9385c0fe] | 20 | <!ENTITY biblatex-size "19 MB">
|
---|
[c5a4b23] | 21 |
|
---|
[a9ee0599] | 22 | ]>
|
---|
| 23 |
|
---|
| 24 | <sect1 id="biber" xreflabel="biber-&biber-version;">
|
---|
| 25 | <?dbhtml filename="biber.html"?>
|
---|
| 26 |
|
---|
| 27 | <sect1info>
|
---|
| 28 | <othername>$LastChangedBy$</othername>
|
---|
| 29 | <date>$Date$</date>
|
---|
| 30 | </sect1info>
|
---|
| 31 |
|
---|
| 32 | <title>biblatex-biber-&biber-version;</title>
|
---|
| 33 |
|
---|
| 34 | <indexterm zone="biber">
|
---|
| 35 | <primary sortas="a-biber">Biber</primary>
|
---|
| 36 | </indexterm>
|
---|
| 37 |
|
---|
| 38 | <sect2 role="package">
|
---|
| 39 | <title>Introduction to biber</title>
|
---|
| 40 |
|
---|
| 41 | <para>Biber is a BibTeX replacement for users of biblatex, written in
|
---|
[10e632f] | 42 | <application>Perl</application>, with full Unicode support.</para>
|
---|
[a9ee0599] | 43 |
|
---|
[5ac40fda] | 44 | &lfs79_checked;
|
---|
[a9ee0599] | 45 |
|
---|
| 46 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 47 | <itemizedlist spacing="compact">
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download (HTTP): <ulink url="&biber-download-http;"/></para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download (FTP): <ulink url="&biber-download-ftp;"/></para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download MD5 sum: &biber-md5sum;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Download size: &biber-size;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Estimated disk space required: &biber-buildsize;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>Estimated build time: &biber-time;</para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
[a0751bdc] | 68 | <bridgehead renderas="sect3">Required Additional Download</bridgehead>
|
---|
| 69 |
|
---|
| 70 |
|
---|
| 71 | <itemizedlist spacing="compact">
|
---|
| 72 | <listitem>
|
---|
| 73 | <para>The corresponding version of <application>biblatex</application> is
|
---|
| 74 | a separate project - the tds tarball is pre-packaged for untarring into
|
---|
| 75 | the <filename class="directory">texmf-dist</filename> directory.
|
---|
| 76 | Download (HTTP): <ulink url="&biblatex-download-http;"/></para>
|
---|
| 77 | </listitem>
|
---|
| 78 | <listitem>
|
---|
| 79 | <para>Download MD5 sum: &biblatex-md5sum;</para>
|
---|
| 80 | </listitem>
|
---|
| 81 | <listitem>
|
---|
| 82 | <para>Download size: &biblatex-size;</para>
|
---|
| 83 | </listitem>
|
---|
| 84 | </itemizedlist>
|
---|
[c5a4b23] | 85 |
|
---|
[a9ee0599] | 86 | <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
|
---|
| 87 |
|
---|
| 88 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 89 | <para role="required">
|
---|
[145cccdf] | 90 | <!-- KFM: because I always get confused by these deps, I've decided
|
---|
| 91 | to add some comments.
|
---|
| 92 | Both Config::AutoConf and ExtUtils::LibBuilder are listed as build
|
---|
| 93 | requirements in Build.PL, the rest are just requirements, but the
|
---|
| 94 | difference seems moot. Those two are needed to build Text::BibTeX
|
---|
| 95 | so not listed separately. -->
|
---|
[a9ee0599] | 96 | <xref linkend="perl-autovivification"/>
|
---|
| 97 | <xref linkend="perl-business-isbn"/>
|
---|
| 98 | <xref linkend="perl-business-ismn"/>
|
---|
| 99 | <xref linkend="perl-business-issn"/>
|
---|
[35b6a2e] | 100 | <xref linkend="perl-class-accessor"/>
|
---|
[a9ee0599] | 101 | <xref linkend="perl-data-compare"/>
|
---|
[1c80c2c] | 102 | <xref linkend="perl-data-dump"/>
|
---|
[35b6a2e] | 103 | <xref linkend="perl-data-uniqid"/>
|
---|
[a9ee0599] | 104 | <xref linkend="perl-date-simple"/>
|
---|
| 105 | <xref linkend="perl-encode-eucjpascii"/>
|
---|
| 106 | <xref linkend="perl-encode-hanextra"/>
|
---|
| 107 | <xref linkend="perl-encode-jis2k"/>
|
---|
| 108 | <xref linkend="perl-file-slurp"/>
|
---|
[145cccdf] | 109 | <!-- IPC::Cmd is a part of core perl -->
|
---|
[a9ee0599] | 110 | <xref linkend="perl-ipc-run3"/>
|
---|
[145cccdf] | 111 | <!-- LWP::Simple is part of libwww-perl,
|
---|
| 112 | that is pulled in by LWP::Protocol::https -->
|
---|
[a9ee0599] | 113 | <xref linkend="perl-list-allutils"/>
|
---|
[145cccdf] | 114 | <!-- List::MoreUtils was pulled in for the testsuite of List::AllUtils,
|
---|
| 115 | but it needs to be present even if people do not run the tests -->
|
---|
| 116 | <xref linkend="perl-list-moreutils"/>
|
---|
| 117 | <xref linkend="perl-log-log4perl"/>
|
---|
| 118 | <!-- I initially misread LWP-Protocol-https as part of libwww-perl
|
---|
| 119 | when I was preparing this list. In fact, it depends on that -->
|
---|
| 120 | <xref linkend="perl-lwp-protocol-https"/>
|
---|
| 121 | <!-- Module::Build is pulled in by perl-text-bibtex, but mention it explicitly
|
---|
| 122 | so that the note on automatically installing missing dependencies can be run -->
|
---|
[10e632f] | 123 | <xref linkend="perl-module-build"/>
|
---|
[145cccdf] | 124 | <!-- Mozilla::CA is a dependency of LWP-Protocol-https -->
|
---|
[a9ee0599] | 125 | <xref linkend="perl-regexp-common"/>
|
---|
| 126 | <xref linkend="perl-text-bibtex"/>
|
---|
[9385c0fe] | 127 | <xref linkend="perl-text-roman"/>
|
---|
[d0070d69] | 128 | <!-- Collate.pm ships in perl, but is sometimes too old, and we like current
|
---|
| 129 | versions. Make the latest version required so that everyone is using the
|
---|
[9385c0fe] | 130 | same version. In fact, the version in perl-5.20.2 is indeed too old for
|
---|
| 131 | biber-2.0 -->
|
---|
[d0070d69] | 132 | <xref linkend="perl-unicode-collate"/>
|
---|
[145cccdf] | 133 | <!-- Unicode::GCstring is part of Unicode::LineBreak -->
|
---|
[a9ee0599] | 134 | <xref linkend="perl-unicode-linebreak"/>
|
---|
[a953d7d5] | 135 | <xref linkend="perl-unicode-normalize"/>
|
---|
[a9ee0599] | 136 | <xref linkend="perl-xml-libxml-simple"/>
|
---|
[c5a4b23] | 137 | <xref linkend="perl-xml-libxslt"/>
|
---|
| 138 | <xref linkend="perl-xml-writer"/> and
|
---|
[9385c0fe] | 139 | <!-- untarring biblatex requires that the texmf directories already exist -->
|
---|
[c5a4b23] | 140 | <xref linkend="texlive"/>
|
---|
[544c41a] | 141 | (or <xref linkend="tl-installer"/>)
|
---|
[a9ee0599] | 142 | </para>
|
---|
| 143 |
|
---|
[35b6a2e] | 144 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 145 | <para role="optional">
|
---|
| 146 | <xref linkend="perl-file-which"/> and
|
---|
| 147 | <xref linkend="perl-test-differences"/> to run the testsuite
|
---|
[a9ee0599] | 148 | </para>
|
---|
| 149 |
|
---|
| 150 | <note>
|
---|
[33c2d71] | 151 | <!-- when a new release appears, use this para and link to sourceforge,
|
---|
[35b6a2e] | 152 | until we have a versioned copy at anduin. -->
|
---|
[10e632f] | 153 | <para>
|
---|
| 154 | Although the tarball name is unversioned, it will untar to a
|
---|
| 155 | correctly-versioned biblatex-biber-&biber-version; directory.
|
---|
[35b6a2e] | 156 | </para>
|
---|
[10e632f] | 157 |
|
---|
[a9ee0599] | 158 | <para>
|
---|
[35b6a2e] | 159 | It is almost possible to install all missing dependencies automatically.
|
---|
[7b2c94b] | 160 | Except, from <application>perl-5.22.0</application> onwards,
|
---|
[10e632f] | 161 | <xref linkend="perl-module-build"/> is no longer part of
|
---|
[35b6a2e] | 162 | the core perl distribution. And for <xref linkend="perl-data-uniqid"/>
|
---|
| 163 | we have to patch it to skip over a test which always fails - that failing
|
---|
| 164 | test will probably break the automatic install. To automatically install
|
---|
| 165 | the remaining perl dependencies you will need to manually install those
|
---|
| 166 | two modules first.
|
---|
[10e632f] | 167 | You can then run <command>perl ./Build.PL</command> and when it
|
---|
[a9ee0599] | 168 | prompts you, become the root user and run
|
---|
| 169 | <command>./Build installdeps</command>
|
---|
| 170 | </para>
|
---|
[35b6a2e] | 171 | </note>
|
---|
| 172 |
|
---|
| 173 | <note> <!-- remove this note when texlive-2016 is released -->
|
---|
[10e632f] | 174 | <para>
|
---|
[35b6a2e] | 175 | If you use external modules with biber, a change in v2.4 (to
|
---|
| 176 | \DeclareNameFormat) breaks at least some of them - if this applies to
|
---|
| 177 | you, you will need to update the affected module from CTAN.
|
---|
| 178 | </para>
|
---|
[a9ee0599] | 179 | </note>
|
---|
| 180 |
|
---|
| 181 | <para condition="html" role="usernotes">User Notes:
|
---|
[3e90bfe] | 182 | <ulink url='&blfs-wiki;/biber'/></para>
|
---|
[a9ee0599] | 183 |
|
---|
| 184 | </sect2>
|
---|
| 185 |
|
---|
| 186 | <sect2 role="installation">
|
---|
| 187 | <title>Installation of Biber</title>
|
---|
| 188 |
|
---|
| 189 | <para>Install <application>Biber</application> by running the following
|
---|
[7b2c94b] | 190 | commands:</para>
|
---|
[a9ee0599] | 191 |
|
---|
[a953d7d5] | 192 | <screen><userinput>perl ./Build.PL &&
|
---|
[0f304418] | 193 | ./Build</userinput></screen>
|
---|
[a9ee0599] | 194 |
|
---|
[10e632f] | 195 | <para>To test the results, enter: <command>./Build test</command> - you will
|
---|
[35b6a2e] | 196 | require the en_GB.UTF-8 and sv_SE.UTF-8 locales. Test 12 of t/sort-order.t
|
---|
| 197 | will fail : for
|
---|
[a953d7d5] | 198 | speed the tests use system locales instead of the default Unicode::Collation
|
---|
| 199 | algorithm, and some minor details of the locales in OSX (where development
|
---|
| 200 | takes place) differ from those in <application>glibc</application></para>
|
---|
[a9ee0599] | 201 |
|
---|
| 202 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 203 |
|
---|
[59e61f7] | 204 | <screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &&
|
---|
[c5a4b23] | 205 | texhash &&
|
---|
| 206 | ./Build install</userinput></screen>
|
---|
| 207 |
|
---|
| 208 | </sect2>
|
---|
| 209 |
|
---|
| 210 | <sect2 role="commands">
|
---|
| 211 | <title>Command Explanations</title>
|
---|
[10e632f] | 212 |
|
---|
[c5a4b23] | 213 | <para>
|
---|
[0c54cea] | 214 | <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
|
---|
| 215 | /opt/texlive/&texlive-year;/texmf-dist</command>:
|
---|
[9385c0fe] | 216 | this installs the new <application>biblatex</application> files over those
|
---|
| 217 | installed by <application>texlive</application>.
|
---|
[c5a4b23] | 218 | </para>
|
---|
| 219 |
|
---|
| 220 | <para>
|
---|
[0c54cea] | 221 | <command>texhash</command> : this updates the file hash tables (otherwise
|
---|
[c5a4b23] | 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>
|
---|
[a953d7d5] | 238 | <seg>/usr/lib/perl5/site_perl/5.*{,/<arch>-linux/auto}/Biber</seg>
|
---|
[a9ee0599] | 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>
|
---|