source: general/genlib/brotli.xml@ eb7de89

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since eb7de89 was eb7de89, checked in by Douglas R. Reno <renodr@…>, 16 months ago

Update to lua-5.4.0
VIM: Adapt Lua interface to Lua-5.4
Apache/httpd: Adapt Lua module to Lua-5.4
Brotli: Remove invalid dependency on lua, there is a separate package that provides one, and it's not bundled with our download of Brotli
Dovecot: Add a command explanation describing how to build Lua support
Lua-5.2: Minor adjustment to installed files
Hexchat: Promote libcanberra to recommended

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23350 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 7.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 <!ENTITY brotli-download-http "https://github.com/google/brotli/archive/v&brotli-version;/brotli-v&brotli-version;.tar.gz">
8 <!ENTITY brotli-download-ftp " ">
9 <!ENTITY brotli-md5sum "7b6edd4f2128f22794d0ca28c53898a5">
10 <!ENTITY brotli-size "23 MB">
11 <!ENTITY brotli-buildsize "43 MB (add 5 MB if installing both sets of python bindings, add 9 MB for the main test and 5MB for testing the bindings)">
12 <!-- time for testing without the bindings is minimal, each set takes similar time and space -->
13 <!ENTITY brotli-time "0.2 SBU (add 0.3 SBU for the python bindings, and 1.2 SBU if testing them)">
14]>
15
16<sect1 id="brotli" xreflabel="Brotli-&brotli-version;">
17 <?dbhtml filename="brotli.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>brotli-&brotli-version;</title>
25
26 <indexterm zone="brotli">
27 <primary sortas="a-brotli">Brotli</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Brotli</title>
32
33 <para>
34 <application>Brotli</application> provides a general-purpose lossless
35 compression algorithm that compresses data using a combination of a
36 modern variant of the LZ77 algorithm, Huffman coding and 2nd order
37 context modeling. Its libraries are particularly used for WOFF2 fonts
38 on webpages.
39 </para>
40
41 &lfs91_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&brotli-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&brotli-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &brotli-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &brotli-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &brotli-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &brotli-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76<!--
77 <note>
78 <para>
79 The <application>Brotli</application> source tarball shown above
80 downloads with the correct name, brotli-&brotli-version;.tar.gz,
81 if using a browser such as Firefox. If you prefer to use a command line
82 program such as wget, you normally would obtain
83 v&brotli-version;.tar.gz. To obtain this package with the proper
84 filename, run:
85
86<screen><userinput>wget -c https://github.com/google/brotli/archive/v&brotli-version;.tar.gz \
87 -O brotli-&brotli-version;.tar.gz</userinput></screen>.
88 </para>
89 </note>
90-->
91 <bridgehead renderas="sect3">Brotli Dependencies</bridgehead>
92
93 <bridgehead renderas="sect4">Required</bridgehead>
94 <para role="required">
95 <xref linkend="cmake"/>
96 </para>
97
98 <!-- Brotli doesn't have any lua bindings, at least not with 1.0.7. -->
99 <bridgehead renderas="sect4">Optional</bridgehead>
100 <para role="optional">
101 <!--<xref linkend="lua"/> (to create Lua bindings) and -->
102 <xref linkend="python2"/> (to create python2 bindings)
103 </para>
104
105 <para condition="html" role="usernotes">
106 User Notes: <ulink url="&blfs-wiki;/brotli"/>
107 </para>
108 </sect2>
109
110
111 <sect2 role="installation">
112 <title>Installation of Brotli</title>
113
114 <para>
115 Install <application>brotli</application> by running the following
116 commands:
117 </para>
118
119<screen><userinput>mkdir out &amp;&amp;
120cd out &amp;&amp;
121
122cmake -DCMAKE_INSTALL_PREFIX=/usr \
123 -DCMAKE_BUILD_TYPE=Release \
124 .. &amp;&amp;
125make</userinput></screen>
126
127
128 <para>
129 To test the results, issue: <command>make test</command>.
130 </para>
131
132 <para>
133 If desired, either or both sets of python bindings can be built and
134 installed without any conflicts. If you need the
135 <application>Python2</application> bindings, add or substitute
136 <command>python2</command> for <command>python3</command> in the
137 following instructions:
138 </para>
139
140<screen><userinput>pushd .. &amp;&amp;
141python3 setup.py build &amp;&amp;
142popd</userinput></screen>
143
144 <para>
145 If you wish to test the bindings, go back to the top-level directory and
146 issue: <command>python3 setup.py test</command>.
147 </para>
148
149 <para>
150 Now, as the <systemitem class="username">root</systemitem> user:
151 </para>
152
153<screen role="root"><userinput>make install &amp;&amp;
154cd ..</userinput></screen>
155
156 <para>
157 If you have built either or both sets of <application>python</application>
158 bindings, install them as the <systemitem class="username">root</systemitem>
159 user (as before, use the appropriate version(s) of
160 <application>python</application>:
161 </para>
162
163<!-- EDITORS: for DESTDIR style installs use
164python3 setup.py install \-\-root /some/where -->
165<screen role="root"><userinput>python3 setup.py install --optimize=1</userinput></screen>
166
167 </sect2>
168
169 <sect2 role="content">
170 <title>Contents</title>
171
172 <segmentedlist>
173 <segtitle>Installed Programs</segtitle>
174 <segtitle>Installed Libraries</segtitle>
175 <segtitle>Installed Directory</segtitle>
176
177 <seglistitem>
178 <seg>
179 brotli
180 </seg>
181 <seg>
182 libbrotlicommon{-static.a,.so}, libbrotlidec{,-static,.so} and libbrotlienc{,-static,.so}
183 </seg>
184 <seg>
185 /usr/include/brotli
186 </seg>
187 </seglistitem>
188 </segmentedlist>
189
190 <variablelist>
191 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
192 <?dbfo list-presentation="list"?>
193 <?dbhtml list-presentation="table"?>
194
195 <varlistentry id="brotli-prog">
196 <term><command>brotli</command></term>
197 <listitem>
198 <para>
199 can compress or decompress files, or test the integrity of
200 compressed files.
201 </para>
202 <indexterm zone="brotli brotli-prog">
203 <primary sortas="b-brotli">brotli</primary>
204 </indexterm>
205 </listitem>
206 </varlistentry>
207
208 <varlistentry id="libbrotlicommon">
209 <term><filename class="libraryfile">libbrotlicommon{-static.a,.so}</filename></term>
210 <listitem>
211 <para>
212 is the Brotli common dictionary library.
213 </para>
214 <indexterm zone="brotli libbrotlicommon">
215 <primary sortas="c-libbrotlicommon">libbrotlicommon{,-static.a,.so}</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="libbrotlidec">
221 <term><filename class="libraryfile">libbrotlidec{-static.a,.so}</filename></term>
222 <listitem>
223 <para>
224 is the Brotli decoder library.
225 </para>
226 <indexterm zone="brotli libbrotlidec">
227 <primary sortas="c-libbrotlidec">libbrotlidec{,-static.a,.so}</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="libbrotlienc">
233 <term><filename class="libraryfile">libbrotlienc{-static.a,.so}</filename></term>
234 <listitem>
235 <para>
236 is the Brotli common encoder library.
237 </para>
238 <indexterm zone="brotli libbrotlienc">
239 <primary sortas="c-libbrotlienc">libbrotlienc{,-static.a,.so}</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243 </variablelist>
244
245 </sect2>
246</sect1>
Note: See TracBrowser for help on using the repository browser.