source: general/genlib/libxml2.xml@ a270244

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libxml2-download-http "http://xmlsoft.org/sources/libxml2-&libxml2-version;.tar.gz">
  <!ENTITY libxml2-download-ftp  "ftp://xmlsoft.org/libxml2/libxml2-&libxml2-version;.tar.gz">
  <!ENTITY libxml2-md5sum        "8f4fda3969237c2a33bdb1583b5d06b2">
  <!ENTITY libxml2-size          "4.7 MB">
  <!ENTITY libxml2-buildsize     "116 MB (additional 21 MB to run the full test suite)">
  <!ENTITY libxml2-time          "1.4 SBU (additional 0.3 SBU to run the full test suite)">
]>

<sect1 id="libxml2" xreflabel="libxml2-&libxml2-version;">
  <?dbhtml filename="libxml2.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>libxml2-&libxml2-version;</title>

  <indexterm zone="libxml2">
    <primary sortas="a-Libxml2">Libxml2</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libxml2</title>

    <para>The <application>libxml2</application> package contains
    XML libraries. These are useful for parsing XML files.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&libxml2-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&libxml2-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &libxml2-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &libxml2-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &libxml2-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &libxml2-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Optional Testsuite: <ulink
          url="http://www.w3.org/XML/Test/xmlts20080205.tar.gz"/> - This
          enables <command>make check</command> to do complete testing. Note
          that this is <emphasis>not</emphasis> the latest version of the
          testsuite, but it is the one specified by the developers.</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libxml2 Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="python"/> (to build and install a
    <application>Python</application> library module, additionally it is
    required to run the full suite of tests)</para>

    <note>
      <para>Some packages which utilize
      <application>libxml2</application> (such as
      <application>GNOME Doc Utils</application>) need the
      <application>Python</application> module installed to function
      properly and some packages (such as GNOME Panel) will not build
      properly if the <application>Python</application> module is not
      available.</para>
    </note>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/libxml2"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libxml2</title>

    <para>If you downloaded the testsuite, issue the following command:</para>

<screen><userinput>tar xf ../xmlts20080205.tar.gz</userinput></screen>

    <para>Install <application>libxml2</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--with-history</parameter>: If this option is used, it
    enables <application>Readline</application> support when running
    <command>xmlcatalog</command> or <command>xmllint</command> in shell
    mode.</para>

    <caution>
      <para>When using history support, <command>make check</command> will
      hang forever if either <filename>/etc/inputrc</filename> or
      <filename>~/.inputrc</filename> has the option
      <option>show-all-if-ambiguous</option> or
      <option>show-all-if-available</option> turned on.</para>
    </caution>

    <para><parameter>--enable-shared --disable-static</parameter>: This pair
    of switches prevents the static libraries in this package from being
    built and installed.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>xml2-config, xmlcatalog, and xmllint</seg>
        <seg>libxml2.{so,a} and optionally, the libxml2mod.{so,a}
        <application>Python</application> module</seg>
        <seg>/usr/include/libxml2, /usr/share/doc/libxml2-&libxml2-version;,
        /usr/share/doc/libxml2-python-&libxml2-version; and
        /usr/share/gtk-doc/html/libxml2</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="xml2-config">
        <term><command>xml2-config</command></term>
        <listitem>
          <para>determines the compile and linker flags that should be used to
          compile and link programs that use
          <filename class='libraryfile'>libxml2</filename>.</para>
          <indexterm zone="libxml2 xml2-config">
            <primary sortas="b-xml2-config">xml2-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xmlcatalog">
        <term><command>xmlcatalog</command></term>
        <listitem>
          <para>is used to monitor and manipulate XML
          and SGML catalogs.</para>
          <indexterm zone="libxml2 xmlcatalog">
            <primary sortas="b-xmlcatalog">xmlcatalog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xmllint">
        <term><command>xmllint</command></term>
        <listitem>
          <para>parses XML files and outputs reports (based
          upon options) to detect errors in XML coding.</para>
          <indexterm zone="libxml2 xmllint">
            <primary sortas="b-xmllint">xmllint</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libxml2-lib">
        <term><filename class='libraryfile'>libxml2.{so,a}</filename></term>
        <listitem>
          <para> libraries provide the functions for programs to parse files
          that use the XML format.</para>
          <indexterm zone="libxml2 libxml2-lib">
            <primary sortas="c-libxml2">libxml2.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>