source: pst/typesetting/biber.xml@ 66a8904

lazarus trunk
Last change on this file since 66a8904 was 66a8904, checked in by Ken Moffat <zarniwhoop@…>, 3 months ago

Biber: expand a comment for editors.

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