source: general/genlib/libxml2.xml@ 58a83256

trunk
Last change on this file since 58a83256 was 58a83256, checked in by Ken Moffat <ken@…>, 2 months ago

Fixups for fltk and libxml2 -

Fix the fltk downlaod URL.

Do not mention the libxml2 patch as an additional download.

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