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 |
|
---|
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 "530368acb20b0881e13d7df0e5976e11">
|
---|
10 | <!ENTITY biber-size "1.1 MB">
|
---|
11 | <!-- buildsize includes the installed biblatex -->
|
---|
12 | <!ENTITY biber-buildsize "32 MB">
|
---|
13 | <!ENTITY biber-time "less than 0.1 SBU (0.8 SBU to run the tests)">
|
---|
14 |
|
---|
15 | <!ENTITY biblatex-download-http "http://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz">
|
---|
16 | <!ENTITY biblatex-download-ftp "">
|
---|
17 | <!ENTITY biblatex-md5sum "75321553c70697a213607b89f728e15d">
|
---|
18 | <!ENTITY biblatex-size "19 MB">
|
---|
19 |
|
---|
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
|
---|
40 | <application>Perl</application>, with full Unicode support.</para>
|
---|
41 |
|
---|
42 | &lfs78_checked;
|
---|
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 |
|
---|
66 | <bridgehead renderas="sect3">Required Additional Download</bridgehead>
|
---|
67 |
|
---|
68 |
|
---|
69 | <itemizedlist spacing="compact">
|
---|
70 | <listitem>
|
---|
71 | <para>The corresponding version of <application>biblatex</application> is
|
---|
72 | a separate project - the tds tarball is pre-packaged for untarring into
|
---|
73 | the <filename class="directory">texmf-dist</filename> directory.
|
---|
74 | Download (HTTP): <ulink url="&biblatex-download-http;"/></para>
|
---|
75 | </listitem>
|
---|
76 | <listitem>
|
---|
77 | <para>Download MD5 sum: &biblatex-md5sum;</para>
|
---|
78 | </listitem>
|
---|
79 | <listitem>
|
---|
80 | <para>Download size: &biblatex-size;</para>
|
---|
81 | </listitem>
|
---|
82 | </itemizedlist>
|
---|
83 |
|
---|
84 | <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
87 | <para role="required">
|
---|
88 | <!-- KFM: because I always get confused by these deps, I've decided
|
---|
89 | to add some comments.
|
---|
90 | Both Config::AutoConf and ExtUtils::LibBuilder are listed as build
|
---|
91 | requirements in Build.PL, the rest are just requirements, but the
|
---|
92 | difference seems moot. Those two are needed to build Text::BibTeX
|
---|
93 | so not listed separately. -->
|
---|
94 | <xref linkend="perl-autovivification"/>
|
---|
95 | <xref linkend="perl-business-isbn"/>
|
---|
96 | <xref linkend="perl-business-ismn"/>
|
---|
97 | <xref linkend="perl-business-issn"/>
|
---|
98 | <xref linkend="perl-class-accessor"/>
|
---|
99 | <xref linkend="perl-data-compare"/>
|
---|
100 | <xref linkend="perl-data-dump"/>
|
---|
101 | <xref linkend="perl-data-uniqid"/>
|
---|
102 | <xref linkend="perl-date-simple"/>
|
---|
103 | <xref linkend="perl-encode-eucjpascii"/>
|
---|
104 | <xref linkend="perl-encode-hanextra"/>
|
---|
105 | <xref linkend="perl-encode-jis2k"/>
|
---|
106 | <xref linkend="perl-file-slurp"/>
|
---|
107 | <!-- IPC::Cmd is a part of core perl -->
|
---|
108 | <xref linkend="perl-ipc-run3"/>
|
---|
109 | <!-- LWP::Simple is part of libwww-perl,
|
---|
110 | that is pulled in by LWP::Protocol::https -->
|
---|
111 | <xref linkend="perl-list-allutils"/>
|
---|
112 | <!-- List::MoreUtils was pulled in for the testsuite of List::AllUtils,
|
---|
113 | but it needs to be present even if people do not run the tests -->
|
---|
114 | <xref linkend="perl-list-moreutils"/>
|
---|
115 | <xref linkend="perl-log-log4perl"/>
|
---|
116 | <!-- I initially misread LWP-Protocol-https as part of libwww-perl
|
---|
117 | when I was preparing this list. In fact, it depends on that -->
|
---|
118 | <xref linkend="perl-lwp-protocol-https"/>
|
---|
119 | <!-- Module::Build is pulled in by perl-text-bibtex, but mention it explicitly
|
---|
120 | so that the note on automatically installing missing dependencies can be run -->
|
---|
121 | <xref linkend="perl-module-build"/>
|
---|
122 | <!-- Mozilla::CA is a dependency of LWP-Protocol-https -->
|
---|
123 | <xref linkend="perl-regexp-common"/>
|
---|
124 | <xref linkend="perl-text-bibtex"/>
|
---|
125 | <xref linkend="perl-text-roman"/>
|
---|
126 | <!-- Collate.pm ships in perl, but is sometimes too old, and we like current
|
---|
127 | versions. Make the latest version required so that everyone is using the
|
---|
128 | same version. In fact, the version in perl-5.20.2 is indeed too old for
|
---|
129 | biber-2.0 -->
|
---|
130 | <xref linkend="perl-unicode-collate"/>
|
---|
131 | <!-- Unicode::GCstring is part of Unicode::LineBreak -->
|
---|
132 | <xref linkend="perl-unicode-linebreak"/>
|
---|
133 | <xref linkend="perl-unicode-normalize"/>
|
---|
134 | <xref linkend="perl-xml-libxml-simple"/>
|
---|
135 | <xref linkend="perl-xml-libxslt"/>
|
---|
136 | <xref linkend="perl-xml-writer"/> and
|
---|
137 | <!-- untarring biblatex requires that the texmf directories already exist -->
|
---|
138 | <xref linkend="texlive"/>
|
---|
139 | (or <xref linkend="tl-installer"/>)
|
---|
140 | </para>
|
---|
141 |
|
---|
142 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
143 | <para role="optional">
|
---|
144 | <xref linkend="perl-file-which"/> and
|
---|
145 | <xref linkend="perl-test-differences"/> to run the testsuite.
|
---|
146 | </para>
|
---|
147 |
|
---|
148 | <note>
|
---|
149 | <!-- when a new release appears, use this para and link to sourceforge,
|
---|
150 | until we have a versioned copy at anduin. -->
|
---|
151 | <para>
|
---|
152 | Although the tarball name is unversioned, it will untar to a
|
---|
153 | correctly-versioned biblatex-biber-&biber-version; directory.
|
---|
154 | </para>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | It is almost possible to install (all) missing dependencies automatically.
|
---|
158 | Except, from <application>perl-5.22.0</application> onwards,
|
---|
159 | <xref linkend="perl-module-build"/> is no longer part of
|
---|
160 | the core perl distribution. And for <xref linkend="perl-data-uniqid"/>
|
---|
161 | we have to patch it to skip over a test which always fails - that
|
---|
162 | failing test will probably break the automatic install. To
|
---|
163 | automatically install the remaining perl dependencies you will need
|
---|
164 | to manually install those modules first.
|
---|
165 | You can then run <command>perl ./Build.PL</command> and when it
|
---|
166 | prompts you, become the root user and run
|
---|
167 | <command>./Build installdeps</command>
|
---|
168 | </para>
|
---|
169 | </note>
|
---|
170 |
|
---|
171 | <note> <!-- remove this when texlive-2016 is released. -->
|
---|
172 | <para>
|
---|
173 | If you use external modules with biber, a change in v2.4 (to
|
---|
174 | \DeclareNameFormat) breaks at least some of them - if this applies to
|
---|
175 | you, you will need to update the affected module from CPAN.
|
---|
176 | </para>
|
---|
177 | </note>
|
---|
178 |
|
---|
179 | <para condition="html" role="usernotes">User Notes:
|
---|
180 | <ulink url='&blfs-wiki;/biber'/></para>
|
---|
181 |
|
---|
182 | </sect2>
|
---|
183 |
|
---|
184 | <sect2 role="installation">
|
---|
185 | <title>Installation of Biber</title>
|
---|
186 |
|
---|
187 | <para>Install <application>Biber</application> by running the following
|
---|
188 | commands:</para>
|
---|
189 |
|
---|
190 | <screen><userinput>perl ./Build.PL &&
|
---|
191 | ./Build</userinput></screen>
|
---|
192 |
|
---|
193 | <para>To test the results, enter: <command>./Build test</command> - you will
|
---|
194 | require the en_GB.UTF-8 and sv_SE.UTF-8 locales. Test 12 of t/sort-order.t
|
---|
195 | will fail : for
|
---|
196 | speed the tests use system locales instead of the default Unicode::Collation
|
---|
197 | algorithm, and some minor details of the locales in OSX (where development
|
---|
198 | takes place) differ from those in <application>glibc</application></para>
|
---|
199 |
|
---|
200 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
201 |
|
---|
202 | <screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &&
|
---|
203 | texhash &&
|
---|
204 | ./Build install</userinput></screen>
|
---|
205 |
|
---|
206 | </sect2>
|
---|
207 |
|
---|
208 | <sect2 role="commands">
|
---|
209 | <title>Command Explanations</title>
|
---|
210 |
|
---|
211 | <para>
|
---|
212 | <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
|
---|
213 | /opt/texlive/&texlive-year;/texmf-dist</command>:
|
---|
214 | this installs the new <application>biblatex</application> files over those
|
---|
215 | installed by <application>texlive</application>.
|
---|
216 | </para>
|
---|
217 |
|
---|
218 | <para>
|
---|
219 | <command>texhash</command> : this updates the file hash tables (otherwise
|
---|
220 | known as the file name database).
|
---|
221 | </para>
|
---|
222 |
|
---|
223 | </sect2>
|
---|
224 |
|
---|
225 | <sect2 role="content">
|
---|
226 | <title>Contents</title>
|
---|
227 |
|
---|
228 | <segmentedlist>
|
---|
229 | <segtitle>Installed Programs</segtitle>
|
---|
230 | <segtitle>Installed Library</segtitle>
|
---|
231 | <segtitle>Installed Directory</segtitle>
|
---|
232 |
|
---|
233 | <seglistitem>
|
---|
234 | <seg>biber</seg>
|
---|
235 | <seg>None</seg>
|
---|
236 | <seg>/usr/lib/perl5/site_perl/5.*{,/<arch>-linux/auto}/Biber</seg>
|
---|
237 | </seglistitem>
|
---|
238 | </segmentedlist>
|
---|
239 |
|
---|
240 | <variablelist>
|
---|
241 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
242 | <?dbfo list-presentation="list"?>
|
---|
243 | <?dbhtml list-presentation="table"?>
|
---|
244 |
|
---|
245 | <varlistentry id="biber-prog">
|
---|
246 | <term><command>biber</command></term>
|
---|
247 | <listitem>
|
---|
248 | <para>is used for producing bibliographies in LaTeX documents.</para>
|
---|
249 | <indexterm zone="biber biber-prog">
|
---|
250 | <primary sortas="b-biber">biber</primary>
|
---|
251 | </indexterm>
|
---|
252 | </listitem>
|
---|
253 | </varlistentry>
|
---|
254 |
|
---|
255 | </variablelist>
|
---|
256 |
|
---|
257 | </sect2>
|
---|
258 |
|
---|
259 | </sect1>
|
---|