[a9ee0599] | 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 |
|
---|
[21007b1b] | 7 | <!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;.tar.gz">
|
---|
| 8 | <!ENTITY biber-download-ftp " ">
|
---|
[770f129] | 9 | <!ENTITY biber-md5sum "e1804c7efca29f4f576523f0fafaa952">
|
---|
[21007b1b] | 10 | <!ENTITY biber-size "1.3 MB">
|
---|
[9385c0fe] | 11 | <!-- buildsize includes the installed biblatex -->
|
---|
[e95f793] | 12 | <!ENTITY biber-buildsize "36 MB">
|
---|
[a0fd5377] | 13 | <!ENTITY biber-time "0.4 SBU including tests">
|
---|
[9385c0fe] | 14 |
|
---|
[1740585] | 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">
|
---|
[c5a4b23] | 17 | <!ENTITY biblatex-download-ftp "">
|
---|
[a0fd5377] | 18 | <!ENTITY biblatex-md5sum "2d4867166599fd707ee644452a075174">
|
---|
[9385c0fe] | 19 | <!ENTITY biblatex-size "19 MB">
|
---|
[c5a4b23] | 20 |
|
---|
[a9ee0599] | 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 |
|
---|
[21007b1b] | 31 | <title>biber-&biber-version;</title>
|
---|
[a9ee0599] | 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
|
---|
[10e632f] | 41 | <application>Perl</application>, with full Unicode support.</para>
|
---|
[a9ee0599] | 42 |
|
---|
[0a88bd98] | 43 | &lfs81_checked;
|
---|
[a9ee0599] | 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 |
|
---|
[23d3b894] | 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>
|
---|
[a0751bdc] | 80 |
|
---|
[23d3b894] | 81 | <bridgehead renderas="sect3">Required Additional Download</bridgehead>
|
---|
[a0751bdc] | 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>
|
---|
[c5a4b23] | 97 |
|
---|
[a9ee0599] | 98 | <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
|
---|
| 99 |
|
---|
| 100 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 101 | <para role="required">
|
---|
[145cccdf] | 102 | <!-- KFM: because I always get confused by these deps, I've decided
|
---|
| 103 | to add some comments.
|
---|
| 104 | Both Config::AutoConf and ExtUtils::LibBuilder are listed as build
|
---|
| 105 | requirements in Build.PL, the rest are just requirements, but the
|
---|
| 106 | difference seems moot. Those two are needed to build Text::BibTeX
|
---|
| 107 | so not listed separately. -->
|
---|
[a9ee0599] | 108 | <xref linkend="perl-autovivification"/>
|
---|
| 109 | <xref linkend="perl-business-isbn"/>
|
---|
| 110 | <xref linkend="perl-business-ismn"/>
|
---|
| 111 | <xref linkend="perl-business-issn"/>
|
---|
[35b6a2e] | 112 | <xref linkend="perl-class-accessor"/>
|
---|
[a9ee0599] | 113 | <xref linkend="perl-data-compare"/>
|
---|
[1c80c2c] | 114 | <xref linkend="perl-data-dump"/>
|
---|
[35b6a2e] | 115 | <xref linkend="perl-data-uniqid"/>
|
---|
[42bb57d] | 116 | <xref linkend="perl-datetime-calendar-julian"/>
|
---|
| 117 | <xref linkend="perl-datetime-format-builder"/>
|
---|
[a9ee0599] | 118 | <xref linkend="perl-encode-eucjpascii"/>
|
---|
| 119 | <xref linkend="perl-encode-hanextra"/>
|
---|
| 120 | <xref linkend="perl-encode-jis2k"/>
|
---|
[583abce] | 121 | <xref linkend="perl-file-slurper"/>
|
---|
[145cccdf] | 122 | <!-- IPC::Cmd is a part of core perl -->
|
---|
[a9ee0599] | 123 | <xref linkend="perl-ipc-run3"/>
|
---|
[a5cd6e1] | 124 | <xref linkend="perl-lingua-translit"/>
|
---|
[a9ee0599] | 125 | <xref linkend="perl-list-allutils"/>
|
---|
[145cccdf] | 126 | <!-- List::MoreUtils was pulled in for the testsuite of List::AllUtils,
|
---|
| 127 | but it needs to be present even if people do not run the tests -->
|
---|
| 128 | <xref linkend="perl-list-moreutils"/>
|
---|
[fc8b669] | 129 | <!-- List::MoreUtils::XS is listed as a dep, but it is part of
|
---|
| 130 | List::MoreUtils -->
|
---|
[145cccdf] | 131 | <xref linkend="perl-log-log4perl"/>
|
---|
| 132 | <!-- I initially misread LWP-Protocol-https as part of libwww-perl
|
---|
| 133 | when I was preparing this list. In fact, it depends on that -->
|
---|
| 134 | <xref linkend="perl-lwp-protocol-https"/>
|
---|
[a5cd6e1] | 135 | <!-- LWP::Simple is part of libwww-perl,
|
---|
| 136 | that is pulled in by LWP::Protocol::https -->
|
---|
[145cccdf] | 137 | <!-- Module::Build is pulled in by perl-text-bibtex, but mention it explicitly
|
---|
| 138 | so that the note on automatically installing missing dependencies can be run -->
|
---|
[10e632f] | 139 | <xref linkend="perl-module-build"/>
|
---|
[145cccdf] | 140 | <!-- Mozilla::CA is a dependency of LWP-Protocol-https -->
|
---|
[583abce] | 141 | <xref linkend="perl-perlio-utf8_strict"/>
|
---|
[a9ee0599] | 142 | <xref linkend="perl-regexp-common"/>
|
---|
[42bb57d] | 143 | <xref linkend="perl-sort-key"/>
|
---|
[a9ee0599] | 144 | <xref linkend="perl-text-bibtex"/>
|
---|
[42bb57d] | 145 | <xref linkend="perl-text-csv"/>
|
---|
| 146 | <!-- Text-CSV_XS is a recommended dependency for Text-CSV -->
|
---|
[9385c0fe] | 147 | <xref linkend="perl-text-roman"/>
|
---|
[e95f793] | 148 | <!-- Unicode-Collate usually needs to be latest, core perl is older -->
|
---|
| 149 | <xref linkend="perl-unicode-collate"/>
|
---|
[145cccdf] | 150 | <!-- Unicode::GCstring is part of Unicode::LineBreak -->
|
---|
[a9ee0599] | 151 | <xref linkend="perl-unicode-linebreak"/>
|
---|
| 152 | <xref linkend="perl-xml-libxml-simple"/>
|
---|
[c5a4b23] | 153 | <xref linkend="perl-xml-libxslt"/>
|
---|
| 154 | <xref linkend="perl-xml-writer"/> and
|
---|
[9385c0fe] | 155 | <!-- untarring biblatex requires that the texmf directories already exist -->
|
---|
[c5a4b23] | 156 | <xref linkend="texlive"/>
|
---|
[544c41a] | 157 | (or <xref linkend="tl-installer"/>)
|
---|
[a9ee0599] | 158 | </para>
|
---|
| 159 |
|
---|
[583abce] | 160 | <note> <!-- assume people with an old release may be slowly building things -->
|
---|
[42bb57d] | 161 | <para>This version of <application>biber</application> requires at least
|
---|
[583abce] | 162 | <application>perl-5.26.0</application>. If you are using an older version
|
---|
| 163 | of <command>perl</command> you may prefer to install v2.7 - for that see
|
---|
| 164 | the BLFS-8.1 book.</para>
|
---|
[42bb57d] | 165 | </note>
|
---|
| 166 |
|
---|
[35b6a2e] | 167 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 168 | <para role="optional">
|
---|
| 169 | <xref linkend="perl-file-which"/> and
|
---|
| 170 | <xref linkend="perl-test-differences"/> to run the testsuite
|
---|
[a9ee0599] | 171 | </para>
|
---|
| 172 |
|
---|
| 173 | <note>
|
---|
| 174 | <para>
|
---|
[42bb57d] | 175 | It is possible to install all missing dependencies automatically.
|
---|
| 176 | But from <application>perl-5.22.0</application> onwards,
|
---|
| 177 | <xref linkend="perl-module-build"/> is no longer part of the core perl
|
---|
| 178 | distribution. And 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
|
---|
[a9ee0599] | 184 | <command>./Build installdeps</command>
|
---|
| 185 | </para>
|
---|
[35b6a2e] | 186 | </note>
|
---|
| 187 |
|
---|
[a9ee0599] | 188 | <para condition="html" role="usernotes">User Notes:
|
---|
[3e90bfe] | 189 | <ulink url='&blfs-wiki;/biber'/></para>
|
---|
[a9ee0599] | 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
|
---|
[7b2c94b] | 197 | commands:</para>
|
---|
[a9ee0599] | 198 |
|
---|
[a953d7d5] | 199 | <screen><userinput>perl ./Build.PL &&
|
---|
[0f304418] | 200 | ./Build</userinput></screen>
|
---|
[a9ee0599] | 201 |
|
---|
[42bb57d] | 202 | <para>To test the results, enter: <command>./Build test</command></para>
|
---|
[a9ee0599] | 203 |
|
---|
| 204 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 205 |
|
---|
[59e61f7] | 206 | <screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &&
|
---|
[c5a4b23] | 207 | texhash &&
|
---|
| 208 | ./Build install</userinput></screen>
|
---|
| 209 |
|
---|
| 210 | </sect2>
|
---|
| 211 |
|
---|
| 212 | <sect2 role="commands">
|
---|
| 213 | <title>Command Explanations</title>
|
---|
[10e632f] | 214 |
|
---|
[c5a4b23] | 215 | <para>
|
---|
[0c54cea] | 216 | <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
|
---|
| 217 | /opt/texlive/&texlive-year;/texmf-dist</command>:
|
---|
[9385c0fe] | 218 | this installs the new <application>biblatex</application> files over those
|
---|
| 219 | installed by <application>texlive</application>.
|
---|
[c5a4b23] | 220 | </para>
|
---|
| 221 |
|
---|
| 222 | <para>
|
---|
[0c54cea] | 223 | <command>texhash</command> : this updates the file hash tables (otherwise
|
---|
[c5a4b23] | 224 | known as the file name database).
|
---|
| 225 | </para>
|
---|
[a9ee0599] | 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>
|
---|
[a953d7d5] | 240 | <seg>/usr/lib/perl5/site_perl/5.*{,/<arch>-linux/auto}/Biber</seg>
|
---|
[a9ee0599] | 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">
|
---|
[3e90bfe] | 250 | <term><command>biber</command></term>
|
---|
[a9ee0599] | 251 | <listitem>
|
---|
| 252 | <para>is used for producing bibliographies in LaTeX documents.</para>
|
---|
[3e90bfe] | 253 | <indexterm zone="biber biber-prog">
|
---|
[a9ee0599] | 254 | <primary sortas="b-biber">biber</primary>
|
---|
| 255 | </indexterm>
|
---|
| 256 | </listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
| 259 | </variablelist>
|
---|
| 260 |
|
---|
| 261 | </sect2>
|
---|
| 262 |
|
---|
| 263 | </sect1>
|
---|