[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 |
|
---|
[140475a] | 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 |
|
---|
[21007b1b] | 11 | <!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;.tar.gz">
|
---|
[140475a] | 12 | -->
|
---|
| 13 | <!ENTITY biber-download-http "https://github.com/plk/biber/archive/v&biber-version;/biber-&biber-version;.tar.gz">
|
---|
[21007b1b] | 14 | <!ENTITY biber-download-ftp " ">
|
---|
[9b51413] | 15 | <!ENTITY biber-md5sum "726e7457f1b4d882e1d05fd185563cfd">
|
---|
| 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 bibleatex over the top of it and remeasure. -->
|
---|
| 21 | <!ENTITY biber-buildsize "16 MB">
|
---|
| 22 | <!ENTITY biber-time "0.6 SBU including tests">
|
---|
[9385c0fe] | 23 |
|
---|
[1740585] | 24 | <!-- Check path. Directory might not be &biblatex-version; if a suffixed update -->
|
---|
[9b51413] | 25 | <!ENTITY biblatex-download-http "http://sourceforge.net/projects/biblatex/files/biblatex-&biblatex-version;/biblatex-&biblatex-version;.tds.tgz">
|
---|
[c5a4b23] | 26 | <!ENTITY biblatex-download-ftp "">
|
---|
[9b51413] | 27 | <!ENTITY biblatex-md5sum "fc3605bc86de283e6f962f20a80c5a04">
|
---|
[e819e4f] | 28 | <!ENTITY biblatex-size "20 MB">
|
---|
[c5a4b23] | 29 |
|
---|
[a9ee0599] | 30 | ]>
|
---|
| 31 |
|
---|
| 32 | <sect1 id="biber" xreflabel="biber-&biber-version;">
|
---|
| 33 | <?dbhtml filename="biber.html"?>
|
---|
| 34 |
|
---|
| 35 | <sect1info>
|
---|
| 36 | <othername>$LastChangedBy$</othername>
|
---|
| 37 | <date>$Date$</date>
|
---|
| 38 | </sect1info>
|
---|
| 39 |
|
---|
[21007b1b] | 40 | <title>biber-&biber-version;</title>
|
---|
[a9ee0599] | 41 |
|
---|
| 42 | <indexterm zone="biber">
|
---|
| 43 | <primary sortas="a-biber">Biber</primary>
|
---|
| 44 | </indexterm>
|
---|
| 45 |
|
---|
| 46 | <sect2 role="package">
|
---|
| 47 | <title>Introduction to biber</title>
|
---|
| 48 |
|
---|
| 49 | <para>Biber is a BibTeX replacement for users of biblatex, written in
|
---|
[10e632f] | 50 | <application>Perl</application>, with full Unicode support.</para>
|
---|
[a9ee0599] | 51 |
|
---|
[e819e4f] | 52 | &lfs90_checked;
|
---|
[a9ee0599] | 53 |
|
---|
[9b51413] | 54 | <!-- note for editors: you can test this by using the latest version
|
---|
| 55 | of the latex-test tarball from
|
---|
| 56 | http://www.linuxfromscratch.org/~ken/tex-testfiles/
|
---|
| 57 | using ./configure (to create the Makefile) and then making the
|
---|
| 58 | following targets:
|
---|
| 59 | biblatex-unibiber and biblatex-biber (these just use pdflatex
|
---|
| 60 | and biber, biblatex-unibiber is more important, it uses UTF-8)
|
---|
| 61 | bibxelatex (uses xelatex and biber, needs TTF or OTF fonts and
|
---|
| 62 | in particular coverage of simplified Chinese and Japanese, and
|
---|
| 63 | optionally Korean - installed fonts for CJK can be specified to
|
---|
| 64 | configure if they are not found)
|
---|
| 65 | remote1 and remote2 (pdflatex and biber, for use with manually
|
---|
| 66 | installed perl modules, i.e. without Mozilla::CA, to prove that
|
---|
| 67 | remote references work).
|
---|
| 68 | In all cases the output PDF should include references at the
|
---|
| 69 | end, the Makefile does not check that for the remote tests. -->
|
---|
| 70 |
|
---|
[a9ee0599] | 71 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 72 | <itemizedlist spacing="compact">
|
---|
| 73 | <listitem>
|
---|
| 74 | <para>Download (HTTP): <ulink url="&biber-download-http;"/></para>
|
---|
| 75 | </listitem>
|
---|
| 76 | <listitem>
|
---|
| 77 | <para>Download (FTP): <ulink url="&biber-download-ftp;"/></para>
|
---|
| 78 | </listitem>
|
---|
| 79 | <listitem>
|
---|
| 80 | <para>Download MD5 sum: &biber-md5sum;</para>
|
---|
| 81 | </listitem>
|
---|
| 82 | <listitem>
|
---|
| 83 | <para>Download size: &biber-size;</para>
|
---|
| 84 | </listitem>
|
---|
| 85 | <listitem>
|
---|
| 86 | <para>Estimated disk space required: &biber-buildsize;</para>
|
---|
| 87 | </listitem>
|
---|
| 88 | <listitem>
|
---|
| 89 | <para>Estimated build time: &biber-time;</para>
|
---|
| 90 | </listitem>
|
---|
| 91 | </itemizedlist>
|
---|
| 92 |
|
---|
[23d3b894] | 93 | <note>
|
---|
[140475a] | 94 | <!--
|
---|
[23d3b894] | 95 | <para>
|
---|
| 96 | The <application>biber</application> source tarball shown above
|
---|
| 97 | downloads with the correct name, biber-&biber-version;.tar.gz,
|
---|
| 98 | if using a browser such as Firefox. If you prefer to use a command line
|
---|
| 99 | program such as wget, you normally would obtain
|
---|
| 100 | v&biber-version;.tar.gz. To obtain this package with the proper
|
---|
| 101 | filename, run:
|
---|
| 102 |
|
---|
| 103 | <screen><userinput>wget -c &biber-download-http; \
|
---|
| 104 | -O biber-&biber-version;.tar.gz</userinput></screen>.
|
---|
[06fd9a2] | 105 | </para>
|
---|
[140475a] | 106 | -->
|
---|
[06fd9a2] | 107 | <para>
|
---|
| 108 | If you have updated to a new release of texlive-source, biber and its
|
---|
| 109 | perl dependencies are still in present in <filename
|
---|
| 110 | class="directory">/usr</filename> and do not need to be rebuilt. However,
|
---|
| 111 | biblatex installs in <filename
|
---|
| 112 | class="directory">/opt/texlive/&texlive-year;</filename> and does need to
|
---|
| 113 | be reinstalled.
|
---|
| 114 | </para>
|
---|
[9b51413] | 115 |
|
---|
| 116 | <para>
|
---|
| 117 | This version of biber requires <application>perl-5.30</application> or later.
|
---|
| 118 | If you are still using the 8.4 version of BLFS you may wish to build the
|
---|
| 119 | 2.13 version: see the 8.4 book noting that biblatex-3.13 has been replaced by
|
---|
| 120 | biblatex-3.13a upstream.
|
---|
| 121 | </para>
|
---|
[06fd9a2] | 122 | </note>
|
---|
[a0751bdc] | 123 |
|
---|
[e394bdab] | 124 | <bridgehead renderas="sect3">Required Additional Downloads</bridgehead>
|
---|
[a0751bdc] | 125 |
|
---|
| 126 | <itemizedlist spacing="compact">
|
---|
| 127 | <listitem>
|
---|
| 128 | <para>The corresponding version of <application>biblatex</application> is
|
---|
| 129 | a separate project - the tds tarball is pre-packaged for untarring into
|
---|
| 130 | the <filename class="directory">texmf-dist</filename> directory.
|
---|
| 131 | Download (HTTP): <ulink url="&biblatex-download-http;"/></para>
|
---|
| 132 | </listitem>
|
---|
| 133 | <listitem>
|
---|
| 134 | <para>Download MD5 sum: &biblatex-md5sum;</para>
|
---|
| 135 | </listitem>
|
---|
| 136 | <listitem>
|
---|
| 137 | <para>Download size: &biblatex-size;</para>
|
---|
| 138 | </listitem>
|
---|
| 139 | </itemizedlist>
|
---|
[c5a4b23] | 140 |
|
---|
[a9ee0599] | 141 | <bridgehead renderas="sect3">Biber Dependencies</bridgehead>
|
---|
| 142 |
|
---|
| 143 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 144 | <para role="required">
|
---|
[a206343] | 145 | <!-- KFM: the order listed in Build.PL is not alphabetical -->
|
---|
[4392a40] | 146 | <xref linkend="perl-autovivification"/>
|
---|
| 147 | <xref linkend="perl-business-isbn"/>
|
---|
| 148 | <xref linkend="perl-business-ismn"/>
|
---|
| 149 | <xref linkend="perl-business-issn"/>
|
---|
| 150 | <xref linkend="perl-class-accessor"/>
|
---|
| 151 | <xref linkend="perl-data-compare"/>
|
---|
| 152 | <xref linkend="perl-data-dump"/>
|
---|
| 153 | <xref linkend="perl-data-uniqid"/>
|
---|
| 154 | <xref linkend="perl-datetime-calendar-julian"/>
|
---|
| 155 | <xref linkend="perl-datetime-format-builder"/>
|
---|
| 156 | <xref linkend="perl-encode-eucjpascii"/>
|
---|
| 157 | <xref linkend="perl-encode-hanextra"/>
|
---|
| 158 | <xref linkend="perl-encode-jis2k"/>
|
---|
| 159 | <xref linkend="perl-file-slurper"/>
|
---|
[e819e4f] | 160 | <xref linkend="perl-io-string"/>
|
---|
[145cccdf] | 161 | <!-- IPC::Cmd is a part of core perl -->
|
---|
[4392a40] | 162 | <xref linkend="perl-ipc-run3"/>
|
---|
| 163 | <xref linkend="perl-lingua-translit"/>
|
---|
| 164 | <xref linkend="perl-list-allutils"/>
|
---|
| 165 | <xref linkend="perl-list-moreutils"/>
|
---|
[a206343] | 166 | <!-- perl-list-moreutils-xs is a dep of perl-list-moreutils -->
|
---|
[4392a40] | 167 | <xref linkend="perl-log-log4perl"/>
|
---|
| 168 | <xref linkend="perl-lwp-protocol-https"/>
|
---|
[a206343] | 169 | <!-- LWP::Simple is part of perl-libwww-perl,
|
---|
| 170 | that is pulled in by perl-lwp-protocol-https
|
---|
| 171 | and that pulls in perl-uri -->
|
---|
[4392a40] | 172 | <xref linkend="perl-module-build"/>
|
---|
[52a7defa] | 173 | <xref linkend="perl-perlio-utf8_strict"/>
|
---|
[a206343] | 174 | <!-- Mozilla::CA should not be needed when using system certificates -->
|
---|
[4392a40] | 175 | <xref linkend="perl-regexp-common"/>
|
---|
| 176 | <xref linkend="perl-sort-key"/>
|
---|
| 177 | <xref linkend="perl-text-bibtex"/>
|
---|
| 178 | <xref linkend="perl-text-csv"/>
|
---|
[a206343] | 179 | <!-- perl-text-csv_xs is a recommended dependency for perl-text-csv -->
|
---|
[4392a40] | 180 | <xref linkend="perl-text-roman"/>
|
---|
[a206343] | 181 | <!-- Unicode-Collate usually needs to be latest when biber is released,
|
---|
| 182 | core perl is usually older. To read the core version, look at
|
---|
| 183 | /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Collate.pm -->
|
---|
[4392a40] | 184 | <xref linkend="perl-unicode-collate"/>
|
---|
[145cccdf] | 185 | <!-- Unicode::GCstring is part of Unicode::LineBreak -->
|
---|
[4392a40] | 186 | <xref linkend="perl-unicode-linebreak"/>
|
---|
[a206343] | 187 | <!-- Unicode::Normalize is part of core perl, found in
|
---|
| 188 | /usr/lib/perl5/5.xx.y/x86_64-linux-thread-multi/Unicode/Normalize.pm -->
|
---|
| 189 | <!-- perl-xml-libxml is a dependency of perl-xml-libxml-simple -->
|
---|
[4392a40] | 190 | <xref linkend="perl-xml-libxml-simple"/>
|
---|
| 191 | <xref linkend="perl-xml-libxslt"/>
|
---|
| 192 | <xref linkend="perl-xml-writer"/> and
|
---|
[9385c0fe] | 193 | <!-- untarring biblatex requires that the texmf directories already exist -->
|
---|
[c5a4b23] | 194 | <xref linkend="texlive"/>
|
---|
[a206343] | 195 | (or <xref linkend="tl-installer"/>, but for that you can use
|
---|
| 196 | <command>tlmgr update </command>)
|
---|
[a9ee0599] | 197 | </para>
|
---|
| 198 |
|
---|
[5dda4e2] | 199 | <bridgehead renderas="sect4">Recommended (required for the testsuite)</bridgehead>
|
---|
| 200 | <para role="recommended">
|
---|
[4392a40] | 201 | <xref linkend="perl-file-which"/> and
|
---|
[5dda4e2] | 202 | <xref linkend="perl-test-differences"/>
|
---|
[a9ee0599] | 203 | </para>
|
---|
| 204 |
|
---|
| 205 | <note>
|
---|
| 206 | <para>
|
---|
[d3930a7] | 207 | It is possible to install all missing dependencies automatically. You
|
---|
| 208 | must first install <xref linkend="perl-module-build"/> using <xref
|
---|
[4392a40] | 209 | linkend="perl-auto-install"/>. then run <command>perl ./Build.PL</command>
|
---|
[42bb57d] | 210 | and when it prompts you, become the root user and run
|
---|
[a9ee0599] | 211 | <command>./Build installdeps</command>
|
---|
| 212 | </para>
|
---|
[35b6a2e] | 213 | </note>
|
---|
| 214 |
|
---|
[a9ee0599] | 215 | <para condition="html" role="usernotes">User Notes:
|
---|
[3e90bfe] | 216 | <ulink url='&blfs-wiki;/biber'/></para>
|
---|
[a9ee0599] | 217 |
|
---|
| 218 | </sect2>
|
---|
| 219 |
|
---|
| 220 | <sect2 role="installation">
|
---|
| 221 | <title>Installation of Biber</title>
|
---|
| 222 |
|
---|
| 223 | <para>Install <application>Biber</application> by running the following
|
---|
[7b2c94b] | 224 | commands:</para>
|
---|
[a9ee0599] | 225 |
|
---|
[e819e4f] | 226 | <screen><userinput>perl ./Build.PL &&
|
---|
[0f304418] | 227 | ./Build</userinput></screen>
|
---|
[a9ee0599] | 228 |
|
---|
[42bb57d] | 229 | <para>To test the results, enter: <command>./Build test</command></para>
|
---|
[a9ee0599] | 230 |
|
---|
| 231 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 232 |
|
---|
[59e61f7] | 233 | <screen role="root"><userinput>tar -xf ../biblatex-&biblatex-version;.tds.tgz -C /opt/texlive/&texlive-year;/texmf-dist &&
|
---|
[c5a4b23] | 234 | texhash &&
|
---|
| 235 | ./Build install</userinput></screen>
|
---|
| 236 |
|
---|
| 237 | </sect2>
|
---|
| 238 |
|
---|
| 239 | <sect2 role="commands">
|
---|
| 240 | <title>Command Explanations</title>
|
---|
[10e632f] | 241 |
|
---|
[c5a4b23] | 242 | <para>
|
---|
[0c54cea] | 243 | <command>tar -xf biblatex-&biblatex-version;.tds.tar.gz -C
|
---|
| 244 | /opt/texlive/&texlive-year;/texmf-dist</command>:
|
---|
[9385c0fe] | 245 | this installs the new <application>biblatex</application> files over those
|
---|
| 246 | installed by <application>texlive</application>.
|
---|
[c5a4b23] | 247 | </para>
|
---|
| 248 |
|
---|
| 249 | <para>
|
---|
[0c54cea] | 250 | <command>texhash</command> : this updates the file hash tables (otherwise
|
---|
[c5a4b23] | 251 | known as the file name database).
|
---|
| 252 | </para>
|
---|
[a9ee0599] | 253 |
|
---|
| 254 | </sect2>
|
---|
| 255 |
|
---|
| 256 | <sect2 role="content">
|
---|
| 257 | <title>Contents</title>
|
---|
| 258 |
|
---|
| 259 | <segmentedlist>
|
---|
| 260 | <segtitle>Installed Programs</segtitle>
|
---|
| 261 | <segtitle>Installed Library</segtitle>
|
---|
| 262 | <segtitle>Installed Directory</segtitle>
|
---|
| 263 |
|
---|
| 264 | <seglistitem>
|
---|
| 265 | <seg>biber</seg>
|
---|
| 266 | <seg>None</seg>
|
---|
[a953d7d5] | 267 | <seg>/usr/lib/perl5/site_perl/5.*{,/<arch>-linux/auto}/Biber</seg>
|
---|
[a9ee0599] | 268 | </seglistitem>
|
---|
| 269 | </segmentedlist>
|
---|
| 270 |
|
---|
| 271 | <variablelist>
|
---|
| 272 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 273 | <?dbfo list-presentation="list"?>
|
---|
| 274 | <?dbhtml list-presentation="table"?>
|
---|
| 275 |
|
---|
| 276 | <varlistentry id="biber-prog">
|
---|
[3e90bfe] | 277 | <term><command>biber</command></term>
|
---|
[a9ee0599] | 278 | <listitem>
|
---|
| 279 | <para>is used for producing bibliographies in LaTeX documents.</para>
|
---|
[3e90bfe] | 280 | <indexterm zone="biber biber-prog">
|
---|
[a9ee0599] | 281 | <primary sortas="b-biber">biber</primary>
|
---|
| 282 | </indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
| 285 |
|
---|
| 286 | </variablelist>
|
---|
| 287 |
|
---|
| 288 | </sect2>
|
---|
| 289 |
|
---|
| 290 | </sect1>
|
---|