source: general/prog/python2.xml@ 32696a4

<?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 python2-download-http
          "http://www.python.org/ftp/python/&python2-version;/Python-&python2-version;.tar.xz">
  <!ENTITY python2-download-ftp  " ">
  <!ENTITY python2-md5sum        "62c4c1699170078c469f79ddfed21bc0">
  <!ENTITY python2-size          "9.6 MB">
  <!ENTITY python2-buildsize     "235 MB (not including the test suite)">
  <!ENTITY python2-time          "1.1 SBU (not including the test suite)">

  <!ENTITY python2htmldoc-download-http
           "http://docs.python.org/ftp/python/doc/&python2-version;/python-&python2-version;-docs-html.tar.bz2">
  <!ENTITY python2htmldoc-md5sum        "101c13d39f76fd6706aac3a9196b2f01">
  <!ENTITY python2htmldoc-size          "4.2 MB">
]>

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

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

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

  <indexterm zone="python2">
    <primary sortas="a-Python2">Python2</primary>
  </indexterm>

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

    <para>
      The <application>Python 2</application> package contains the
      <application>Python</application> development environment. It is useful
      for object-oriented programming, writing scripts, prototyping large
      programs or developing entire applications. This version is for backward
      compatibility with other dependent packages.
    </para>

    &lfs72_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>

    <itemizedlist spacing="compact">
      <title>Optional HTML Documentation</title>
      <listitem>
        <para>
          Download (HTTP): <ulink url="&python2htmldoc-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &python2htmldoc-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &python2htmldoc-size;
        </para>
      </listitem>
    </itemizedlist>

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="expat"/>,
      <xref linkend="libffi"/> and
      <xref linkend="pkgconfig"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="bluez"/> and
      <ulink url="http://sphinx.pocoo.org/">Sphinx</ulink>
    </para>

    <bridgehead renderas="sect4">Optional (For Additional Modules)</bridgehead>
    <para role="optional">
      <xref linkend="db"/>,
      <xref linkend="openssl"/>,
      <xref linkend="sqlite"/> and
      <xref linkend="tk"/>
    </para>

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

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

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

<screen><userinput>sed -i "s/ndbm_libs = \[\]/ndbm_libs = ['gdbm', 'gdbm_compat']/" setup.py &amp;&amp;
patch -Np1 -i ../Python-&python2-version;-bsddb_fix-1.patch &amp;&amp;
./configure --prefix=/usr       \
            --enable-shared     \
            --with-system-expat \
            --with-system-ffi   \
            --enable-unicode=ucs4 &amp;&amp;
make</userinput></screen>

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

    <para>
      In order to use the <command>help ('name_string')</command> feature of the
      <command>python</command> interpreter with some statements and keywords,
      you must create or download the optional HTML documentation.
    </para>

    <para>
      If you have installed <ulink url="http://sphinx.pocoo.org/">Sphinx</ulink>
      and wish to create the HTML documentation:
    </para>

<screen><userinput>make -C Doc html</userinput></screen>

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

<screen role="root"><userinput>make install &amp;&amp;
chmod -v 755 /usr/lib/libpython&python2-majorver;.so.1.0</userinput></screen>

    <para>
      If you created the html documentation with
      <application>Sphinx</application> then install it as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/Python-&python2-version; &amp;&amp;
cp -rfv Doc/build/html/* /usr/share/doc/python-&python2-version;</userinput></screen>

    <para>
      Alternatively, you can download preformatted documentation from
      <ulink url="http://docs.python.org/download.html"/> and install it as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/Python-&python2-version; &amp;&amp;
tar --strip-components=1 -C /usr/share/doc/Python-&python2-version; \
    -xvf ../python-&python2-version;-docs-html.tar.bz2                      &amp;&amp;
find /usr/share/doc/Python-&python2-version; -type d -exec chmod 0755 {} \; &amp;&amp;
find /usr/share/doc/Python-&python2-version; -type f -exec chmod 0644 {} \;</userinput></screen>
  </sect2>

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

    <para>
      <command>sed -i "s/ndbm_libs = ..." setup.py</command>: This command is
      used to fix a build problem with the <application>GDBM</application>
      library.
    </para>

    <para>
      <option>--with-system-expat</option>: This switch enables linking against
      system version of <application>Expat</application>. Remove if you have
      not installed recommended dependency <xref linkend="expat"/>.
    </para>

    <para>
      <option>--with-system-ffi</option>: This switch enables linking against
      system version of <application>libffi</application>. Remove if you have
      not installed recommended dependency <xref linkend="libffi"/>.
    </para>

    <para>
      <parameter>--enable-unicode=ucs4</parameter>: This switch enables
      32bit Unicode support in <application>Python</application>.
    </para>

    <para>
      <parameter>--with-dbmliborder=bdb:gdbm:ndbm</parameter>: Use this switch
      if you want to build <application>Python</application> DBM Module
      against <application>Berkeley DB</application> instead of
      <application>GDBM</application>.
    </para>

    <para>
      <command>chmod ...</command>: Fix permissions for libraries to be
      consistent with other libraries.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Python 2</title>

    <para>
      In order for <command>python</command> to find the installed
      documentation, you must add the following environment variable to
      individual user's or the system's profile:
    </para>

<screen role="root"><userinput>export PYTHONDOCS=/usr/share/doc/Python-&python2-version;</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          2to3, pydoc, python, python-config, python&python2-majorver;,
          python&python2-majorver;-config, smtpd.py, and optionally if
          <application>Tk</application> is installed, idle
        </seg>
        <seg>
          libpython&python2-majorver;.so and numerous modules installed in
          /usr/lib/python&python2-majorver;/lib-dynload
        </seg>
        <seg>
          /usr/include/python&python2-majorver;,
          /usr/lib/python&python2-majorver;, and
          /usr/share/doc/python-&python2-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="python2-2to3">
        <term><command>2to3</command></term>
        <listitem>
          <para>
            is a <application>Python</application> program that reads
            <application>Python 2.x</application> source code and applies a series of
            fixers to transform it into valid <application>Python 3.x</application>
            code.
          </para>
          <indexterm zone="python2 python2-2to3">
            <primary sortas="b-2to3">2to3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

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

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

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

    </variablelist>

  </sect2>

</sect1>