source: general/prog/python.xml@ 83f69e5d

<?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 python-download-http "http://www.python.org/ftp/python/&Python-version;/Python-&Python-version;.tar.bz2">
  <!ENTITY python-download-ftp "ftp://ftp.python.org/pub/python/&Python-version;/Python-&Python-version;.tar.bz2">
  <!ENTITY python-md5sum "de3e9a8836fab6df7c7ce545331afeb3">
  <!ENTITY python-size "7.8 MB">
  <!ENTITY python-buildsize "115 MB">
  <!ENTITY python-time "0.91 SBU (additional 2.20 SBU to run the testsuite)">
]>

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

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

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

  <indexterm zone="python">
    <primary sortas="a-Python">Python</primary>
  </indexterm>

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

    <para>The <application>Python</application> package contains the
    <application>Python</application> development environment.
    This is useful for object-oriented programming, writing scripts,
    prototyping large programs or developing entire applications.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch: <ulink 
        url="&patch-root;/Python-&Python-version;-gdbm-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="openssl"/>,
    <xref linkend="tk"/>, 
    <xref linkend="gdbm"/> and
    <xref linkend="db"/></para>

  </sect2>

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

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

<screen><userinput>patch -Np1 -i ../Python-&Python-version;-gdbm-1.patch &amp;&amp;
./configure --prefix=/usr --enable-shared &amp;&amp;
make</userinput></screen>

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

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

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

    <note>
      <para>There is no documentation installed using the instructions above. 
      However, There are Latex sources included with the distribution. See the 
      <filename>Doc/README</filename> file in the source distribution for 
      instructions to format the LaTex sources. Alternatively, you can download 
      preformatted documentation from 
      <ulink url="http://www.python.org/doc/current/download.html"/>.</para>
    </note>

  </sect2>

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

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

      <seglistitem>
        <seg>pydoc, python, python2.4, smtpd.py, and optionally if 
        <application>Tk</application> is installed, idle</seg>
        <seg>libpython2.4.so and numerous modules installed in 
        /usr/lib/python2.4/lib-dynload</seg>
        <seg>/usr/include/python2.4 and /usr/lib/python2.4</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="idle">
        <term><command>idle</command></term>
        <listitem>
          <para>is a wrapper script that opens a 
          <application>Python</application> aware GUI editor.</para>
          <indexterm zone="python idle">
            <primary sortas="b-idle">idle</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pydoc">
        <term><command>pydoc</command></term>
        <listitem>
          <para>is the <application>Python</application> documentation 
          tool.</para>
          <indexterm zone="python pydoc">
            <primary sortas="b-pydoc">pydoc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="python-prog">
        <term><command>python</command></term>
        <listitem>
          <para>is an interpreted, interactive, object-oriented programming 
          language.</para>
          <indexterm zone="python python-prog">
            <primary sortas="b-python">python</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="python2.4">
        <term><command>python2.4</command></term>
        <listitem>
          <para>is a version-specific name for the <command>python</command> 
          program.</para>
          <indexterm zone="python python2.4">
            <primary sortas="b-python2.4">python2.4</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="smtpd.py">
        <term><command>smtpd.py</command></term>
        <listitem>
          <para>is an SMTP proxy implemented in 
          <application>Python</application>.</para>
          <indexterm zone="python smtpd.py">
            <primary sortas="b-smtpd.py">smtpd.py</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>