source: pst/typesetting/biber.xml@ 7158ad6

perl-modules
Last change on this file since 7158ad6 was 7158ad6, checked in by Ken Moffat <ken@…>, 4 years ago

perl modules branch: next batch of modules.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/perl-modules@20518 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 9.9 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 <!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;.tar.gz">
8 <!ENTITY biber-download-ftp " ">
9 <!ENTITY biber-md5sum "e1804c7efca29f4f576523f0fafaa952">
10 <!ENTITY biber-size "1.3 MB">
11 <!-- buildsize includes the installed biblatex -->
12 <!ENTITY biber-buildsize "36 MB">
13 <!ENTITY biber-time "0.4 SBU including tests">
14
15 <!-- Check path. Directory might not be &biblatex-version; if a suffixed update -->
16 <!ENTITY biblatex-download-http "http://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz">
17 <!ENTITY biblatex-download-ftp "">
18 <!ENTITY biblatex-md5sum "2d4867166599fd707ee644452a075174">
19 <!ENTITY biblatex-size "19 MB">
20
21]>
22
23<sect1 id="biber" xreflabel="biber-&biber-version;">
24 <?dbhtml filename="biber.html"?>
25
26 <sect1info>
27 <othername>$LastChangedBy$</othername>
28 <date>$Date$</date>
29 </sect1info>
30
31 <title>biber-&biber-version;</title>
32
33 <indexterm zone="biber">
34 <primary sortas="a-biber">Biber</primary>
35 </indexterm>
36
37 <sect2 role="package">
38 <title>Introduction to biber</title>
39
40 <para>Biber is a BibTeX replacement for users of biblatex, written in
41 <application>Perl</application>, with full Unicode support.</para>
42
43 &lfs83_checked;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>Download (HTTP): <ulink url="&biber-download-http;"/></para>
49 </listitem>
50 <listitem>
51 <para>Download (FTP): <ulink url="&biber-download-ftp;"/></para>
52 </listitem>
53 <listitem>
54 <para>Download MD5 sum: &biber-md5sum;</para>
55 </listitem>
56 <listitem>
57 <para>Download size: &biber-size;</para>
58 </listitem>
59 <listitem>
60 <para>Estimated disk space required: &biber-buildsize;</para>
61 </listitem>
62 <listitem>
63 <para>Estimated build time: &biber-time;</para>
64 </listitem>
65 </itemizedlist>
66
67 <note>
68 <para>
69 The <application>biber</application> source tarball shown above
70 downloads with the correct name, biber-&biber-version;.tar.gz,
71 if using a browser such as Firefox. If you prefer to use a command line
72 program such as wget, you normally would obtain
73 v&biber-version;.tar.gz. To obtain this package with the proper
74 filename, run:
75
76<screen><userinput>wget -c &biber-download-http; \
77 -O biber-&biber-version;.tar.gz</userinput></screen>.
78 </para>
79 </note>
80
81 <bridgehead renderas="sect3">Required Additional Download</bridgehead>
82
83 <itemizedlist spacing="compact">
84 <listitem>
85 <para>The corresponding version of <application>biblatex</application> is
86 a separate project - the tds tarball is pre-packaged for untarring into
87 the <filename class="directory">texmf-dist</filename> directory.
88 Download (HTTP): <ulink url="&biblatex-download-http;"/></para>
89 </listitem>
90 <listitem>
91 <para>Download MD5 sum: &biblatex-md5sum;</para>
92 </listitem>
93 <listitem>
94 <para>Download size: &biblatex-size;</para>
95 </listitem>
96 </itemizedlist>
97
98 <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
99
100 <bridgehead renderas="sect4">Required</bridgehead>
101 <para role="required">
102 <!-- KFM: the order listed in Build.PL is not alphabetical -->
103 <xref linkend="new-perl-autovivification"/>
104 <xref linkend="perl-business-isbn"/>
105 <xref linkend="perl-business-ismn"/>
106 <xref linkend="new-perl-business-issn"/>
107 <xref linkend="new-perl-class-accessor"/>
108 <xref linkend="new-perl-data-compare"/>
109 <xref linkend="new-perl-data-dump"/>
110 <xref linkend="perl-data-uniqid"/>
111 <xref linkend="perl-datetime-calendar-julian"/>
112 <xref linkend="perl-datetime-format-builder"/>
113 <xref linkend="perl-encode-eucjpascii"/>
114 <xref linkend="perl-encode-hanextra"/>
115 <xref linkend="perl-encode-jis2k"/>
116 <xref linkend="perl-file-slurper"/>
117 <xref linkend="perl-perlio-utf8_strict"/>
118 <!-- IPC::Cmd is a part of core perl -->
119 <xref linkend="perl-ipc-run3"/>
120 <xref linkend="perl-lingua-translit"/>
121 <xref linkend="perl-list-allutils"/>
122 <!-- List::MoreUtils was pulled in for the testsuite of List::AllUtils,
123 but it needs to be present even if people do not run the tests -->
124 <xref linkend="perl-list-moreutils"/>
125 <!-- List::MoreUtils::XS is listed as a dep, but it is part of
126 List::MoreUtils -->
127 <xref linkend="perl-log-log4perl"/>
128 <!-- I initially misread LWP-Protocol-https as part of libwww-perl
129 when I was preparing this list. In fact, it depends on that -->
130 <xref linkend="perl-lwp-protocol-https"/>
131 <!-- LWP::Simple is part of libwww-perl,
132 that is pulled in by LWP::Protocol::https -->
133 <!-- Module::Build is no-longer a direct dependency, and now that it can be
134 built using just the standard instructions, it does not need to be mentioned -->
135 <!-- Mozilla::CA is a dependency of LWP-Protocol-https -->
136 <xref linkend="perl-regexp-common"/>
137 <xref linkend="perl-sort-key"/>
138 <xref linkend="new-perl-text-bibtex"/>
139 <xref linkend="perl-text-csv"/>
140 <!-- Text-CSV_XS is a recommended dependency for Text-CSV -->
141 <xref linkend="perl-text-roman"/>
142 <!-- Unicode-Collate usually needs to be latest, core perl is older -->
143 <xref linkend="perl-unicode-collate"/>
144 <!-- Unicode::GCstring is part of Unicode::LineBreak -->
145 <xref linkend="perl-unicode-linebreak"/>
146 <!-- Unicode::Normalize is part of core perl -->
147 <!-- FIXME URI is probably a dep i nthe lwp or libwww area -->
148 <!-- XML::LibXML is a dependency of XML::LibXML::Simple -->
149 <xref linkend="perl-xml-libxml-simple"/>
150 <xref linkend="perl-xml-libxslt"/>
151 <xref linkend="perl-xml-writer"/> and
152 <!-- untarring biblatex requires that the texmf directories already exist -->
153 <xref linkend="texlive"/>
154 (or <xref linkend="tl-installer"/>)
155 </para>
156
157 <note> <!-- assume people with an old release may be slowly building things -->
158 <para>This version of <application>biber</application> requires at least
159 <application>perl-5.26.0</application>. If you are using an older version
160 of <command>perl</command> you may prefer to install v2.7 - for that see
161 the BLFS-8.1 book.</para>
162 </note>
163
164 <bridgehead renderas="sect4">Optional</bridgehead>
165 <para role="optional">
166 <xref linkend="perl-file-which"/> and
167 <xref linkend="perl-test-differences"/> to run the testsuite
168 </para>
169
170 <note>
171 <para>
172 It is possible to install all missing dependencies automatically.
173<!-- Module::Build can now be built using perl Makefile.PL, so does not need to
174 be installed in advance
175 But from <application>perl-5.22.0</application> onwards,
176 <xref linkend="perl-module-build"/> is no longer part of the core perl
177 distribution. And for -->
178 For <xref linkend="perl-data-uniqid"/> we have to
179 patch it to skip over a test which always fails - that failing test may
180 break the automatic install. To automatically install the remaining perl
181 dependencies you can install those two modules first using <xref
182 linkend="perl-auto-install"/>. then run <command>perl ./Build.PL</command>
183 and when it prompts you, become the root user and run
184 <command>./Build installdeps</command>
185 </para>
186 </note>
187
188 <para condition="html" role="usernotes">User Notes:
189 <ulink url='&blfs-wiki;/biber'/></para>
190
191 </sect2>
192
193 <sect2 role="installation">
194 <title>Installation of Biber</title>
195
196 <para>Install <application>Biber</application> by running the following
197 commands:</para>
198
199<screen><userinput>perl ./Build.PL &amp;&amp;
200./Build</userinput></screen>
201
202 <para>To test the results, enter: <command>./Build test</command></para>
203
204 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
205
206<screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &amp;&amp;
207texhash &amp;&amp;
208./Build install</userinput></screen>
209
210 </sect2>
211
212 <sect2 role="commands">
213 <title>Command Explanations</title>
214
215 <para>
216 <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
217 /opt/texlive/&texlive-year;/texmf-dist</command>:
218 this installs the new <application>biblatex</application> files over those
219 installed by <application>texlive</application>.
220 </para>
221
222 <para>
223 <command>texhash</command> : this updates the file hash tables (otherwise
224 known as the file name database).
225 </para>
226
227 </sect2>
228
229 <sect2 role="content">
230 <title>Contents</title>
231
232 <segmentedlist>
233 <segtitle>Installed Programs</segtitle>
234 <segtitle>Installed Library</segtitle>
235 <segtitle>Installed Directory</segtitle>
236
237 <seglistitem>
238 <seg>biber</seg>
239 <seg>None</seg>
240 <seg>/usr/lib/perl5/site_perl/5.*{,/&lt;arch&gt;-linux/auto}/Biber</seg>
241 </seglistitem>
242 </segmentedlist>
243
244 <variablelist>
245 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
246 <?dbfo list-presentation="list"?>
247 <?dbhtml list-presentation="table"?>
248
249 <varlistentry id="biber-prog">
250 <term><command>biber</command></term>
251 <listitem>
252 <para>is used for producing bibliographies in LaTeX documents.</para>
253 <indexterm zone="biber biber-prog">
254 <primary sortas="b-biber">biber</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 </variablelist>
260
261 </sect2>
262
263</sect1>
Note: See TracBrowser for help on using the repository browser.