source: pst/typesetting/biber.xml@ a41bb164

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since a41bb164 was a41bb164, checked in by Ken Moffat <ken@…>, 10 months ago

Update to dvisvgm-2.11
Patch biber-2.15 so that tests pass with Unicode::Collate-1.29.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23991 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 12.6 KB
Line 
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<!--
8 When a proper url is not evident, github will download with
9 https://github.com/ <path> /archive/<version>/<name>-<version>.tar.<compression>
10
11 <!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;.tar.gz">
12-->
13 <!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;/biber-&biber-version;.tar.gz">
14 <!ENTITY biber-download-ftp " ">
15 <!ENTITY biber-md5sum "3c964253bcab6c0af9acd3d2b3f501c2">
16 <!ENTITY biber-size "1.6 MB">
17 <!-- Buildsize includes the installed biblatex, except that what matters is
18 the difference from the files shipped by texlive, so usually the addition is
19 minimal. Copy full texmf to somewhere for working, measure with du -shm,
20 then install biblatex over the top of it and remeasure.
21 For 3.15a, texmf grows by 2MB -->
22 <!ENTITY biber-buildsize "18 MB">
23 <!ENTITY biber-time "0.4 SBU including tests">
24
25 <!-- Check path. Directory might not be &biblatex-version; if a suffixed update -->
26 <!-- for normal unsuffixed version:
27 <!ENTITY biblatex-download-http "http://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz"> -->
28 <!ENTITY biblatex-download-http "http://sourceforge.net/projects/biblatex/files/biblatex-3.15/biblatex-&biblatex-version;.tds.tgz">
29 <!ENTITY biblatex-download-ftp "">
30 <!ENTITY biblatex-md5sum "f27db2896d485c2c138fcc42e03a2f1c">
31 <!ENTITY biblatex-size "20 MB">
32
33]>
34
35<sect1 id="biber" xreflabel="biber-&biber-version;">
36 <?dbhtml filename="biber.html"?>
37
38 <sect1info>
39 <othername>$LastChangedBy$</othername>
40 <date>$Date$</date>
41 </sect1info>
42
43 <title>biber-&biber-version;</title>
44
45 <indexterm zone="biber">
46 <primary sortas="a-biber">Biber</primary>
47 </indexterm>
48
49 <sect2 role="package">
50 <title>Introduction to biber</title>
51
52 <para>
53 Biber is a BibTeX replacement for users of biblatex, written in
54 <application>Perl</application>, with full Unicode support.
55 </para>
56
57 &lfs10_checked;
58
59 <!-- note for editors: you can test this by using the latest version
60 of the latex-test tarball from
61 http://www.linuxfromscratch.org/~ken/tex-testfiles/
62 using ./configure (to create the Makefile) and then making the
63 following targets:
64 biblatex-unibiber and biblatex-biber (these just use pdflatex
65 and biber, biblatex-unibiber is more important, it uses UTF-8)
66 bibxelatex (uses xelatex and biber, needs TTF or OTF fonts and
67 in particular coverage of simplified Chinese and Japanese, and
68 optionally Korean - installed fonts for CJK can be specified to
69 configure if they are not found)
70 remote1 and remote2 (pdflatex and biber, for use with manually
71 installed perl modules, i.e. without Mozilla::CA, to prove that
72 remote references work).
73 In all cases the output PDF should include references at the
74 end, the Makefile does not check that for the remote tests. -->
75
76 <bridgehead renderas="sect3">Package Information</bridgehead>
77 <itemizedlist spacing="compact">
78 <listitem>
79 <para>
80 Download (HTTP): <ulink url="&biber-download-http;"/>
81 </para>
82 </listitem>
83 <listitem>
84 <para>
85 Download (FTP): <ulink url="&biber-download-ftp;"/>
86 </para>
87 </listitem>
88 <listitem>
89 <para>
90 Download MD5 sum: &biber-md5sum;
91 </para>
92 </listitem>
93 <listitem>
94 <para>
95 Download size: &biber-size;
96 </para>
97 </listitem>
98 <listitem>
99 <para>
100 Estimated disk space required: &biber-buildsize;
101 </para>
102 </listitem>
103 <listitem>
104 <para>
105 Estimated build time: &biber-time;
106 </para>
107 </listitem>
108 </itemizedlist>
109
110 <note>
111<!--
112 <para>
113 The <application>biber</application> source tarball shown above
114 downloads with the correct name, biber-&biber-version;.tar.gz,
115 if using a browser such as Firefox. If you prefer to use a command line
116 program such as wget, you normally would obtain
117 v&biber-version;.tar.gz. To obtain this package with the proper
118 filename, run:
119
120<screen><userinput>wget -c &biber-download-http; \
121 -O biber-&biber-version;.tar.gz</userinput></screen>.
122 </para>
123-->
124 <para>
125 If you have updated to a new release of texlive-source, biber and its
126 perl dependencies are still present in <filename
127 class="directory">/usr</filename> and do not need to be rebuilt.
128 However, biblatex installs in <filename
129 class="directory">/opt/texlive/&texlive-year;</filename> and does
130 need to be reinstalled.
131 </para>
132
133 <para>
134 If you installed the above dependencies using the BLFS instructions
135 for each of them, <command>perl ./Build.PL</command> will complain
136 that Mozilla::CA is not installed, but that is not needed unless
137 CPAN was used to install the modules. BLFS patches LWP::Protocol::https
138 to use the system certificates, Mozilla::CA uses old certificates.
139 </para>
140
141<!-- <para> ##commented as a reminder that sooner or later it will need a
142 newer version than our current or last but one release ##
143 This version of biber requires <application>perl-5.30</application>
144 or later. If you are still using the 8.4 version of BLFS you may
145 wish to build the 2.13 version: see the 8.4 book noting that
146 biblatex-3.13 has been replaced by biblatex-3.13a upstream.
147 </para>-->
148 </note>
149
150 <bridgehead renderas="sect3">Required Additional Downloads</bridgehead>
151
152 <itemizedlist spacing="compact">
153 <listitem>
154 <para>
155 The corresponding version of <application>biblatex</application> is
156 a separate project - the tds tarball is pre-packaged for untarring
157 into the <filename class="directory">texmf-dist</filename>
158 directory. Download (HTTP): <ulink url="&biblatex-download-http;"/>
159 </para>
160 </listitem>
161 <listitem>
162 <para>
163 Download MD5 sum: &biblatex-md5sum;
164 </para>
165 </listitem>
166 <listitem>
167 <para>
168 Download size: &biblatex-size;
169 </para>
170 </listitem>
171 <listitem>
172 <para>
173 Required patch:
174 <ulink url="&patch-root;/biber-&biber-version;-test_fixes-1.patch"/>
175 </para>
176 </listitem>
177 </itemizedlist>
178
179 <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
180
181 <bridgehead renderas="sect4">Required</bridgehead>
182 <para role="required">
183 <!-- KFM: the order listed in Build.PL is not alphabetical -->
184 <xref linkend="perl-autovivification"/>
185 <xref linkend="perl-business-isbn"/>
186 <xref linkend="perl-business-ismn"/>
187 <xref linkend="perl-business-issn"/>
188 <xref linkend="perl-class-accessor"/>
189 <xref linkend="perl-data-compare"/>
190 <xref linkend="perl-data-dump"/>
191 <xref linkend="perl-data-uniqid"/>
192 <xref linkend="perl-datetime-calendar-julian"/>
193 <xref linkend="perl-datetime-format-builder"/>
194 <xref linkend="perl-encode-eucjpascii"/>
195 <xref linkend="perl-encode-hanextra"/>
196 <xref linkend="perl-encode-jis2k"/>
197 <xref linkend="perl-file-slurper"/>
198 <xref linkend="perl-io-string"/>
199 <!-- IPC::Cmd is a part of core perl -->
200 <xref linkend="perl-ipc-run3"/>
201 <xref linkend="perl-lingua-translit"/>
202 <xref linkend="perl-list-allutils"/>
203 <xref linkend="perl-list-moreutils"/>
204 <!-- perl-list-moreutils-xs is a dep of perl-list-moreutils -->
205 <xref linkend="perl-log-log4perl"/>
206 <xref linkend="perl-lwp-protocol-https"/>
207 <!-- LWP::Simple is part of perl-libwww-perl,
208 that is pulled in by perl-lwp-protocol-https
209 and that pulls in perl-uri -->
210 <xref linkend="perl-module-build"/>
211 <xref linkend="perl-parse-recdescent"/>
212 <xref linkend="perl-perlio-utf8_strict"/>
213 <!-- Mozilla::CA should not be needed when using system certificates -->
214 <xref linkend="perl-regexp-common"/>
215 <xref linkend="perl-sort-key"/>
216 <xref linkend="perl-text-bibtex"/>
217 <xref linkend="perl-text-csv"/>
218 <!-- perl-text-csv_xs is a recommended dependency for perl-text-csv -->
219 <xref linkend="perl-text-roman"/>
220 <!-- Unicode-Collate usually needs to be latest when biber is released,
221 core perl is usually older. To read the core version, look at
222 /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Collate.pm -->
223 <xref linkend="perl-unicode-collate"/>
224 <!-- Unicode::GCstring is part of Unicode::LineBreak -->
225 <xref linkend="perl-unicode-linebreak"/>
226 <!-- Unicode::Normalize is part of core perl, found in
227 /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Normalize.pm -->
228 <!-- perl-xml-libxml is a dependency of perl-xml-libxml-simple -->
229 <xref linkend="perl-xml-libxml-simple"/>
230 <xref linkend="perl-xml-libxslt"/>
231 <xref linkend="perl-xml-writer"/> and
232 <!-- untarring biblatex requires that the texmf directories already exist -->
233 <xref linkend="texlive"/>
234 (or <xref linkend="tl-installer"/>, but for that you can use
235 <command>tlmgr update</command>)
236 </para>
237
238 <bridgehead renderas="sect4">Recommended (required for the testsuite)</bridgehead>
239 <para role="recommended">
240 <xref linkend="perl-file-which"/> and
241 <xref linkend="perl-test-differences"/>
242 </para>
243
244 <note>
245 <para>
246 It is possible to install all missing dependencies automatically. You
247 must first install <xref linkend="perl-module-build"/> using <xref
248 linkend="perl-auto-install"/>. Then run <command>perl
249 ./Build.PL</command> and when it prompts you, become the root user
250 and run <command>./Build installdeps</command> - this will use CPAN
251 and as noted above it will use Mozilla::CA instead of using system
252 certificates.
253 </para>
254 </note>
255
256 <para condition="html" role="usernotes">User Notes:
257 <ulink url='&blfs-wiki;/biber'/></para>
258
259 </sect2>
260
261 <sect2 role="installation">
262 <title>Installation of Biber</title>
263
264 <para>
265 Install <application>Biber</application> by running the following
266 commands:
267 </para>
268
269 <para>
270 First apply a patch so that the testsuite will pass with
271 the changes to hash formats in Unicode::Collates-1.29:
272 </para>
273
274<screen><userinput remap="pre">patch -p1 -i ../biber-&biber-version;-test_fixes-1.patch</userinput></screen>
275
276<screen><userinput>perl ./Build.PL &amp;&amp;
277./Build</userinput></screen>
278
279 <para>
280 To test the results, enter: <command>./Build test</command>
281 </para>
282
283 <para>
284 Now, as the <systemitem class="username">root</systemitem> user:
285 </para>
286
287<screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &amp;&amp;
288texhash &amp;&amp;
289./Build install</userinput></screen>
290
291 </sect2>
292
293 <sect2 role="commands">
294 <title>Command Explanations</title>
295
296 <para>
297 <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
298 /opt/texlive/&texlive-year;/texmf-dist</command>:
299 this installs the new <application>biblatex</application> files over those
300 installed by <application>texlive</application>.
301 </para>
302
303 <para>
304 <command>texhash</command> : this updates the file hash tables (otherwise
305 known as the file name database).
306 </para>
307
308 </sect2>
309
310 <sect2 role="content">
311 <title>Contents</title>
312
313 <segmentedlist>
314 <segtitle>Installed Programs</segtitle>
315 <segtitle>Installed Library</segtitle>
316 <segtitle>Installed Directory</segtitle>
317
318 <seglistitem>
319 <seg>biber</seg>
320 <seg>None</seg>
321 <seg>/usr/lib/perl5/site_perl/5.*{,/&lt;arch&gt;-linux/auto}/Biber</seg>
322 </seglistitem>
323 </segmentedlist>
324
325 <variablelist>
326 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
327 <?dbfo list-presentation="list"?>
328 <?dbhtml list-presentation="table"?>
329
330 <varlistentry id="biber-prog">
331 <term><command>biber</command></term>
332 <listitem>
333 <para>
334 is used for producing bibliographies in LaTeX documents.
335 </para>
336 <indexterm zone="biber biber-prog">
337 <primary sortas="b-biber">biber</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 </variablelist>
343
344 </sect2>
345
346</sect1>
Note: See TracBrowser for help on using the repository browser.