source: pst/typesetting/biber.xml@ c5aa446c

11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since c5aa446c was c5aa446c, checked in by Bruce Dubbs <bdubbs@…>, 23 months ago

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