source: general/genlib/libxml2.xml@ eeaa41b7

10.0 10.1 11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since eeaa41b7 was eeaa41b7, checked in by Douglas R. Reno <renodr@…>, 2 years ago

Some tags, and a fix for the libarchive test suite problem

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

  • Property mode set to 100644
File size: 11.7 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 <!-- Also update the download, md5, size entities in libxml2py2.xml -->
8 <!ENTITY libxml2-download-http "http://xmlsoft.org/sources/libxml2-&libxml2-version;.tar.gz">
9 <!ENTITY libxml2-download-ftp "ftp://xmlsoft.org/libxml2/libxml2-&libxml2-version;.tar.gz">
10 <!ENTITY libxml2-md5sum "10942a1dc23137a8aa07f0639cbfece5">
11 <!ENTITY libxml2-size "5.4 MB">
12 <!ENTITY libxml2-buildsize "87 MB (add 15 MB for tests)">
13 <!ENTITY libxml2-time "0.2 SBU (add 0.3 SBU for tests)">
14 <!ENTITY testsuite-version "20130923">
15]>
16
17<sect1 id="libxml2" xreflabel="libxml2-&libxml2-version;">
18 <?dbhtml filename="libxml2.html"?>
19
20 <sect1info>
21 <othername>$LastChangedBy$</othername>
22 <date>$Date$</date>
23 </sect1info>
24
25 <title>libxml2-&libxml2-version;</title>
26
27 <indexterm zone="libxml2">
28 <primary sortas="a-libxml2">libxml2</primary>
29 </indexterm>
30
31 <sect2 role="package">
32 <title>Introduction to libxml2</title>
33
34 <para>
35 The <application>libxml2</application> package contains libraries
36 and utilities used for parsing XML files.
37 </para>
38
39 &lfs10_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&libxml2-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&libxml2-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &libxml2-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &libxml2-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &libxml2-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &libxml2-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Optional Testsuite:
80 <ulink url="http://www.w3.org/XML/Test/xmlts&testsuite-version;.tar.gz"/> - This
81 enables <command>make check</command> to do complete testing.
82 </para>
83 </listitem>
84<!--
85 <listitem>
86 <para>
87 Recommended patch to prevent a segfault in itstool when using Python3:
88 <ulink url="&patch-root;/libxml2-&libxml2-version;-python3_hack-1.patch"/>
89 </para>
90 </listitem> -->
91 </itemizedlist>
92
93 <bridgehead renderas="sect3">libxml2 Dependencies</bridgehead>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 <xref linkend="python2"/> <!--or <xref linkend="python3"/> (to build and
98 install a <application>Python</application> library module, additionally
99 it is required to run the full suite of tests)-->
100 <!-- As discovered by Bruce, itstool needs this module. -->
101 </para>
102
103 <note>
104 <para>
105 Some packages which utilize <application>libxml2</application> (such as
106 <application>GNOME Doc Utils</application>) need the
107 <application>Python3</application> module installed to function properly
108 and some packages will not build properly if the
109 <application>Python3</application> module is not available.
110 </para>
111
112 <para>
113 The old <application>Python2</application> module can be built after
114 <filename class="libraryfile">libxml2.so</filename> has been installed,
115 see <xref linkend="libxml2py2"/>.
116 </para>
117 </note>
118
119 <bridgehead renderas="sect4">Optional</bridgehead>
120 <para role="optional">
121 <xref linkend="icu"/> and
122 <xref linkend="valgrind"/> (may be used in the tests)
123 </para>
124
125 <para condition="html" role="usernotes">
126 User Notes: <ulink url="&blfs-wiki;/libxml2"/>
127 </para>
128 </sect2>
129
130 <sect2 role="installation">
131 <title>Installation of libxml2</title>
132<!--
133 <para>
134 First apply a patch, which prevents segfaults in the Python module, when
135 built by <xref linkend="python3"/>:
136 </para>
137
138<screen><userinput>patch -Np1 -i ../libxml2-&libxml2-version;-python3_hack-1.patch</userinput></screen>
139
140 <para>
141 To ensure that the <application>Python</application> module can be
142 built by <xref linkend="python3"/>, run:
143 </para>
144
145<screen><userinput>sed -i '/_PyVerify_fd/,+1d' python/types.c</userinput></screen>
146-->
147 <para>
148 If you are going to run the tests, disable one test that prevents the
149 tests from completing:
150 </para>
151
152<screen><userinput>sed -i 's/test.test/#&amp;/' python/tests/tstLastError.py</userinput></screen>
153
154 <para>
155 Install <application>libxml2</application> by running the following
156 commands:
157 </para>
158
159<screen><userinput>./configure --prefix=/usr \
160 --disable-static \
161 --with-history \
162 --with-python=/usr/bin/python3 &amp;&amp;
163make</userinput></screen>
164
165 <para>
166 If you downloaded the testsuite, issue the following command:
167 </para>
168
169<screen><userinput>tar xf ../xmlts&testsuite-version;.tar.gz</userinput></screen>
170
171 <para>
172 To test the results, issue: <command>make check &gt; check.log</command>.
173 A summary of the results can be obtained with <command>grep -E
174 '^Total|expected' check.log</command>. If <xref linkend="valgrind"/> is
175 installed and you want to check memory leaks, replace
176 <command>check</command> with <command>check-valgrind</command>.
177 </para>
178
179 <note>
180 <para>
181 The tests use <ulink url="http://localhost/">http://localhost/</ulink>
182 to test parsing of external entities. If the machine where you run the
183 tests serves as a web site, the tests may hang, depending on the
184 content of the file served. It is therefore recommended to shut down
185 the server during the tests, as the <systemitem
186 class="username">root</systemitem> user:
187 </para>
188
189<screen role="nodump" revision="sysv"><userinput>/etc/init.d/httpd stop</userinput></screen>
190<screen role="nodump" revision="systemd"><userinput>systemctl stop httpd.service</userinput></screen>
191
192 </note>
193 <para>
194 Now, as the <systemitem class="username">root</systemitem> user:
195 </para>
196
197<screen role="root"><userinput>make install</userinput></screen>
198 </sect2>
199
200 <sect2 role="commands">
201 <title>Command Explanations</title>
202
203 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
204 href="../../xincludes/static-libraries.xml"/>
205<!--
206 <para>
207 <parameter>sed -i '/_PyVerify_fd/,+1d' python/types.c</parameter>: This
208 fixes the <application>Python3</application> code to build with
209 <application>gcc-7</application>.
210 </para>
211-->
212 <para>
213 <parameter>--with-history</parameter>: This switch enables
214 <application>Readline</application> support when running
215 <command>xmlcatalog</command> or <command>xmllint</command> in shell mode.
216 </para>
217
218 <para>
219 <parameter>--with-python=/usr/bin/python3</parameter>: Allows building
220 the libxml2 module with Python3 instead of Python2.
221 </para>
222
223 <para>
224 <option>--with-icu</option>: Add this switch if you have built
225 <xref linkend="icu"/>, for better unicode support.
226 </para>
227
228 <para>
229 <option>--with-threads</option>: Add this switch to enable multithread
230 support.
231 </para>
232
233 </sect2>
234
235 <sect2 role="content">
236 <title>Contents</title>
237
238 <segmentedlist>
239 <segtitle>Installed Programs</segtitle>
240 <segtitle>Installed Libraries</segtitle>
241 <segtitle>Installed Directories</segtitle>
242
243 <seglistitem>
244 <seg>
245 xml2-config,
246 xmlcatalog, and
247 xmllint <!--and the
248 drv_libxml2.py and libxml2.py <application>Python3</application>
249 modules. These are pythin modules, not programs -->
250 </seg>
251 <seg>
252 libxml2.so and
253 libxml2mod.so (<application>Python3</application> module)
254 </seg>
255 <seg>
256 /usr/include/libxml2,
257 /usr/lib/cmake/libxml2,
258 /usr/share/doc/libxml2-&libxml2-version;,
259 /usr/share/doc/libxml2-python-&libxml2-version;, and
260 /usr/share/gtk-doc/html/libxml2
261 </seg>
262 </seglistitem>
263 </segmentedlist>
264
265 <variablelist>
266 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
267 <?dbfo list-presentation="list"?>
268 <?dbhtml list-presentation="table"?>
269
270 <varlistentry id="xml2-config">
271 <term><command>xml2-config</command></term>
272 <listitem>
273 <para>
274 determines the compile and linker flags that should be used to
275 compile and link programs that use
276 <filename class='libraryfile'>libxml2</filename>.
277 </para>
278 <indexterm zone="libxml2 xml2-config">
279 <primary sortas="b-xml2-config">xml2-config</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="xmlcatalog">
285 <term><command>xmlcatalog</command></term>
286 <listitem>
287 <para>
288 is used to monitor and manipulate XML and SGML catalogs.
289 </para>
290 <indexterm zone="libxml2 xmlcatalog">
291 <primary sortas="b-xmlcatalog">xmlcatalog</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="xmllint">
297 <term><command>xmllint</command></term>
298 <listitem>
299 <para>
300 parses XML files and outputs reports (based upon options) to detect
301 errors in XML coding.
302 </para>
303 <indexterm zone="libxml2 xmllint">
304 <primary sortas="b-xmllint">xmllint</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308<!--
309 <varlistentry id="drv_libxml2.py3">
310 <term><command>drv_libxml2.py</command></term>
311 <listitem>
312 <para>
313 is a SAX <application>Python3</application> driver for libxml2.
314 </para>
315 <indexterm zone="libxml2 drv_libxml2.py3">
316 <primary sortas="b-drv_libxml2.py3">drv_libxml2.py for Python3</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="libxml2.py3">
322 <term><command>libxml2.py</command></term>
323 <listitem>
324 <para>
325 is the <application>Python3</application> binding for libxml2.
326 </para>
327 <indexterm zone="libxml2 libxml2.py3">
328 <primary sortas="b-libxml2.py3">libxml2.py for Python3</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332-->
333 <varlistentry id="libxml2-lib">
334 <term><filename class="libraryfile">libxml2.so</filename></term>
335 <listitem>
336 <para>
337 provides functions for programs to parse files that use the XML
338 format.
339 </para>
340 <indexterm zone="libxml2 libxml2-lib">
341 <primary sortas="c-libxml2">libxml2.so</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="libxml2mod3">
347 <term><filename class="libraryfile">libxml2mod.so</filename></term>
348 <listitem>
349 <para>
350 is the interface for <application>Python3</application>
351 to use <filename class="libraryfile">libxml2.so</filename>.
352 </para>
353 <indexterm zone="libxml2 libxml2mod3">
354 <primary sortas="c-libxml2mod">libxml2mod.so</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 </variablelist>
360
361 </sect2>
362
363</sect1>
Note: See TracBrowser for help on using the repository browser.