source: general/genlib/brotli.xml@ 79758477

11.0 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 79758477 was 79758477, checked in by Pierre Labastie <pieere@…>, 9 months ago

Remove python2 ad from brotli

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

  • Property mode set to 100644
File size: 7.0 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-&brotli-version;.tar.gz">
8 <!ENTITY brotli-download-ftp " ">
9 <!ENTITY brotli-md5sum "c2274f0c7af8470ad514637c35bcee7d">
10 <!ENTITY brotli-size "476 KB">
11 <!ENTITY brotli-buildsize "24 MB (with python3 bindings)">
12 <!-- The python tests for this package are broken. The tarball is missing a lot of test files -->
13 <!ENTITY brotli-time "0.4 SBU (with python3 bindings)">
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 &lfs101_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 <bridgehead renderas="sect3">Brotli Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Required</bridgehead>
80 <para role="required">
81 <xref linkend="cmake"/>
82 </para>
83
84<!-- Brotli doesn't have any lua bindings, at least not with 1.0.7.
85 Do not advertise python2 as python3 should be used instead
86 <bridgehead renderas="sect4">Optional</bridgehead>
87 <para role="optional">
88 <xref linkend="lua"/> (to create Lua bindings) and
89 <xref linkend="python2"/> (to create python2 bindings)
90 </para>
91-->
92 <para condition="html" role="usernotes">
93 User Notes: <ulink url="&blfs-wiki;/brotli"/>
94 </para>
95 </sect2>
96
97
98 <sect2 role="installation">
99 <title>Installation of Brotli</title>
100
101 <para>
102 At first, fix an issue in pkg-config files:
103 </para>
104
105<screen><userinput>sed -i 's@-R..libdir.@@' scripts/*.pc.in</userinput></screen>
106
107 <para>
108 Install <application>brotli</application> by running the following
109 commands:
110 </para>
111
112<screen><userinput>mkdir out &amp;&amp;
113cd out &amp;&amp;
114
115cmake -DCMAKE_INSTALL_PREFIX=/usr \
116 -DCMAKE_BUILD_TYPE=Release \
117 .. &amp;&amp;
118make</userinput></screen>
119
120
121 <para>
122 To test the results, issue: <command>make test</command>
123 </para>
124
125 <para>
126 If desired, build the <application>Python3</application>
127 bindings:
128 </para>
129
130<screen><userinput>pushd .. &amp;&amp;
131python3 setup.py build &amp;&amp;
132popd</userinput></screen>
133<!-- These are broken
134-->
135 <para>
136 The python tests are missing most of the necessary testdata files and
137 therefore 240 of 311 tests fail.
138 If you nevertheless wish to test the bindings, go back to the top-level directory and
139 issue: <command>python3 setup.py test</command>.
140 </para>
141
142 <para>
143 Now, as the <systemitem class="username">root</systemitem> user:
144 </para>
145
146<screen role="root"><userinput>make install &amp;&amp;
147cd ..</userinput></screen>
148
149 <para>
150 If you have built the <application>python</application> bindings,
151 install them as the <systemitem class="username">root</systemitem>
152 user:
153 </para>
154
155<!-- EDITORS: for DESTDIR style installs use
156python3 setup.py install \-\-root /some/where -->
157<screen role="root"><userinput>python3 setup.py install --optimize=1</userinput></screen>
158
159 </sect2>
160
161 <sect2 role="content">
162 <title>Contents</title>
163
164 <segmentedlist>
165 <segtitle>Installed Programs</segtitle>
166 <segtitle>Installed Libraries</segtitle>
167 <segtitle>Installed Directory</segtitle>
168
169 <seglistitem>
170 <seg>
171 brotli
172 </seg>
173 <seg>
174 libbrotlicommon{-static.a,.so},
175 libbrotlidec{,-static.a,.so}, and
176 libbrotlienc{,-static.a,.so}
177 </seg>
178 <seg>
179 /usr/include/brotli
180 </seg>
181 </seglistitem>
182 </segmentedlist>
183
184 <variablelist>
185 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
186 <?dbfo list-presentation="list"?>
187 <?dbhtml list-presentation="table"?>
188
189 <varlistentry id="brotli-prog">
190 <term><command>brotli</command></term>
191 <listitem>
192 <para>
193 can compress or decompress files, or test the integrity of
194 compressed files
195 </para>
196 <indexterm zone="brotli brotli-prog">
197 <primary sortas="b-brotli">brotli</primary>
198 </indexterm>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry id="libbrotlicommon">
203 <term><filename class="libraryfile">libbrotlicommon{-static.a,.so}</filename></term>
204 <listitem>
205 <para>
206 is the Brotli common dictionary library
207 </para>
208 <indexterm zone="brotli libbrotlicommon">
209 <primary sortas="c-libbrotlicommon">libbrotlicommon{,-static.a,.so}</primary>
210 </indexterm>
211 </listitem>
212 </varlistentry>
213
214 <varlistentry id="libbrotlidec">
215 <term><filename class="libraryfile">libbrotlidec{-static.a,.so}</filename></term>
216 <listitem>
217 <para>
218 is the Brotli decoder library
219 </para>
220 <indexterm zone="brotli libbrotlidec">
221 <primary sortas="c-libbrotlidec">libbrotlidec{,-static.a,.so}</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="libbrotlienc">
227 <term><filename class="libraryfile">libbrotlienc{-static.a,.so}</filename></term>
228 <listitem>
229 <para>
230 is the Brotli common encoder library
231 </para>
232 <indexterm zone="brotli libbrotlienc">
233 <primary sortas="c-libbrotlienc">libbrotlienc{,-static.a,.so}</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237 </variablelist>
238
239 </sect2>
240
241</sect1>
Note: See TracBrowser for help on using the repository browser.