source: general/genlib/brotli.xml@ 08e1b767

11.0 11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 08e1b767 was 08e1b767, checked in by Xi Ruoyao <xry111@…>, 9 months ago

Tag for UEFI and dependencies ("required" and "recommended")

  • 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 <date>$Date$</date>
21 </sect1info>
22
23 <title>brotli-&brotli-version;</title>
24
25 <indexterm zone="brotli">
26 <primary sortas="a-brotli">Brotli</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Brotli</title>
31
32 <para>
33 <application>Brotli</application> provides a general-purpose lossless
34 compression algorithm that compresses data using a combination of a
35 modern variant of the LZ77 algorithm, Huffman coding and 2nd order
36 context modeling. Its libraries are particularly used for WOFF2 fonts
37 on webpages.
38 </para>
39
40 &lfs110_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&brotli-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&brotli-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &brotli-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &brotli-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &brotli-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &brotli-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect3">Brotli Dependencies</bridgehead>
77
78 <bridgehead renderas="sect4">Required</bridgehead>
79 <para role="required">
80 <xref linkend="cmake"/>
81 </para>
82
83<!-- Brotli doesn't have any lua bindings, at least not with 1.0.7.
84 Do not advertise python2 as python3 should be used instead
85 <bridgehead renderas="sect4">Optional</bridgehead>
86 <para role="optional">
87 <xref linkend="lua"/> (to create Lua bindings) and
88 <xref linkend="python2"/> (to create python2 bindings)
89 </para>
90-->
91 <para condition="html" role="usernotes">
92 User Notes: <ulink url="&blfs-wiki;/brotli"/>
93 </para>
94 </sect2>
95
96
97 <sect2 role="installation">
98 <title>Installation of Brotli</title>
99
100 <para>
101 At first, fix an issue in pkg-config files:
102 </para>
103
104<screen><userinput>sed -i 's@-R..libdir.@@' scripts/*.pc.in</userinput></screen>
105
106 <para>
107 Install <application>brotli</application> by running the following
108 commands:
109 </para>
110
111<screen><userinput>mkdir out &amp;&amp;
112cd out &amp;&amp;
113
114cmake -DCMAKE_INSTALL_PREFIX=/usr \
115 -DCMAKE_BUILD_TYPE=Release \
116 .. &amp;&amp;
117make</userinput></screen>
118
119
120 <para>
121 To test the results, issue: <command>make test</command>
122 </para>
123
124 <para>
125 If desired, build the <application>Python3</application>
126 bindings:
127 </para>
128
129<screen><userinput>pushd .. &amp;&amp;
130python3 setup.py build &amp;&amp;
131popd</userinput></screen>
132<!-- These are broken
133-->
134 <para>
135 The python tests are missing most of the necessary testdata files and
136 therefore 240 of 311 tests fail.
137 If you nevertheless wish to test the bindings, go back to the top-level directory and
138 issue: <command>python3 setup.py test</command>.
139 </para>
140
141 <para>
142 Now, as the <systemitem class="username">root</systemitem> user:
143 </para>
144
145<screen role="root"><userinput>make install &amp;&amp;
146cd ..</userinput></screen>
147
148 <para>
149 If you have built the <application>python</application> bindings,
150 install them as the <systemitem class="username">root</systemitem>
151 user:
152 </para>
153
154<!-- EDITORS: for DESTDIR style installs use
155python3 setup.py install \-\-root /some/where -->
156<screen role="root"><userinput>python3 setup.py install --optimize=1</userinput></screen>
157
158 </sect2>
159
160 <sect2 role="content">
161 <title>Contents</title>
162
163 <segmentedlist>
164 <segtitle>Installed Programs</segtitle>
165 <segtitle>Installed Libraries</segtitle>
166 <segtitle>Installed Directory</segtitle>
167
168 <seglistitem>
169 <seg>
170 brotli
171 </seg>
172 <seg>
173 libbrotlicommon{-static.a,.so},
174 libbrotlidec{,-static.a,.so}, and
175 libbrotlienc{,-static.a,.so}
176 </seg>
177 <seg>
178 /usr/include/brotli
179 </seg>
180 </seglistitem>
181 </segmentedlist>
182
183 <variablelist>
184 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
185 <?dbfo list-presentation="list"?>
186 <?dbhtml list-presentation="table"?>
187
188 <varlistentry id="brotli-prog">
189 <term><command>brotli</command></term>
190 <listitem>
191 <para>
192 can compress or decompress files, or test the integrity of
193 compressed files
194 </para>
195 <indexterm zone="brotli brotli-prog">
196 <primary sortas="b-brotli">brotli</primary>
197 </indexterm>
198 </listitem>
199 </varlistentry>
200
201 <varlistentry id="libbrotlicommon">
202 <term><filename class="libraryfile">libbrotlicommon{-static.a,.so}</filename></term>
203 <listitem>
204 <para>
205 is the Brotli common dictionary library
206 </para>
207 <indexterm zone="brotli libbrotlicommon">
208 <primary sortas="c-libbrotlicommon">libbrotlicommon{,-static.a,.so}</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="libbrotlidec">
214 <term><filename class="libraryfile">libbrotlidec{-static.a,.so}</filename></term>
215 <listitem>
216 <para>
217 is the Brotli decoder library
218 </para>
219 <indexterm zone="brotli libbrotlidec">
220 <primary sortas="c-libbrotlidec">libbrotlidec{,-static.a,.so}</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="libbrotlienc">
226 <term><filename class="libraryfile">libbrotlienc{-static.a,.so}</filename></term>
227 <listitem>
228 <para>
229 is the Brotli common encoder library
230 </para>
231 <indexterm zone="brotli libbrotlienc">
232 <primary sortas="c-libbrotlienc">libbrotlienc{,-static.a,.so}</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236 </variablelist>
237
238 </sect2>
239
240</sect1>
Note: See TracBrowser for help on using the repository browser.