1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 "a7f400cdac3a3d9d9ab13ca053eb6791">
|
---|
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.16, texmf grew by 3MB -->
|
---|
22 | <!ENTITY biber-buildsize "15 MB (installs 1.6MB of perl modules)"> <!-- only include biblatex size if texmf grows -->
|
---|
23 | <!ENTITY biber-time "0.4 SBU including tests">
|
---|
24 |
|
---|
25 | <!-- FIXME - ok to comment biblatex when version for a new year matches
|
---|
26 | what is in texmf-dist. For new version, reinstate to avoid runtime error.
|
---|
27 | The texmf version is at 'revision=' in texmf/doc/latex/biblatex/biblatex.tex -->
|
---|
28 | <!-- Check path. Directory might not be &biblatex-version; if a suffixed update -->
|
---|
29 |
|
---|
30 | <!ENTITY biblatex-download-http "https://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz">
|
---|
31 | <!ENTITY biblatex-download-ftp "">
|
---|
32 | <!ENTITY biblatex-md5sum "6c4117fd06e12854495a3777523d5372">
|
---|
33 | <!ENTITY biblatex-size "19 MB">
|
---|
34 | <!-- this usually overwrites files in texmf-dist¸use du -sm to measure
|
---|
35 | before and after - 'buildsize' might easily be unchanged, or add to biber above -->
|
---|
36 | <!-- Unchanged for 3.20, it overwrote everything from 3.19 and rounded to same size -->
|
---|
37 | ]>
|
---|
38 |
|
---|
39 | <sect1 id="biber" xreflabel="biber-&biber-version;">
|
---|
40 | <?dbhtml filename="biber.html"?>
|
---|
41 |
|
---|
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 | &lfs122_checked;
|
---|
58 |
|
---|
59 | <!-- note for editors: FIXME please test this by using the latest
|
---|
60 | version of the latex-test tarball from
|
---|
61 | https://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 | The biblatex-biber test only uses latex, trad markup, and
|
---|
76 | biber, biblatex.
|
---|
77 | -->
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
80 | <itemizedlist spacing="compact">
|
---|
81 | <listitem>
|
---|
82 | <para>
|
---|
83 | Download (HTTP): <ulink url="&biber-download-http;"/>
|
---|
84 | </para>
|
---|
85 | </listitem>
|
---|
86 | <listitem>
|
---|
87 | <para>
|
---|
88 | Download (FTP): <ulink url="&biber-download-ftp;"/>
|
---|
89 | </para>
|
---|
90 | </listitem>
|
---|
91 | <listitem>
|
---|
92 | <para>
|
---|
93 | Download MD5 sum: &biber-md5sum;
|
---|
94 | </para>
|
---|
95 | </listitem>
|
---|
96 | <listitem>
|
---|
97 | <para>
|
---|
98 | Download size: &biber-size;
|
---|
99 | </para>
|
---|
100 | </listitem>
|
---|
101 | <listitem>
|
---|
102 | <para>
|
---|
103 | Estimated disk space required: &biber-buildsize;
|
---|
104 | </para>
|
---|
105 | </listitem>
|
---|
106 | <listitem>
|
---|
107 | <para>
|
---|
108 | Estimated build time: &biber-time;
|
---|
109 | </para>
|
---|
110 | </listitem>
|
---|
111 | </itemizedlist>
|
---|
112 |
|
---|
113 | <note>
|
---|
114 | <para>
|
---|
115 | If you have updated to a new release of texlive-source, biber and its
|
---|
116 | perl dependencies are still present in <filename
|
---|
117 | class="directory">/usr</filename> and do not need to be rebuilt.
|
---|
118 | However, biblatex installs in <filename
|
---|
119 | class="directory">/opt/texlive/&texlive-year;</filename> and does
|
---|
120 | need to be reinstalled.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | <para>
|
---|
124 | If you installed the above dependencies using the BLFS instructions
|
---|
125 | for each of them, <command>perl ./Build.PL</command> will complain
|
---|
126 | that Mozilla::CA is not installed, but that is not needed unless
|
---|
127 | CPAN was used to install the modules. BLFS patches LWP::Protocol::https
|
---|
128 | to use the system certificates, Mozilla::CA uses old certificates.
|
---|
129 | </para>
|
---|
130 |
|
---|
131 | <!-- <para> ##commented as a reminder that sooner or later it will need a
|
---|
132 | newer version than our current or last but one release ##
|
---|
133 | This version of biber requires <application>perl-5.30</application>
|
---|
134 | or later. If you are still using the 8.4 version of BLFS you may
|
---|
135 | wish to build the 2.13 version: see the 8.4 book noting that
|
---|
136 | biblatex-3.13 has been replaced by biblatex-3.13a upstream.
|
---|
137 | </para>-->
|
---|
138 | </note>
|
---|
139 |
|
---|
140 | <!-- TexLive 2024 shipped biblatex-3.19. Uncomment if a newer
|
---|
141 | biber requires a newer biblatex. -->
|
---|
142 |
|
---|
143 | <!-- FIXME - ok to comment biblatex when version for a new year matches
|
---|
144 | what is in texmf-dist. For new version, reinstate to avoid runtime error.-->
|
---|
145 | <!--
|
---|
146 | <bridgehead renderas="sect3">Required Additional Download</bridgehead>
|
---|
147 |
|
---|
148 | <itemizedlist spacing="compact">
|
---|
149 | <listitem>
|
---|
150 | <para>
|
---|
151 | Download (HTTP): <ulink url="&biblatex-download-http;"/>
|
---|
152 | </para>
|
---|
153 | </listitem>
|
---|
154 | <listitem>
|
---|
155 | <para>
|
---|
156 | Download MD5 sum: &biblatex-md5sum;
|
---|
157 | </para>
|
---|
158 | </listitem>
|
---|
159 | <listitem>
|
---|
160 | <para>
|
---|
161 | Download size: &biblatex-size;
|
---|
162 | </para>
|
---|
163 | </listitem>
|
---|
164 | </itemizedlist>
|
---|
165 | -->
|
---|
166 |
|
---|
167 | <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
|
---|
168 |
|
---|
169 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
170 | <para role="required">
|
---|
171 | <!-- KFM: the order listed in Build.PL is not alphabetical -->
|
---|
172 | <xref linkend="perl-autovivification"/>,
|
---|
173 | <xref linkend="perl-business-isbn"/>,
|
---|
174 | <xref linkend="perl-business-ismn"/>,
|
---|
175 | <xref linkend="perl-business-issn"/>,
|
---|
176 | <xref linkend="perl-class-accessor"/>,
|
---|
177 | <xref linkend="perl-data-compare"/>,
|
---|
178 | <xref linkend="perl-data-dump"/>,
|
---|
179 | <xref linkend="perl-data-uniqid"/>,
|
---|
180 | <xref linkend="perl-datetime-calendar-julian"/>,
|
---|
181 | <xref linkend="perl-datetime-format-builder"/>,
|
---|
182 | <xref linkend="perl-encode-eucjpascii"/>,
|
---|
183 | <xref linkend="perl-encode-hanextra"/>,
|
---|
184 | <xref linkend="perl-encode-jis2k"/>,
|
---|
185 | <xref linkend="perl-file-slurper"/>,
|
---|
186 | <xref linkend="perl-io-string"/>,
|
---|
187 | <!-- IPC::Cmd is a part of core perl -->
|
---|
188 | <xref linkend="perl-ipc-run3"/>,
|
---|
189 | <xref linkend="perl-lingua-translit"/>,
|
---|
190 | <xref linkend="perl-list-allutils"/>,
|
---|
191 | <xref linkend="perl-list-moreutils"/>,
|
---|
192 | <!-- perl-list-moreutils-xs is a dep of perl-list-moreutils -->
|
---|
193 | <xref linkend="perl-log-log4perl"/>,
|
---|
194 | <xref linkend="perl-lwp-protocol-https"/>,
|
---|
195 | <!-- LWP::Simple dep for this protocol is part of perl-libwww-perl,
|
---|
196 | that is pulled in by perl-lwp-protocol-https and that pulls in
|
---|
197 | perl-uri. Biber lists LWP::UserAgent as a dep, again it is part
|
---|
198 | of perl-libwww-perl. -->
|
---|
199 | <xref linkend="perl-module-build"/>,
|
---|
200 | <xref linkend="perl-parse-recdescent"/>,
|
---|
201 | <xref linkend="perl-perlio-utf8_strict"/>,
|
---|
202 | <!-- Mozilla::CA should not be needed when using system certificates -->
|
---|
203 | <xref linkend="perl-regexp-common"/>,
|
---|
204 | <xref linkend="perl-sort-key"/>,
|
---|
205 | <xref linkend="perl-text-bibtex"/>,
|
---|
206 | <xref linkend="perl-text-csv"/>,
|
---|
207 | <!-- perl-text-csv_xs is a recommended dependency for perl-text-csv -->
|
---|
208 | <xref linkend="perl-text-roman"/>,
|
---|
209 | <!-- Unicode-Collate usually needs to be latest when biber is released,
|
---|
210 | core perl is usually older. To read the core version, look at
|
---|
211 | /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Collate.pm -->
|
---|
212 | <xref linkend="perl-unicode-collate"/>,
|
---|
213 | <!-- Unicode::GCstring is part of Unicode::LineBreak -->
|
---|
214 | <xref linkend="perl-unicode-linebreak"/>,
|
---|
215 | <!-- Unicode::Normalize is part of core perl, found in
|
---|
216 | /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Normalize.pm -->
|
---|
217 | <!-- perl-xml-libxml is a dependency of perl-xml-libxml-simple -->
|
---|
218 | <xref linkend="perl-xml-libxml-simple"/>,
|
---|
219 | <xref linkend="perl-xml-libxslt"/>, and
|
---|
220 | <xref linkend="perl-xml-writer"/>
|
---|
221 | <!-- untarring biblatex requires that the texmf directories already exist -->
|
---|
222 | <!--
|
---|
223 | <xref linkend="texlive"/>
|
---|
224 | (or <xref linkend="tl-installer"/>, but for that you can use
|
---|
225 | <command>tlmgr update</command>)
|
---|
226 | -->
|
---|
227 | </para>
|
---|
228 |
|
---|
229 | <bridgehead renderas="sect4">Recommended (required for the test suite)</bridgehead>
|
---|
230 | <para role="recommended">
|
---|
231 | <xref linkend="perl-file-which"/> and
|
---|
232 | <xref linkend="perl-test-differences"/>
|
---|
233 | </para>
|
---|
234 |
|
---|
235 | <note>
|
---|
236 | <para>
|
---|
237 | It is possible to install all missing dependencies automatically. You
|
---|
238 | must first install <xref linkend="perl-module-build"/> using <xref
|
---|
239 | linkend="perl-auto-install"/>. Then run <command>perl
|
---|
240 | ./Build.PL</command> and when it prompts you, become the &root; user
|
---|
241 | and run <command>./Build installdeps</command> - this will use CPAN
|
---|
242 | and as noted above it will use Mozilla::CA instead of using system
|
---|
243 | certificates.
|
---|
244 | </para>
|
---|
245 | </note>
|
---|
246 |
|
---|
247 | </sect2>
|
---|
248 |
|
---|
249 | <sect2 role="installation">
|
---|
250 | <title>Installation of Biber</title>
|
---|
251 |
|
---|
252 | <!-- https://github.com/plk/biber/commit/d9e9617 -->
|
---|
253 | <!--
|
---|
254 | <para>
|
---|
255 | Fix an issue building this package with Perl 5.36 or later:
|
---|
256 | </para>
|
---|
257 |
|
---|
258 | <screen><userinput remap="pre">sed 's/undef$/&;/' -i lib/Biber/Section.pm</userinput></screen>
|
---|
259 | -->
|
---|
260 | <para>
|
---|
261 | Install <application>Biber</application> by running the following
|
---|
262 | commands:
|
---|
263 | </para>
|
---|
264 |
|
---|
265 | <screen><userinput>perl ./Build.PL &&
|
---|
266 | ./Build</userinput></screen>
|
---|
267 |
|
---|
268 | <para>
|
---|
269 | To test the results, enter: <command>./Build test</command>
|
---|
270 | </para>
|
---|
271 |
|
---|
272 | <para>
|
---|
273 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
274 | </para>
|
---|
275 | <!--
|
---|
276 | <screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &&
|
---|
277 | texhash &&
|
---|
278 | -->
|
---|
279 | <screen role="root"><userinput>./Build install</userinput></screen>
|
---|
280 | <!-- Editor note: As for any ./Build type perl module, use destdir=
|
---|
281 | after the command for DESTDIR. -->
|
---|
282 |
|
---|
283 | <!--<para>
|
---|
284 | The corresponding version of <application>biblatex</application> is
|
---|
285 | a separate project. The tarball is pre-packaged for untarring
|
---|
286 | into the <filename class="directory">texmf-dist</filename>
|
---|
287 | directory. Install it as the &root; user:
|
---|
288 | </para>
|
---|
289 |
|
---|
290 | <screen role="root"><userinput>tar -C $TEXLIVE_PREFIX/texmf-dist -xf ../biblatex-&biblatex-version;.tds.tgz</userinput></screen>-->
|
---|
291 |
|
---|
292 | </sect2>
|
---|
293 | <!--
|
---|
294 | <sect2 role="commands">
|
---|
295 | <title>Command Explanations</title>
|
---|
296 |
|
---|
297 | <para>
|
---|
298 | <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
|
---|
299 | /opt/texlive/&texlive-year;/texmf-dist</command>:
|
---|
300 | this installs the new <application>biblatex</application> files over those
|
---|
301 | installed by <application>texlive</application>.
|
---|
302 | </para>
|
---|
303 |
|
---|
304 | <para>
|
---|
305 | <command>texhash</command> : this updates the file hash tables (otherwise
|
---|
306 | known as the file name database).
|
---|
307 | </para>
|
---|
308 |
|
---|
309 | </sect2>
|
---|
310 | -->
|
---|
311 | <sect2 role="content">
|
---|
312 | <title>Contents</title>
|
---|
313 |
|
---|
314 | <segmentedlist>
|
---|
315 | <segtitle>Installed Programs</segtitle>
|
---|
316 | <segtitle>Installed Library</segtitle>
|
---|
317 | <segtitle>Installed Directory</segtitle>
|
---|
318 |
|
---|
319 | <seglistitem>
|
---|
320 | <seg>biber</seg>
|
---|
321 | <seg>None</seg>
|
---|
322 | <seg>/usr/lib/perl5/site_perl/5.*{,/<arch>-linux/auto}/Biber</seg>
|
---|
323 | </seglistitem>
|
---|
324 | </segmentedlist>
|
---|
325 |
|
---|
326 | <variablelist>
|
---|
327 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
328 | <?dbfo list-presentation="list"?>
|
---|
329 | <?dbhtml list-presentation="table"?>
|
---|
330 |
|
---|
331 | <varlistentry id="biber-prog">
|
---|
332 | <term><command>biber</command></term>
|
---|
333 | <listitem>
|
---|
334 | <para>
|
---|
335 | is used for producing bibliographies in LaTeX documents
|
---|
336 | </para>
|
---|
337 | <indexterm zone="biber biber-prog">
|
---|
338 | <primary sortas="b-biber">biber</primary>
|
---|
339 | </indexterm>
|
---|
340 | </listitem>
|
---|
341 | </varlistentry>
|
---|
342 |
|
---|
343 | </variablelist>
|
---|
344 |
|
---|
345 | </sect2>
|
---|
346 |
|
---|
347 | </sect1>
|
---|