[872db717] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY pyxml-download-http "http://prdownloads.sourceforge.net/pyxml/PyXML-&pyxml-version;.tar.gz">
|
---|
| 8 | <!ENTITY pyxml-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/PyXML-&pyxml-version;.tar.gz">
|
---|
| 9 | <!ENTITY pyxml-md5sum "1f7655050cebbb664db976405fdba209">
|
---|
| 10 | <!ENTITY pyxml-size "734 KB">
|
---|
| 11 | <!ENTITY pyxml-buildsize "14.6 MB">
|
---|
| 12 | <!ENTITY pyxml-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="pyxml" xreflabel="PyXML-&pyxml-version;">
|
---|
| 16 | <?dbhtml filename="pyxml.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
[bccbdaea] | 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[256ee72c] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">PyXML-&pyxml-version;.tar</keyword>
|
---|
[22ac237] | 23 | <keyword role="ftpdir">PyXML</keyword>
|
---|
[256ee72c] | 24 | </keywordset>
|
---|
[872db717] | 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>PyXML-&pyxml-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="pyxml">
|
---|
| 30 | <primary sortas="a-PyXML">PyXML</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to PyXML</title>
|
---|
| 35 |
|
---|
| 36 | <para>The <application>PyXML</application> package contains a validating
|
---|
| 37 | XML parser, an implementation of the SAX and DOM programming interfaces,
|
---|
| 38 | an interface to the Expat parser, and a C helper module that can speed up
|
---|
[bccbdaea] | 39 | <filename>xmllib.py</filename> by a factor of five. This is useful for
|
---|
[872db717] | 40 | validating, parsing and manipulating XML files using Python
|
---|
| 41 | programs.</para>
|
---|
| 42 |
|
---|
| 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (HTTP): <ulink url="&pyxml-download-http;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download (FTP): <ulink url="&pyxml-download-ftp;"/></para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download MD5 sum: &pyxml-md5sum;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download size: &pyxml-size;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated disk space required: &pyxml-buildsize;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Estimated build time: &pyxml-time;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | </itemizedlist>
|
---|
| 64 |
|
---|
| 65 | <bridgehead renderas="sect3">PyXML Dependencies</bridgehead>
|
---|
| 66 |
|
---|
| 67 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[256ee72c] | 68 | <para role="required"><xref linkend="python"/></para>
|
---|
[872db717] | 69 |
|
---|
| 70 | </sect2>
|
---|
| 71 |
|
---|
| 72 | <sect2 role="installation">
|
---|
| 73 | <title>Installation of PyXML</title>
|
---|
| 74 |
|
---|
| 75 | <para>Install <application>PyXML</application> by running the following
|
---|
| 76 | commands:</para>
|
---|
| 77 |
|
---|
| 78 | <screen><userinput>python setup.py build</userinput></screen>
|
---|
| 79 |
|
---|
| 80 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 81 |
|
---|
| 82 | <screen role="root"><userinput>python setup.py install &&
|
---|
| 83 | install -v -m644 doc/man/xmlproc_*.1 /usr/share/man/man1 &&
|
---|
| 84 | install -v -m755 -d /usr/share/doc/PyXML-&pyxml-version; &&
|
---|
| 85 | cp -v -R doc demo test /usr/share/doc/PyXML-&pyxml-version; &&
|
---|
| 86 | install -v -m644 README* /usr/share/doc/PyXML-&pyxml-version;</userinput></screen>
|
---|
| 87 |
|
---|
| 88 | <para>To run the regression tests, the package must first be installed.
|
---|
| 89 | Then, as an unprivileged user, issue the following commands:</para>
|
---|
| 90 |
|
---|
| 91 | <screen><userinput>cd test &&
|
---|
| 92 | python regrtest.py &&
|
---|
| 93 | cd ..</userinput></screen>
|
---|
| 94 |
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="commands">
|
---|
| 98 | <title>Command Explanations</title>
|
---|
| 99 |
|
---|
| 100 | <para><command>python setup.py build</command>: This command copies the
|
---|
| 101 | <filename>*.py</filename> files to a staging area and compiles the C
|
---|
| 102 | extensions.</para>
|
---|
| 103 |
|
---|
| 104 | <para><command>python setup.py install</command>: This command installs
|
---|
| 105 | the package.</para>
|
---|
| 106 |
|
---|
| 107 | </sect2>
|
---|
| 108 |
|
---|
| 109 | <sect2 role="content">
|
---|
| 110 | <title>Contents</title>
|
---|
| 111 |
|
---|
| 112 | <segmentedlist>
|
---|
| 113 | <segtitle>Installed Programs</segtitle>
|
---|
| 114 | <segtitle>Installed Libraries</segtitle>
|
---|
| 115 | <segtitle>Installed Directories</segtitle>
|
---|
| 116 |
|
---|
| 117 | <seglistitem>
|
---|
| 118 | <seg>xmlproc_parse and xmlproc_val</seg>
|
---|
| 119 | <seg>PyXML Python library modules</seg>
|
---|
| 120 | <seg>/usr/lib/python2.4/site-packages/_xmlplus and
|
---|
| 121 | /usr/share/doc/PyXML-&pyxml-version;</seg>
|
---|
| 122 | </seglistitem>
|
---|
| 123 | </segmentedlist>
|
---|
| 124 |
|
---|
| 125 | <variablelist>
|
---|
| 126 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 127 | <?dbfo list-presentation="list"?>
|
---|
| 128 | <?dbhtml list-presentation="table"?>
|
---|
| 129 |
|
---|
| 130 | <varlistentry id="xmlproc_parse">
|
---|
| 131 | <term><command>xmlproc_parse</command></term>
|
---|
| 132 | <listitem>
|
---|
| 133 | <para>is a simple XML file parser using the xmlproc parser.</para>
|
---|
| 134 | <indexterm zone="pyxml xmlproc_parse">
|
---|
| 135 | <primary sortas="b-xmlproc_parse">xmlproc_parse</primary>
|
---|
| 136 | </indexterm>
|
---|
| 137 | </listitem>
|
---|
| 138 | </varlistentry>
|
---|
| 139 |
|
---|
| 140 | <varlistentry id="xmlproc_val">
|
---|
| 141 | <term><command>xmlproc_val</command></term>
|
---|
| 142 | <listitem>
|
---|
| 143 | <para>is a validating XML file parser using the xmlproc parser.</para>
|
---|
| 144 | <indexterm zone="pyxml xmlproc_val">
|
---|
| 145 | <primary sortas="b-xmlproc_val">xmlproc_val</primary>
|
---|
| 146 | </indexterm>
|
---|
| 147 | </listitem>
|
---|
| 148 | </varlistentry>
|
---|
| 149 | </variablelist>
|
---|
| 150 |
|
---|
| 151 | </sect2>
|
---|
| 152 |
|
---|
| 153 | </sect1>
|
---|