| 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 "c04a5a0a042eaa157e8e8c9eabe76bd6">
|
|---|
| 11 | <!ENTITY libxml2-size "5.2 MB">
|
|---|
| 12 | <!ENTITY libxml2-buildsize "86 MB (add 16 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 | &lfs83_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 | Install <application>libxml2</application> by running the following
|
|---|
| 149 | commands:
|
|---|
| 150 | </para>
|
|---|
| 151 |
|
|---|
| 152 | <screen><userinput>./configure --prefix=/usr \
|
|---|
| 153 | --disable-static \
|
|---|
| 154 | --with-history \
|
|---|
| 155 | --with-python=/usr/bin/python3 &&
|
|---|
| 156 | make</userinput></screen>
|
|---|
| 157 |
|
|---|
| 158 | <para>If you downloaded the testsuite, issue the following command:</para>
|
|---|
| 159 |
|
|---|
| 160 | <screen><userinput>tar xf ../xmlts&testsuite-version;.tar.gz</userinput></screen>
|
|---|
| 161 |
|
|---|
| 162 | <para>
|
|---|
| 163 | To test the results, issue: <command>make check > check.log</command>.
|
|---|
| 164 | A summary of the results can be obtained with <command>grep -E
|
|---|
| 165 | '^Total|expected' check.log</command>. If <xref linkend="valgrind"/> is
|
|---|
| 166 | installed and you want to check memory leaks, replace
|
|---|
| 167 | <command>check</command> with <command>check-valgrind</command>.
|
|---|
| 168 | </para>
|
|---|
| 169 |
|
|---|
| 170 | <note>
|
|---|
| 171 | <para>
|
|---|
| 172 | The tests use <ulink url="http://localhost/">http://localhost/</ulink>
|
|---|
| 173 | to test parsing of external entities. If the machine where you run the
|
|---|
| 174 | tests serves as a web site, the tests may hang, depending on the
|
|---|
| 175 | content of the file served. It is therefore recommended to shut down
|
|---|
| 176 | the server during the tests, as the <systemitem
|
|---|
| 177 | class="username">root</systemitem> user:
|
|---|
| 178 | </para>
|
|---|
| 179 |
|
|---|
| 180 | <screen role="nodump" revision="sysv"><userinput>/etc/init.d/httpd stop</userinput></screen>
|
|---|
| 181 | <screen role="nodump" revision="systemd"><userinput>systemctl stop httpd.service</userinput></screen>
|
|---|
| 182 |
|
|---|
| 183 | </note>
|
|---|
| 184 | <para>
|
|---|
| 185 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 186 | </para>
|
|---|
| 187 |
|
|---|
| 188 | <screen role="root"><userinput>make install</userinput></screen>
|
|---|
| 189 | </sect2>
|
|---|
| 190 |
|
|---|
| 191 | <sect2 role="commands">
|
|---|
| 192 | <title>Command Explanations</title>
|
|---|
| 193 |
|
|---|
| 194 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 195 | href="../../xincludes/static-libraries.xml"/>
|
|---|
| 196 | <!--
|
|---|
| 197 | <para>
|
|---|
| 198 | <parameter>sed -i '/_PyVerify_fd/,+1d' python/types.c</parameter>: This
|
|---|
| 199 | fixes the <application>Python3</application> code to build with
|
|---|
| 200 | <application>gcc-7</application>.
|
|---|
| 201 | </para>
|
|---|
| 202 | -->
|
|---|
| 203 | <para>
|
|---|
| 204 | <parameter>--with-history</parameter>: This switch enables
|
|---|
| 205 | <application>Readline</application> support when running
|
|---|
| 206 | <command>xmlcatalog</command> or <command>xmllint</command> in shell mode.
|
|---|
| 207 | </para>
|
|---|
| 208 |
|
|---|
| 209 | <para>
|
|---|
| 210 | <parameter>--with-python=/usr/bin/python3</parameter>: Allows building
|
|---|
| 211 | the libxml2 module with Python3 instead of Python2.
|
|---|
| 212 | </para>
|
|---|
| 213 |
|
|---|
| 214 | <para>
|
|---|
| 215 | <option>--with-icu</option>: Add this switch if you have built
|
|---|
| 216 | <xref linkend="icu"/>, for better unicode support.
|
|---|
| 217 | </para>
|
|---|
| 218 |
|
|---|
| 219 | <para>
|
|---|
| 220 | <option>--with-threads</option>: Add this switch to enable multithread
|
|---|
| 221 | support.
|
|---|
| 222 | </para>
|
|---|
| 223 |
|
|---|
| 224 | </sect2>
|
|---|
| 225 |
|
|---|
| 226 | <sect2 role="content">
|
|---|
| 227 | <title>Contents</title>
|
|---|
| 228 |
|
|---|
| 229 | <segmentedlist>
|
|---|
| 230 | <segtitle>Installed Programs</segtitle>
|
|---|
| 231 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 232 | <segtitle>Installed Directories</segtitle>
|
|---|
| 233 |
|
|---|
| 234 | <seglistitem>
|
|---|
| 235 | <seg>
|
|---|
| 236 | xml2-config,
|
|---|
| 237 | xmlcatalog, and
|
|---|
| 238 | xmllint <!--and the
|
|---|
| 239 | drv_libxml2.py and libxml2.py <application>Python3</application>
|
|---|
| 240 | modules. These are pythin modules, not programs -->
|
|---|
| 241 | </seg>
|
|---|
| 242 | <seg>
|
|---|
| 243 | libxml2.so and
|
|---|
| 244 | libxml2mod.so (<application>Python3</application> module)
|
|---|
| 245 | </seg>
|
|---|
| 246 | <seg>
|
|---|
| 247 | /usr/include/libxml2,
|
|---|
| 248 | /usr/lib/cmake/libxml2,
|
|---|
| 249 | /usr/share/doc/libxml2-&libxml2-version;,
|
|---|
| 250 | /usr/share/doc/libxml2-python-&libxml2-version;, and
|
|---|
| 251 | /usr/share/gtk-doc/html/libxml2
|
|---|
| 252 | </seg>
|
|---|
| 253 | </seglistitem>
|
|---|
| 254 | </segmentedlist>
|
|---|
| 255 |
|
|---|
| 256 | <variablelist>
|
|---|
| 257 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 258 | <?dbfo list-presentation="list"?>
|
|---|
| 259 | <?dbhtml list-presentation="table"?>
|
|---|
| 260 |
|
|---|
| 261 | <varlistentry id="xml2-config">
|
|---|
| 262 | <term><command>xml2-config</command></term>
|
|---|
| 263 | <listitem>
|
|---|
| 264 | <para>
|
|---|
| 265 | determines the compile and linker flags that should be used to
|
|---|
| 266 | compile and link programs that use
|
|---|
| 267 | <filename class='libraryfile'>libxml2</filename>.
|
|---|
| 268 | </para>
|
|---|
| 269 | <indexterm zone="libxml2 xml2-config">
|
|---|
| 270 | <primary sortas="b-xml2-config">xml2-config</primary>
|
|---|
| 271 | </indexterm>
|
|---|
| 272 | </listitem>
|
|---|
| 273 | </varlistentry>
|
|---|
| 274 |
|
|---|
| 275 | <varlistentry id="xmlcatalog">
|
|---|
| 276 | <term><command>xmlcatalog</command></term>
|
|---|
| 277 | <listitem>
|
|---|
| 278 | <para>
|
|---|
| 279 | is used to monitor and manipulate XML and SGML catalogs.
|
|---|
| 280 | </para>
|
|---|
| 281 | <indexterm zone="libxml2 xmlcatalog">
|
|---|
| 282 | <primary sortas="b-xmlcatalog">xmlcatalog</primary>
|
|---|
| 283 | </indexterm>
|
|---|
| 284 | </listitem>
|
|---|
| 285 | </varlistentry>
|
|---|
| 286 |
|
|---|
| 287 | <varlistentry id="xmllint">
|
|---|
| 288 | <term><command>xmllint</command></term>
|
|---|
| 289 | <listitem>
|
|---|
| 290 | <para>
|
|---|
| 291 | parses XML files and outputs reports (based upon options) to detect
|
|---|
| 292 | errors in XML coding.
|
|---|
| 293 | </para>
|
|---|
| 294 | <indexterm zone="libxml2 xmllint">
|
|---|
| 295 | <primary sortas="b-xmllint">xmllint</primary>
|
|---|
| 296 | </indexterm>
|
|---|
| 297 | </listitem>
|
|---|
| 298 | </varlistentry>
|
|---|
| 299 | <!--
|
|---|
| 300 | <varlistentry id="drv_libxml2.py3">
|
|---|
| 301 | <term><command>drv_libxml2.py</command></term>
|
|---|
| 302 | <listitem>
|
|---|
| 303 | <para>
|
|---|
| 304 | is a SAX <application>Python3</application> driver for libxml2.
|
|---|
| 305 | </para>
|
|---|
| 306 | <indexterm zone="libxml2 drv_libxml2.py3">
|
|---|
| 307 | <primary sortas="b-drv_libxml2.py3">drv_libxml2.py for Python3</primary>
|
|---|
| 308 | </indexterm>
|
|---|
| 309 | </listitem>
|
|---|
| 310 | </varlistentry>
|
|---|
| 311 |
|
|---|
| 312 | <varlistentry id="libxml2.py3">
|
|---|
| 313 | <term><command>libxml2.py</command></term>
|
|---|
| 314 | <listitem>
|
|---|
| 315 | <para>
|
|---|
| 316 | is the <application>Python3</application> binding for libxml2.
|
|---|
| 317 | </para>
|
|---|
| 318 | <indexterm zone="libxml2 libxml2.py3">
|
|---|
| 319 | <primary sortas="b-libxml2.py3">libxml2.py for Python3</primary>
|
|---|
| 320 | </indexterm>
|
|---|
| 321 | </listitem>
|
|---|
| 322 | </varlistentry>
|
|---|
| 323 | -->
|
|---|
| 324 | <varlistentry id="libxml2-lib">
|
|---|
| 325 | <term><filename class="libraryfile">libxml2.so</filename></term>
|
|---|
| 326 | <listitem>
|
|---|
| 327 | <para>
|
|---|
| 328 | provides functions for programs to parse files that use the XML
|
|---|
| 329 | format.
|
|---|
| 330 | </para>
|
|---|
| 331 | <indexterm zone="libxml2 libxml2-lib">
|
|---|
| 332 | <primary sortas="c-libxml2">libxml2.so</primary>
|
|---|
| 333 | </indexterm>
|
|---|
| 334 | </listitem>
|
|---|
| 335 | </varlistentry>
|
|---|
| 336 |
|
|---|
| 337 | <varlistentry id="libxml2mod3">
|
|---|
| 338 | <term><filename class="libraryfile">libxml2mod.so</filename></term>
|
|---|
| 339 | <listitem>
|
|---|
| 340 | <para>
|
|---|
| 341 | is the interface for <application>Python3</application>
|
|---|
| 342 | to use <filename class="libraryfile">libxml2.so</filename>.
|
|---|
| 343 | </para>
|
|---|
| 344 | <indexterm zone="libxml2 libxml2mod3">
|
|---|
| 345 | <primary sortas="c-libxml2mod">libxml2mod.so</primary>
|
|---|
| 346 | </indexterm>
|
|---|
| 347 | </listitem>
|
|---|
| 348 | </varlistentry>
|
|---|
| 349 |
|
|---|
| 350 | </variablelist>
|
|---|
| 351 |
|
|---|
| 352 | </sect2>
|
|---|
| 353 |
|
|---|
| 354 | </sect1>
|
|---|
