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 "https://github.com/plk/biber/archive/v&biber-version;.tar.gz">
|
---|
8 | <!ENTITY biber-download-ftp " ">
|
---|
9 | <!ENTITY biber-md5sum "4956fbf23546b6325647b6c81b2b4bea">
|
---|
10 | <!ENTITY biber-size "1.3 MB">
|
---|
11 | <!-- buildsize includes the installed biblatex -->
|
---|
12 | <!ENTITY biber-buildsize "36 MB">
|
---|
13 | <!ENTITY biber-time "0.3 SBU including 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 "0aa6937010eaaf2154e3ebd00a2fae77">
|
---|
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>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 | &lfs80_checked;
|
---|
43 | &gcc7_checked;
|
---|
44 |
|
---|
45 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
46 | <itemizedlist spacing="compact">
|
---|
47 | <listitem>
|
---|
48 | <para>Download (HTTP): <ulink url="&biber-download-http;"/></para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>Download (FTP): <ulink url="&biber-download-ftp;"/></para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Download MD5 sum: &biber-md5sum;</para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Download size: &biber-size;</para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>Estimated disk space required: &biber-buildsize;</para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>Estimated build time: &biber-time;</para>
|
---|
64 | </listitem>
|
---|
65 | </itemizedlist>
|
---|
66 |
|
---|
67 | <note>
|
---|
68 | <para>
|
---|
69 | The <application>biber</application> source tarball shown above
|
---|
70 | downloads with the correct name, biber-&biber-version;.tar.gz,
|
---|
71 | if using a browser such as Firefox. If you prefer to use a command line
|
---|
72 | program such as wget, you normally would obtain
|
---|
73 | v&biber-version;.tar.gz. To obtain this package with the proper
|
---|
74 | filename, run:
|
---|
75 |
|
---|
76 | <screen><userinput>wget -c &biber-download-http; \
|
---|
77 | -O biber-&biber-version;.tar.gz</userinput></screen>.
|
---|
78 | </para>
|
---|
79 | </note>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect3">Required Additional Download</bridgehead>
|
---|
82 |
|
---|
83 | <itemizedlist spacing="compact">
|
---|
84 | <listitem>
|
---|
85 | <para>The corresponding version of <application>biblatex</application> is
|
---|
86 | a separate project - the tds tarball is pre-packaged for untarring into
|
---|
87 | the <filename class="directory">texmf-dist</filename> directory.
|
---|
88 | Download (HTTP): <ulink url="&biblatex-download-http;"/></para>
|
---|
89 | </listitem>
|
---|
90 | <listitem>
|
---|
91 | <para>Download MD5 sum: &biblatex-md5sum;</para>
|
---|
92 | </listitem>
|
---|
93 | <listitem>
|
---|
94 | <para>Download size: &biblatex-size;</para>
|
---|
95 | </listitem>
|
---|
96 | </itemizedlist>
|
---|
97 |
|
---|
98 | <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
|
---|
99 |
|
---|
100 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
101 | <para role="required">
|
---|
102 | <!-- KFM: because I always get confused by these deps, I've decided
|
---|
103 | to add some comments.
|
---|
104 | Both Config::AutoConf and ExtUtils::LibBuilder are listed as build
|
---|
105 | requirements in Build.PL, the rest are just requirements, but the
|
---|
106 | difference seems moot. Those two are needed to build Text::BibTeX
|
---|
107 | so not listed separately. -->
|
---|
108 | <xref linkend="perl-autovivification"/>
|
---|
109 | <xref linkend="perl-business-isbn"/>
|
---|
110 | <xref linkend="perl-business-ismn"/>
|
---|
111 | <xref linkend="perl-business-issn"/>
|
---|
112 | <xref linkend="perl-class-accessor"/>
|
---|
113 | <xref linkend="perl-data-compare"/>
|
---|
114 | <xref linkend="perl-data-dump"/>
|
---|
115 | <xref linkend="perl-data-uniqid"/>
|
---|
116 | <xref linkend="perl-datetime-calendar-julian"/>
|
---|
117 | <xref linkend="perl-datetime-format-builder"/>
|
---|
118 | <xref linkend="perl-encode-eucjpascii"/>
|
---|
119 | <xref linkend="perl-encode-hanextra"/>
|
---|
120 | <xref linkend="perl-encode-jis2k"/>
|
---|
121 | <xref linkend="perl-file-slurp"/>
|
---|
122 | <!-- IPC::Cmd is a part of core perl -->
|
---|
123 | <xref linkend="perl-ipc-run3"/>
|
---|
124 | <xref linkend="perl-lingua-translit"/>
|
---|
125 | <xref linkend="perl-list-allutils"/>
|
---|
126 | <!-- List::MoreUtils was pulled in for the testsuite of List::AllUtils,
|
---|
127 | but it needs to be present even if people do not run the tests -->
|
---|
128 | <xref linkend="perl-list-moreutils"/>
|
---|
129 | <!-- List::MoreUtils::XS is listed as a dep, but it is part of
|
---|
130 | List::MoreUtils -->
|
---|
131 | <xref linkend="perl-log-log4perl"/>
|
---|
132 | <!-- I initially misread LWP-Protocol-https as part of libwww-perl
|
---|
133 | when I was preparing this list. In fact, it depends on that -->
|
---|
134 | <xref linkend="perl-lwp-protocol-https"/>
|
---|
135 | <!-- LWP::Simple is part of libwww-perl,
|
---|
136 | that is pulled in by LWP::Protocol::https -->
|
---|
137 | <!-- Module::Build is pulled in by perl-text-bibtex, but mention it explicitly
|
---|
138 | so that the note on automatically installing missing dependencies can be run -->
|
---|
139 | <xref linkend="perl-module-build"/>
|
---|
140 | <!-- Mozilla::CA is a dependency of LWP-Protocol-https -->
|
---|
141 | <xref linkend="perl-regexp-common"/>
|
---|
142 | <xref linkend="perl-sort-key"/>
|
---|
143 | <xref linkend="perl-text-bibtex"/>
|
---|
144 | <xref linkend="perl-text-csv"/>
|
---|
145 | <!-- Text-CSV_XS is a recommended dependency for Text-CSV -->
|
---|
146 | <xref linkend="perl-text-roman"/>
|
---|
147 | <!-- Unicode-Collate usually needs to be latest, core perl is older -->
|
---|
148 | <xref linkend="perl-unicode-collate"/>
|
---|
149 | <!-- Unicode::GCstring is part of Unicode::LineBreak -->
|
---|
150 | <xref linkend="perl-unicode-linebreak"/>
|
---|
151 | <xref linkend="perl-xml-libxml-simple"/>
|
---|
152 | <xref linkend="perl-xml-libxslt"/>
|
---|
153 | <xref linkend="perl-xml-writer"/> and
|
---|
154 | <!-- untarring biblatex requires that the texmf directories already exist -->
|
---|
155 | <xref linkend="texlive"/>
|
---|
156 | (or <xref linkend="tl-installer"/>)
|
---|
157 | </para>
|
---|
158 |
|
---|
159 | <note> <!-- FIXME remove this after our 8.0 release, so that it is noted
|
---|
160 | in at least one release of the book -->
|
---|
161 | <para>This version of <application>biber</application> requires at least
|
---|
162 | <application>perl-5.24.0</application>. If you are using an older version
|
---|
163 | of <command>perl</command> you may prefer to install v2.5 - for that see
|
---|
164 | the BLFS-7.10 book (that source is now in
|
---|
165 | <filename class="directory">files/biblatex-biber/2.5/</filename> instead of
|
---|
166 | <filename class="directory">files/biblatex-biber/current/</filename>).</para>
|
---|
167 | </note>
|
---|
168 |
|
---|
169 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
170 | <para role="optional">
|
---|
171 | <xref linkend="perl-file-which"/> and
|
---|
172 | <xref linkend="perl-test-differences"/> to run the testsuite
|
---|
173 | </para>
|
---|
174 |
|
---|
175 | <note>
|
---|
176 | <para>
|
---|
177 | It is possible to install all missing dependencies automatically.
|
---|
178 | But from <application>perl-5.22.0</application> onwards,
|
---|
179 | <xref linkend="perl-module-build"/> is no longer part of the core perl
|
---|
180 | distribution. And for <xref linkend="perl-data-uniqid"/> we have to
|
---|
181 | patch it to skip over a test which always fails - that failing test may
|
---|
182 | break the automatic install. To automatically install the remaining perl
|
---|
183 | dependencies you can install those two modules first using <xref
|
---|
184 | linkend="perl-auto-install"/>. then run <command>perl ./Build.PL</command>
|
---|
185 | and when it prompts you, become the root user and run
|
---|
186 | <command>./Build installdeps</command>
|
---|
187 | </para>
|
---|
188 | </note>
|
---|
189 |
|
---|
190 | <para condition="html" role="usernotes">User Notes:
|
---|
191 | <ulink url='&blfs-wiki;/biber'/></para>
|
---|
192 |
|
---|
193 | </sect2>
|
---|
194 |
|
---|
195 | <sect2 role="installation">
|
---|
196 | <title>Installation of Biber</title>
|
---|
197 |
|
---|
198 | <para>Install <application>Biber</application> by running the following
|
---|
199 | commands:</para>
|
---|
200 |
|
---|
201 | <screen><userinput>perl ./Build.PL &&
|
---|
202 | ./Build</userinput></screen>
|
---|
203 |
|
---|
204 | <para>To test the results, enter: <command>./Build test</command></para>
|
---|
205 |
|
---|
206 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
207 |
|
---|
208 | <screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &&
|
---|
209 | texhash &&
|
---|
210 | ./Build install</userinput></screen>
|
---|
211 |
|
---|
212 | </sect2>
|
---|
213 |
|
---|
214 | <sect2 role="commands">
|
---|
215 | <title>Command Explanations</title>
|
---|
216 |
|
---|
217 | <para>
|
---|
218 | <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
|
---|
219 | /opt/texlive/&texlive-year;/texmf-dist</command>:
|
---|
220 | this installs the new <application>biblatex</application> files over those
|
---|
221 | installed by <application>texlive</application>.
|
---|
222 | </para>
|
---|
223 |
|
---|
224 | <para>
|
---|
225 | <command>texhash</command> : this updates the file hash tables (otherwise
|
---|
226 | known as the file name database).
|
---|
227 | </para>
|
---|
228 |
|
---|
229 | </sect2>
|
---|
230 |
|
---|
231 | <sect2 role="content">
|
---|
232 | <title>Contents</title>
|
---|
233 |
|
---|
234 | <segmentedlist>
|
---|
235 | <segtitle>Installed Programs</segtitle>
|
---|
236 | <segtitle>Installed Library</segtitle>
|
---|
237 | <segtitle>Installed Directory</segtitle>
|
---|
238 |
|
---|
239 | <seglistitem>
|
---|
240 | <seg>biber</seg>
|
---|
241 | <seg>None</seg>
|
---|
242 | <seg>/usr/lib/perl5/site_perl/5.*{,/<arch>-linux/auto}/Biber</seg>
|
---|
243 | </seglistitem>
|
---|
244 | </segmentedlist>
|
---|
245 |
|
---|
246 | <variablelist>
|
---|
247 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
248 | <?dbfo list-presentation="list"?>
|
---|
249 | <?dbhtml list-presentation="table"?>
|
---|
250 |
|
---|
251 | <varlistentry id="biber-prog">
|
---|
252 | <term><command>biber</command></term>
|
---|
253 | <listitem>
|
---|
254 | <para>is used for producing bibliographies in LaTeX documents.</para>
|
---|
255 | <indexterm zone="biber biber-prog">
|
---|
256 | <primary sortas="b-biber">biber</primary>
|
---|
257 | </indexterm>
|
---|
258 | </listitem>
|
---|
259 | </varlistentry>
|
---|
260 |
|
---|
261 | </variablelist>
|
---|
262 |
|
---|
263 | </sect2>
|
---|
264 |
|
---|
265 | </sect1>
|
---|