source: pst/typesetting/biber.xml@ 31d19ce

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 31d19ce was 48771ae, checked in by David Bryant <davidbryant@…>, 17 months ago

Unless it's a directory name, or something like that, "test suite"
should be spelled as two words.
  • Property mode set to 100644
File size: 13.4 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 "5a503052bf88aff12dcef7a2d8a8e4f2">
16 <!ENTITY biber-size "1.5 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 grows by 3MB -->
22 <!ENTITY biber-buildsize "14 MB"> <!-- 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 <!-- Check path. Directory might not be &biblatex-version; if a suffixed update -->
28 <!-- for normal unsuffixed version: e.g. for 3.15a
29 <!ENTITY biblatex-download-http "https://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz"> -->
30 <!ENTITY biblatex-download-http "https://sourceforge.net/projects/biblatex/files/biblatex-3.18/biblatex-&biblatex-version;.tds.tgz">
31 <!ENTITY biblatex-download-ftp "">
32 <!ENTITY biblatex-md5sum "cd4c996e5ad4431c9f89c6e6c37a38df">
33 <!ENTITY biblatex-size "18 MB">
34 <!-- this usually overwrites files in texmf-dist¸use du -sm to measure
35 before nad after - 'buildsize' might easily be unchanged, or add to biber above -->
36 <!-- end the comment-out here when next commenting out biblatex -->
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 &lfs112_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<!--
115 <para>
116 The <application>biber</application> source tarball shown above
117 downloads with the correct name, biber-&biber-version;.tar.gz,
118 if using a browser such as Firefox. If you prefer to use a command line
119 program such as wget, you normally would obtain
120 v&biber-version;.tar.gz. To obtain this package with the proper
121 filename, run:
122
123<screen><userinput>wget -c &biber-download-http; \
124 -O biber-&biber-version;.tar.gz</userinput></screen>.
125 </para>
126-->
127 <para>
128 If you have updated to a new release of texlive-source, biber and its
129 perl dependencies are still present in <filename
130 class="directory">/usr</filename> and do not need to be rebuilt.
131 However, biblatex installs in <filename
132 class="directory">/opt/texlive/&texlive-year;</filename> and does
133 need to be reinstalled.
134 </para>
135
136 <para>
137 If you installed the above dependencies using the BLFS instructions
138 for each of them, <command>perl ./Build.PL</command> will complain
139 that Mozilla::CA is not installed, but that is not needed unless
140 CPAN was used to install the modules. BLFS patches LWP::Protocol::https
141 to use the system certificates, Mozilla::CA uses old certificates.
142 </para>
143
144<!-- <para> ##commented as a reminder that sooner or later it will need a
145 newer version than our current or last but one release ##
146 This version of biber requires <application>perl-5.30</application>
147 or later. If you are still using the 8.4 version of BLFS you may
148 wish to build the 2.13 version: see the 8.4 book noting that
149 biblatex-3.13 has been replaced by biblatex-3.13a upstream.
150 </para>-->
151 </note>
152
153 <!-- TexLive 2022 already ships biblatex-3.17. Uncomment if a newer
154 biber requires a newer biblatex. -->
155
156 <!-- FIXME - ok to comment biblatex when version for a new year matches
157 what is in texmf-dist. For new version, reinstate to avoid runtime error. -->
158 <bridgehead renderas="sect3">Required Additional Download</bridgehead>
159
160 <itemizedlist spacing="compact">
161 <listitem>
162 <para>
163 Download (HTTP): <ulink url="&biblatex-download-http;"/>
164 </para>
165 </listitem>
166 <listitem>
167 <para>
168 Download MD5 sum: &biblatex-md5sum;
169 </para>
170 </listitem>
171 <listitem>
172 <para>
173 Download size: &biblatex-size;
174 </para>
175 </listitem>
176 </itemizedlist>
177
178 <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
179
180 <bridgehead renderas="sect4">Required</bridgehead>
181 <para role="required">
182 <!-- KFM: the order listed in Build.PL is not alphabetical -->
183 <xref linkend="perl-autovivification"/>
184 <xref linkend="perl-business-isbn"/>
185 <xref linkend="perl-business-ismn"/>
186 <xref linkend="perl-business-issn"/>
187 <xref linkend="perl-class-accessor"/>
188 <xref linkend="perl-data-compare"/>
189 <xref linkend="perl-data-dump"/>
190 <xref linkend="perl-data-uniqid"/>
191 <xref linkend="perl-datetime-calendar-julian"/>
192 <xref linkend="perl-datetime-format-builder"/>
193 <xref linkend="perl-encode-eucjpascii"/>
194 <xref linkend="perl-encode-hanextra"/>
195 <xref linkend="perl-encode-jis2k"/>
196 <xref linkend="perl-file-slurper"/>
197 <xref linkend="perl-io-string"/>
198 <!-- IPC::Cmd is a part of core perl -->
199 <xref linkend="perl-ipc-run3"/>
200 <xref linkend="perl-lingua-translit"/>
201 <xref linkend="perl-list-allutils"/>
202 <xref linkend="perl-list-moreutils"/>
203 <!-- perl-list-moreutils-xs is a dep of perl-list-moreutils -->
204 <xref linkend="perl-log-log4perl"/>
205 <xref linkend="perl-lwp-protocol-https"/>
206 <!-- LWP::Simple is part of perl-libwww-perl,
207 that is pulled in by perl-lwp-protocol-https
208 and that pulls in perl-uri -->
209 <xref linkend="perl-module-build"/>
210 <xref linkend="perl-parse-recdescent"/>
211 <xref linkend="perl-perlio-utf8_strict"/>
212 <!-- Mozilla::CA should not be needed when using system certificates -->
213 <xref linkend="perl-regexp-common"/>
214 <xref linkend="perl-sort-key"/>
215 <xref linkend="perl-text-bibtex"/>
216 <xref linkend="perl-text-csv"/>
217 <!-- perl-text-csv_xs is a recommended dependency for perl-text-csv -->
218 <xref linkend="perl-text-roman"/>
219 <!-- Unicode-Collate usually needs to be latest when biber is released,
220 core perl is usually older. To read the core version, look at
221 /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Collate.pm -->
222 <xref linkend="perl-unicode-collate"/>
223 <!-- Unicode::GCstring is part of Unicode::LineBreak -->
224 <xref linkend="perl-unicode-linebreak"/>
225 <!-- Unicode::Normalize is part of core perl, found in
226 /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Normalize.pm -->
227 <!-- perl-xml-libxml is a dependency of perl-xml-libxml-simple -->
228 <xref linkend="perl-xml-libxml-simple"/>
229 <xref linkend="perl-xml-libxslt"/>
230 <xref linkend="perl-xml-writer"/> and
231 <!-- untarring biblatex requires that the texmf directories already exist -->
232 <!--
233 <xref linkend="texlive"/>
234 (or <xref linkend="tl-installer"/>, but for that you can use
235 <command>tlmgr update</command>)
236 -->
237 </para>
238
239 <bridgehead renderas="sect4">Recommended (required for the test suite)</bridgehead>
240 <para role="recommended">
241 <xref linkend="perl-file-which"/> and
242 <xref linkend="perl-test-differences"/>
243 </para>
244
245 <note>
246 <para>
247 It is possible to install all missing dependencies automatically. You
248 must first install <xref linkend="perl-module-build"/> using <xref
249 linkend="perl-auto-install"/>. Then run <command>perl
250 ./Build.PL</command> and when it prompts you, become the root user
251 and run <command>./Build installdeps</command> - this will use CPAN
252 and as noted above it will use Mozilla::CA instead of using system
253 certificates.
254 </para>
255 </note>
256
257 <para condition="html" role="usernotes">User Notes:
258 <ulink url='&blfs-wiki;/biber'/></para>
259
260 </sect2>
261
262 <sect2 role="installation">
263 <title>Installation of Biber</title>
264
265 <!-- https://github.com/plk/biber/commit/d9e9617 -->
266 <!--
267 <para>
268 Fix an issue building this package with Perl 5.36 or later:
269 </para>
270
271<screen><userinput remap="pre">sed 's/undef$/&amp;;/' -i lib/Biber/Section.pm</userinput></screen>
272-->
273 <para>
274 Install <application>Biber</application> by running the following
275 commands:
276 </para>
277
278<screen><userinput>perl ./Build.PL &amp;&amp;
279./Build</userinput></screen>
280
281 <para>
282 To test the results, enter: <command>./Build test</command>
283 </para>
284
285 <para>
286 Now, as the <systemitem class="username">root</systemitem> user:
287 </para>
288<!--
289<screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &amp;&amp;
290texhash &amp;&amp;
291-->
292<screen role="root"><userinput>./Build install</userinput></screen>
293
294 <para>
295 The corresponding version of <application>biblatex</application> is
296 a separate project. The tarball is pre-packaged for untarring
297 into the <filename class="directory">texmf-dist</filename>
298 directory. Install it as the &root; user:
299 </para>
300
301<screen role="root"><userinput>tar -C $TEXLIVE_PREFIX/texmf-dist -xf ../biblatex-3.18b.tds.tgz</userinput></screen>
302
303 </sect2>
304<!--
305 <sect2 role="commands">
306 <title>Command Explanations</title>
307
308 <para>
309 <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
310 /opt/texlive/&texlive-year;/texmf-dist</command>:
311 this installs the new <application>biblatex</application> files over those
312 installed by <application>texlive</application>.
313 </para>
314
315 <para>
316 <command>texhash</command> : this updates the file hash tables (otherwise
317 known as the file name database).
318 </para>
319
320 </sect2>
321-->
322 <sect2 role="content">
323 <title>Contents</title>
324
325 <segmentedlist>
326 <segtitle>Installed Programs</segtitle>
327 <segtitle>Installed Library</segtitle>
328 <segtitle>Installed Directory</segtitle>
329
330 <seglistitem>
331 <seg>biber</seg>
332 <seg>None</seg>
333 <seg>/usr/lib/perl5/site_perl/5.*{,/&lt;arch&gt;-linux/auto}/Biber</seg>
334 </seglistitem>
335 </segmentedlist>
336
337 <variablelist>
338 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
339 <?dbfo list-presentation="list"?>
340 <?dbhtml list-presentation="table"?>
341
342 <varlistentry id="biber-prog">
343 <term><command>biber</command></term>
344 <listitem>
345 <para>
346 is used for producing bibliographies in LaTeX documents
347 </para>
348 <indexterm zone="biber biber-prog">
349 <primary sortas="b-biber">biber</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 </variablelist>
355
356 </sect2>
357
358</sect1>
Note: See TracBrowser for help on using the repository browser.