source: general/genlib/brotli.xml@ 47d5a9e5

10.0 10.1 11.0 11.1 11.2 9.1 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 47d5a9e5 was 47d5a9e5, checked in by Ken Moffat <ken@…>, 3 years ago

Add dvisvgm with deps of Brotli and WOFF2, for the moment use shipped xxHash because nothing else uses that.

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

  • Property mode set to 100644
File size: 7.5 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;.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 tiem 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 &lfs90_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 <bridgehead renderas="sect4">Optional</bridgehead>
99 <para role="optional">
100 <xref linkend="python2"/> (to create the bindings for that)
101 </para>
102
103 <para condition="html" role="usernotes">
104 User Notes: <ulink url="&blfs-wiki;/brotli"/>
105 </para>
106 </sect2>
107
108
109 <sect2 role="installation">
110 <title>Installation of Brotli</title>
111
112 <para>
113 Install <application>brotli</application> by running the following
114 commands:
115 </para>
116
117<screen><userinput>mkdir out &amp;&amp;
118cd out &amp;&amp;
119
120cmake -DCMAKE_INSTALL_PREFIX=/usr \
121 -DCMAKE_BUILD_TYPE=Release \
122 .. &amp;&amp;
123make</userinput></screen>
124
125
126 <para>
127 To test the results, issue: <command>make test</command>.
128 </para>
129
130 <para>
131 If desired, either or both sets of python bindings can be built and
132 installed without any conflicts. If you need the
133 <application>Python2</application> bindings, add or substitute
134 <command>python2</command> for <command>python3</command> in the
135 following instructions:
136 </para>
137
138<screen><userinput>pushd .. &amp;&amp;
139python3 setup.py build &amp;&amp;
140popd</userinput></screen>
141
142 <para>
143 If you wish to test the bindings, go back to the top-level directory and
144 run python3 setup.py test.
145 </para>
146
147 <para>
148 Now, as the <systemitem class="username">root</systemitem> user:
149 </para>
150
151<screen role="root"><userinput>make install &amp;&amp;
152cd ..</userinput></screen>
153
154 <para>
155 If you have built either or both sets of <application>python</application>
156 bindings, install them as the <systemitem class="username">root</systemitem>
157 user (as before, use the appropriate version(s) of
158 <application>python</application>:
159 </para>
160
161<!-- EDITORS: for DESTDIR style installs use
162python3 setup.py install \-\-root /some/where -->
163<screen role="root"><userinput>python3 setup.py install --optimize=1</userinput></screen>
164
165 </sect2>
166
167 <sect2 role="content">
168 <title>Contents</title>
169
170 <segmentedlist>
171 <segtitle>Installed Programs</segtitle>
172 <segtitle>Installed Libraries</segtitle>
173 <segtitle>Installed Directory</segtitle>
174
175 <seglistitem>
176 <seg>
177 brotli.
178 </seg>
179 <seg>
180 libbrotlicommon{-static.a,.so}, libbrotlidec{,-static,.so} and libbrotlienc{,-static,.so}.
181 </seg>
182 <seg>
183 /usr/include/brotli
184 </seg>
185 </seglistitem>
186 </segmentedlist>
187
188 <variablelist>
189 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
190 <?dbfo list-presentation="list"?>
191 <?dbhtml list-presentation="table"?>
192
193 <varlistentry id="brotli-prog">
194 <term><command>brotli</command></term>
195 <listitem>
196 <para>
197 can compress or decompress files, or test the integrity of
198 compressed files.
199 </para>
200 <indexterm zone="brotli brotli-prog">
201 <primary sortas="b-brotli">brotli</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 <varlistentry id="libbrotlicommon">
207 <term><filename class="libraryfile">libbrotlicommon{-static.a,.so}</filename></term>
208 <listitem>
209 <para>
210 is the Brotli common dictionary library.
211 </para>
212 <indexterm zone="brotli libbrotlicommon">
213 <primary sortas="c-libbrotlicommon">libbrotlicommon{,-static.a,.so}</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="libbrotlidec">
219 <term><filename class="libraryfile">libbrotlidec{-static.a,.so}</filename></term>
220 <listitem>
221 <para>
222 is the Brotli decoder library.
223 </para>
224 <indexterm zone="brotli libbrotlidec">
225 <primary sortas="c-libbrotlidec">libbrotlidec{,-static.a,.so}</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="libbrotlienc">
231 <term><filename class="libraryfile">libbrotlienc{-static.a,.so}</filename></term>
232 <listitem>
233 <para>
234 is the Brotli common encoder library.
235 </para>
236 <indexterm zone="brotli libbrotlienc">
237 <primary sortas="c-libbrotlienc">libbrotlienc{,-static.a,.so}</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241 </variablelist>
242
243 </sect2>
244</sect1>
Note: See TracBrowser for help on using the repository browser.