source: general/prog/pyxml.xml@ c35d927

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

  <!ENTITY pyxml-download-http "http://prdownloads.sourceforge.net/pyxml/PyXML-&pyxml-version;.tar.gz">
  <!ENTITY pyxml-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/PyXML-&pyxml-version;.tar.gz">
  <!ENTITY pyxml-md5sum        "1f7655050cebbb664db976405fdba209">
  <!ENTITY pyxml-size          "734 KB">
  <!ENTITY pyxml-buildsize     "14.6 MB">
  <!ENTITY pyxml-time          "less than 0.1 SBU">
]>

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

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

  <title>PyXML-&pyxml-version;</title>

  <indexterm zone="pyxml">
    <primary sortas="a-PyXML">PyXML</primary>
  </indexterm>

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

    <para>The <application>PyXML</application> package contains a validating
    XML parser, an implementation of the SAX and DOM programming interfaces,
    an interface to the Expat parser, and a C helper module that can speed up
    <filename>xmllib.py</filename> by a factor of five. This is useful for 
    validating, parsing and manipulating XML files using Python
    programs.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para><xref linkend="python"/></para>

  </sect2>

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

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

<screen><userinput>python setup.py build</userinput></screen>

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

<screen role="root"><userinput>python setup.py install &amp;&amp;
install -v -m644 doc/man/xmlproc_*.1 /usr/share/man/man1 &amp;&amp;
install -v -m755 -d /usr/share/doc/PyXML-&pyxml-version; &amp;&amp;
cp -v -R doc demo test /usr/share/doc/PyXML-&pyxml-version; &amp;&amp;
install -v -m644 README* /usr/share/doc/PyXML-&pyxml-version;</userinput></screen>

    <para>To run the regression tests, the package must first be installed.
    Then, as an unprivileged user, issue the following commands:</para>

<screen><userinput>cd test &amp;&amp;
python regrtest.py &amp;&amp;
cd ..</userinput></screen>

  </sect2>

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

    <para><command>python setup.py build</command>: This command copies the
    <filename>*.py</filename> files to a staging area and compiles the C
    extensions.</para>

    <para><command>python setup.py install</command>: This command installs
    the package.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>xmlproc_parse and xmlproc_val</seg>
        <seg>PyXML Python library modules</seg>
        <seg>/usr/lib/python2.4/site-packages/_xmlplus and
        /usr/share/doc/PyXML-&pyxml-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="xmlproc_parse">
        <term><command>xmlproc_parse</command></term>
        <listitem>
          <para>is a simple XML file parser using the xmlproc parser.</para>
          <indexterm zone="pyxml xmlproc_parse">
            <primary sortas="b-xmlproc_parse">xmlproc_parse</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xmlproc_val">
        <term><command>xmlproc_val</command></term>
        <listitem>
          <para>is a validating XML file parser using the xmlproc parser.</para>
          <indexterm zone="pyxml xmlproc_val">
            <primary sortas="b-xmlproc_val">xmlproc_val</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>