[52d29f7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8180b89] | 7 | <!ENTITY libxml2-download-http "http://xmlsoft.org/sources/libxml2-&libxml2-version;.tar.gz">
|
---|
| 8 | <!ENTITY libxml2-download-ftp "ftp://xmlsoft.org/libxml2/libxml2-&libxml2-version;.tar.gz">
|
---|
[dff94d4] | 9 | <!ENTITY libxml2-md5sum "dbae8327d8471941bf0472e273473e36">
|
---|
[cf83ea8] | 10 | <!ENTITY libxml2-size "5.2 MB">
|
---|
[dff94d4] | 11 | <!ENTITY libxml2-buildsize "97 MB (add 30 MB for tests)">
|
---|
| 12 | <!ENTITY libxml2-time "0.4 SBU (add 0.3 SBU for tests)">
|
---|
[6b262734] | 13 | <!ENTITY testsuite-version "20130923">
|
---|
[52d29f7] | 14 | ]>
|
---|
| 15 |
|
---|
[f45b1953] | 16 | <sect1 id="libxml2" xreflabel="libxml2-&libxml2-version;">
|
---|
[1515ed8a] | 17 | <?dbhtml filename="libxml2.html"?>
|
---|
[8e75f8b9] | 18 |
|
---|
[1515ed8a] | 19 | <sect1info>
|
---|
| 20 | <othername>$LastChangedBy$</othername>
|
---|
| 21 | <date>$Date$</date>
|
---|
| 22 | </sect1info>
|
---|
[8e75f8b9] | 23 |
|
---|
[437700ae] | 24 | <title>libxml2-&libxml2-version;</title>
|
---|
[8e75f8b9] | 25 |
|
---|
[1515ed8a] | 26 | <indexterm zone="libxml2">
|
---|
[8180b89] | 27 | <primary sortas="a-libxml2">libxml2</primary>
|
---|
[1515ed8a] | 28 | </indexterm>
|
---|
| 29 |
|
---|
| 30 | <sect2 role="package">
|
---|
[437700ae] | 31 | <title>Introduction to libxml2</title>
|
---|
[8e75f8b9] | 32 |
|
---|
[325113f] | 33 | <para>
|
---|
[8180b89] | 34 | The <application>libxml2</application> package contains libraries
|
---|
| 35 | and utilities used for parsing XML files.
|
---|
[325113f] | 36 | </para>
|
---|
[8e75f8b9] | 37 |
|
---|
[4bf60a36] | 38 | &lfs81_checked;
|
---|
[7f4cdbc0] | 39 |
|
---|
[1515ed8a] | 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[8180b89] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&libxml2-download-http;"/>
|
---|
| 45 | </para>
|
---|
[1515ed8a] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[8180b89] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&libxml2-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[1515ed8a] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[8180b89] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &libxml2-md5sum;
|
---|
| 55 | </para>
|
---|
[1515ed8a] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[8180b89] | 58 | <para>
|
---|
| 59 | Download size: &libxml2-size;
|
---|
| 60 | </para>
|
---|
[1515ed8a] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[8180b89] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &libxml2-buildsize;
|
---|
| 65 | </para>
|
---|
[1515ed8a] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[8180b89] | 68 | <para>
|
---|
| 69 | Estimated build time: &libxml2-time;
|
---|
| 70 | </para>
|
---|
[1515ed8a] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
[8e75f8b9] | 73 |
|
---|
[9a788838] | 74 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
[8180b89] | 75 | <itemizedlist spacing="compact">
|
---|
[5da63eb] | 76 | <listitem>
|
---|
[325113f] | 77 | <para>
|
---|
| 78 | Optional Testsuite:
|
---|
[6b262734] | 79 | <ulink url="http://www.w3.org/XML/Test/xmlts&testsuite-version;.tar.gz"/> - This
|
---|
[325113f] | 80 | enables <command>make check</command> to do complete testing.
|
---|
| 81 | </para>
|
---|
[5da63eb] | 82 | </listitem>
|
---|
[cef5d3a] | 83 | <!-- All CVEs seem to have been applied in 2.9.4
|
---|
[391c170] | 84 | <listitem>
|
---|
| 85 | <para>
|
---|
| 86 | Required patch:
|
---|
| 87 | <ulink url="&patch-root;/libxml2-&libxml2-version;-security_fixes-1.patch"/>
|
---|
| 88 | </para>
|
---|
[cef5d3a] | 89 | </listitem>-->
|
---|
[9a788838] | 90 | </itemizedlist>
|
---|
[5da63eb] | 91 |
|
---|
[437700ae] | 92 | <bridgehead renderas="sect3">libxml2 Dependencies</bridgehead>
|
---|
[8e75f8b9] | 93 |
|
---|
[60ddbaf] | 94 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 95 | <para role="optional">
|
---|
| 96 | <xref linkend="python2"/> <!--or <xref linkend="python3"/> (to build and
|
---|
[ca25773] | 97 | install a <application>Python</application> library module, additionally
|
---|
[60ddbaf] | 98 | it is required to run the full suite of tests)-->
|
---|
[40eb6f7] | 99 | <!-- As discovered by Bruce, itstool needs this module. -->
|
---|
[325113f] | 100 | </para>
|
---|
[0af6ce1] | 101 |
|
---|
[1aadfdf] | 102 | <note>
|
---|
[325113f] | 103 | <para>
|
---|
| 104 | Some packages which utilize <application>libxml2</application> (such as
|
---|
| 105 | <application>GNOME Doc Utils</application>) need the
|
---|
| 106 | <application>Python</application> module installed to function properly
|
---|
[5bee197] | 107 | and some packages will not build properly if the
|
---|
[325113f] | 108 | <application>Python</application> module is not available.
|
---|
| 109 | </para>
|
---|
[1aadfdf] | 110 | </note>
|
---|
| 111 |
|
---|
[3fe6951] | 112 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[ec91d9f] | 113 | <para role="optional">
|
---|
[626576d4] | 114 | <xref linkend="icu"/> and
|
---|
[ec91d9f] | 115 | <xref linkend="valgrind"/> (may be used in the tests)
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
[325113f] | 118 | <para condition="html" role="usernotes">
|
---|
| 119 | User Notes: <ulink url="&blfs-wiki;/libxml2"/>
|
---|
| 120 | </para>
|
---|
[1515ed8a] | 121 | </sect2>
|
---|
[8e75f8b9] | 122 |
|
---|
[1515ed8a] | 123 | <sect2 role="installation">
|
---|
[437700ae] | 124 | <title>Installation of libxml2</title>
|
---|
[1515ed8a] | 125 |
|
---|
[cf83ea8] | 126 | <!-- <para>
|
---|
[ca25773] | 127 | If you want to build the <application>Python</application> module for
|
---|
| 128 | <xref linkend="python3"/>, run:
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
| 131 | <screen><userinput>sed -i '/_PyVerify_fd/,+1d' python/types.c</userinput></screen>
|
---|
[cf83ea8] | 132 | -->
|
---|
[325113f] | 133 | <para>
|
---|
| 134 | Install <application>libxml2</application> by running the following
|
---|
| 135 | commands:
|
---|
| 136 | </para>
|
---|
[1515ed8a] | 137 |
|
---|
[f2e7e668] | 138 | <screen><userinput>./configure --prefix=/usr \
|
---|
[60ddbaf] | 139 | --disable-static \
|
---|
| 140 | --with-history \
|
---|
| 141 | --with-python=/usr/bin/python3 &&
|
---|
[1515ed8a] | 142 | make</userinput></screen>
|
---|
| 143 |
|
---|
[6000a3e] | 144 | <para>If you downloaded the testsuite, issue the following command:</para>
|
---|
| 145 |
|
---|
| 146 | <screen><userinput>tar xf ../xmlts&testsuite-version;.tar.gz</userinput></screen>
|
---|
| 147 |
|
---|
[8180b89] | 148 | <para>
|
---|
[beee921] | 149 | To test the results, issue: <command>make check > check.log</command>.
|
---|
| 150 | A summary of the results can be obtained with <command>grep -E
|
---|
| 151 | '^Total|expected' check.log</command>. If <xref linkend="valgrind"/> is
|
---|
| 152 | installed and you want to check memory leaks, replace
|
---|
| 153 | <command>check</command> with <command>check-valgrind</command>.
|
---|
[8180b89] | 154 | </para>
|
---|
[8e75f8b9] | 155 |
|
---|
[cf83ea8] | 156 | <note>
|
---|
| 157 | <para>
|
---|
| 158 | The tests use <ulink url="http://localhost/">http://localhost/</ulink>
|
---|
| 159 | to test parsing of external entities. If the machine where you run the
|
---|
| 160 | tests serves as a web site, the tests may hang, depending on the
|
---|
| 161 | content of the file served. It is therefore recommended to shut down
|
---|
| 162 | the server during the tests, as the <systemitem
|
---|
| 163 | class="username">root</systemitem> user:
|
---|
| 164 | </para>
|
---|
| 165 |
|
---|
| 166 | <screen role="nodump" revision="sysv"><userinput>/etc/init.d/httpd stop</userinput></screen>
|
---|
| 167 | <screen role="nodump" revision="systemd"><userinput>systemctl stop httpd.service</userinput></screen>
|
---|
| 168 |
|
---|
| 169 | </note>
|
---|
[325113f] | 170 | <para>
|
---|
| 171 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 172 | </para>
|
---|
[8e75f8b9] | 173 |
|
---|
[1515ed8a] | 174 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 175 | </sect2>
|
---|
[8e75f8b9] | 176 |
|
---|
[1515ed8a] | 177 | <sect2 role="commands">
|
---|
| 178 | <title>Command Explanations</title>
|
---|
| 179 |
|
---|
[325113f] | 180 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 181 | href="../../xincludes/static-libraries.xml"/>
|
---|
[5da63eb] | 182 |
|
---|
[325113f] | 183 | <para>
|
---|
[f48df219] | 184 | <parameter>--with-history</parameter>: This switch enables
|
---|
[325113f] | 185 | <application>Readline</application> support when running
|
---|
| 186 | <command>xmlcatalog</command> or <command>xmllint</command> in shell mode.
|
---|
| 187 | </para>
|
---|
[8180b89] | 188 |
|
---|
[f48df219] | 189 | <para>
|
---|
| 190 | <option>--with-python=/usr/bin/python3</option>: Add this switch if you
|
---|
| 191 | want libxml2 to use Python3 instead of Python2.
|
---|
| 192 | </para>
|
---|
| 193 |
|
---|
[ca25773] | 194 | <para>
|
---|
| 195 | <option>--with-icu</option>: Add this switch if you have built
|
---|
| 196 | <xref linkend="icu"/>, for better unicode support.
|
---|
| 197 | </para>
|
---|
| 198 |
|
---|
| 199 | <para>
|
---|
| 200 | <option>--with-threads</option>: Add this switch to enable multithread
|
---|
| 201 | support.
|
---|
| 202 | </para>
|
---|
| 203 |
|
---|
[1515ed8a] | 204 | </sect2>
|
---|
[8e75f8b9] | 205 |
|
---|
[1515ed8a] | 206 | <sect2 role="content">
|
---|
| 207 | <title>Contents</title>
|
---|
| 208 |
|
---|
| 209 | <segmentedlist>
|
---|
| 210 | <segtitle>Installed Programs</segtitle>
|
---|
| 211 | <segtitle>Installed Libraries</segtitle>
|
---|
| 212 | <segtitle>Installed Directories</segtitle>
|
---|
[8e75f8b9] | 213 |
|
---|
[1515ed8a] | 214 | <seglistitem>
|
---|
[325113f] | 215 | <seg>
|
---|
[8180b89] | 216 | xml2-config, xmlcatalog and xmllint
|
---|
[325113f] | 217 | </seg>
|
---|
| 218 | <seg>
|
---|
| 219 | libxml2.so and optionally, the libxml2mod.so
|
---|
| 220 | <application>Python</application> module
|
---|
| 221 | </seg>
|
---|
| 222 | <seg>
|
---|
| 223 | /usr/include/libxml2,
|
---|
[ec91d9f] | 224 | /usr/lib/cmake/libxml2,
|
---|
[325113f] | 225 | /usr/share/doc/libxml2-&libxml2-version;,
|
---|
[ec91d9f] | 226 | /usr/share/doc/libxml2-python-&libxml2-version;, and
|
---|
[325113f] | 227 | /usr/share/gtk-doc/html/libxml2
|
---|
| 228 | </seg>
|
---|
[1515ed8a] | 229 | </seglistitem>
|
---|
| 230 | </segmentedlist>
|
---|
[8e75f8b9] | 231 |
|
---|
[1515ed8a] | 232 | <variablelist>
|
---|
| 233 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 234 | <?dbfo list-presentation="list"?>
|
---|
| 235 | <?dbhtml list-presentation="table"?>
|
---|
[8e75f8b9] | 236 |
|
---|
[1515ed8a] | 237 | <varlistentry id="xml2-config">
|
---|
| 238 | <term><command>xml2-config</command></term>
|
---|
| 239 | <listitem>
|
---|
[325113f] | 240 | <para>
|
---|
| 241 | determines the compile and linker flags that should be used to
|
---|
| 242 | compile and link programs that use
|
---|
| 243 | <filename class='libraryfile'>libxml2</filename>.
|
---|
| 244 | </para>
|
---|
[1515ed8a] | 245 | <indexterm zone="libxml2 xml2-config">
|
---|
| 246 | <primary sortas="b-xml2-config">xml2-config</primary>
|
---|
| 247 | </indexterm>
|
---|
| 248 | </listitem>
|
---|
| 249 | </varlistentry>
|
---|
[8e75f8b9] | 250 |
|
---|
[1515ed8a] | 251 | <varlistentry id="xmlcatalog">
|
---|
| 252 | <term><command>xmlcatalog</command></term>
|
---|
| 253 | <listitem>
|
---|
[325113f] | 254 | <para>
|
---|
| 255 | is used to monitor and manipulate XML and SGML catalogs.
|
---|
| 256 | </para>
|
---|
[1515ed8a] | 257 | <indexterm zone="libxml2 xmlcatalog">
|
---|
| 258 | <primary sortas="b-xmlcatalog">xmlcatalog</primary>
|
---|
| 259 | </indexterm>
|
---|
| 260 | </listitem>
|
---|
| 261 | </varlistentry>
|
---|
[8e75f8b9] | 262 |
|
---|
[1515ed8a] | 263 | <varlistentry id="xmllint">
|
---|
| 264 | <term><command>xmllint</command></term>
|
---|
| 265 | <listitem>
|
---|
[325113f] | 266 | <para>
|
---|
| 267 | parses XML files and outputs reports (based upon options) to detect
|
---|
| 268 | errors in XML coding.
|
---|
| 269 | </para>
|
---|
[1515ed8a] | 270 | <indexterm zone="libxml2 xmllint">
|
---|
| 271 | <primary sortas="b-xmllint">xmllint</primary>
|
---|
| 272 | </indexterm>
|
---|
| 273 | </listitem>
|
---|
| 274 | </varlistentry>
|
---|
[8e75f8b9] | 275 |
|
---|
[1515ed8a] | 276 | <varlistentry id="libxml2-lib">
|
---|
[8180b89] | 277 | <term><filename class="libraryfile">libxml2.so</filename></term>
|
---|
[1515ed8a] | 278 | <listitem>
|
---|
[325113f] | 279 | <para>
|
---|
| 280 | provides functions for programs to parse files that use the XML
|
---|
| 281 | format.
|
---|
| 282 | </para>
|
---|
[1515ed8a] | 283 | <indexterm zone="libxml2 libxml2-lib">
|
---|
[325113f] | 284 | <primary sortas="c-libxml2">libxml2.so</primary>
|
---|
[1515ed8a] | 285 | </indexterm>
|
---|
| 286 | </listitem>
|
---|
| 287 | </varlistentry>
|
---|
[8180b89] | 288 |
|
---|
[1515ed8a] | 289 | </variablelist>
|
---|
[8180b89] | 290 |
|
---|
[1515ed8a] | 291 | </sect2>
|
---|
[8180b89] | 292 |
|
---|
[f45b1953] | 293 | </sect1>
|
---|