glfs/general/prog/python2.xml
Andrew Benton 4c77a94985 a bunch of lfs71_checked
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@9604 af4574ff-66df-0310-9fd7-8a98e5e911e0
2012-03-05 15:41:10 +00:00

312 lines
10 KiB
XML

<?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-download-ftp "&gentoo-ftp-repo;/Python-&python2-version;.tar.xz"> -->
<!ENTITY python2-md5sum "75c87a80c6ddb0b785a57ea3583e04fa">
<!ENTITY python2-size "9.5 MB">
<!ENTITY python2-buildsize "235 MB (not including the test suite)">
<!ENTITY python2-time "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 "40f0bd51b221662cae14fb0c6b6f622b">
<!ENTITY python2htmldoc-size "4.1 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">Python</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. This 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>
&lfs71_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">Python Dependencies</bridgehead>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<!-- <xref linkend="pth"/> can only be used if you've overwritten glibc's
libpthread. -->
<xref linkend="libffi"/> and <xref linkend="pkgconfig"/>
(<command>configure</command> uses <command>pkgconfig</command> to find
<application>libffi</application>. There is a circular dependency here:
<application>Pkgconfig</application> requires
<application>Glib</application> which requires
<application>Python 2</application>),
<!-- gcc's libffi does not install a pkgconfig file -->
<ulink url="http://sphinx.pocoo.org/">Sphinx</ulink> (to create the docs),
<ulink url="http://www.bluez.org/">BlueZ</ulink>,
<xref linkend="openssl"/>,
<xref linkend="tk"/> (there is a circular dependency with the
<application>Tk</application> package as it requires Xorg to be installed
but parts of Xorg depend on <application>Python</application>),
<xref linkend="db"/> and
<xref linkend="sqlite"/>.
</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>./configure --prefix=/usr --enable-shared &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</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<option>--with-system-ffi</option>: If you have installed
<application>Libffi</application> and
<application>Pkgconfig</application>, add this option to compile
<application>Python</application>'s _ctypes module using the system
installed <application>Libffi</application>. Otherwise
<application>Python</application> will compile its own copy of
<application>Libffi</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>
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="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>