Fix up a few synopses.
-\section{Standard Module \module{aifc}}
+\section{\module{aifc} ---
+ Read and write audio files in AIFF or AIFC format.}
\declaremodule{standard}{aifc}
\modulesynopsis{Read and write audio files in AIFF or AIFC format.}
-\section{Built-in Module \module{al}}
+\section{\module{al} ---
+ Audio functions on the SGI.}
\declaremodule{builtin}{al}
\modulesynopsis{Audio functions on the SGI.}
\end{methoddesc}
-\section{Standard Module \module{AL}}
+\section{\module{AL} ---
+ Constants used with the \module{al} module.}
\declaremodule{standard}{AL}
\modulesynopsis{Constants used with the \module{al} module.}
\chapter{Amoeba Specific Services}
-\section{Built-in Module \module{amoeba}}
+\section{\module{amoeba} ---
+ None}
\declaremodule{builtin}{amoeba}
\modulesynopsis{None}
-\section{Standard Module \module{anydbm}}
+\section{\module{anydbm} ---
+ Generic interface to DBM-style database modules.}
\declaremodule{standard}{anydbm}
\modulesynopsis{Generic interface to DBM-style database modules.}
-\section{Standard Module \module{dumbdbm}}
+\section{\module{dumbdbm} ---
+ Portable implementation of the simple DBM interface.}
\declaremodule{standard}{dumbdbm}
\modulesynopsis{Portable implementation of the simple DBM interface.}
-\section{Built-in Module \module{array}}
+\section{\module{array} ---
+ Efficient arrays of uniformly typed numeric values.}
\declaremodule{builtin}{array}
\modulesynopsis{Efficient arrays of uniformly typed numeric values.}
-\section{Built-in Module \module{audioop}}
+\section{\module{audioop} ---
+ Manipulate raw audio data.}
\declaremodule{builtin}{audioop}
\modulesynopsis{Manipulate raw audio data.}
-\section{Standard Module \module{base64}}
+\section{\module{base64} ---
+ Encode and decode MIME base64 encoding.}
\declaremodule{standard}{base64}
-\modulesynopsis{Encode/decode binary files using the MIME base64 encoding.}
+\modulesynopsis{Encode and decode files using the MIME base64
+encoding.}
\indexii{base64}{encoding}
\index{MIME!base64 encoding}
-\section{Standard Module \module{BaseHTTPServer}}
+\section{\module{BaseHTTPServer} ---
+ Basic HTTP server.}
\declaremodule{standard}{BaseHTTPServer}
\modulesynopsis{Basic HTTP server (base class for
-\section{Standard Module \module{Bastion}}
+\section{\module{Bastion} ---
+ Providing restricted access to objects.}
\declaremodule{standard}{Bastion}
\modulesynopsis{Providing restricted access to objects.}
-\section{Built-in Module \module{binascii}}
+\section{\module{binascii} ---
+ Convert between binary and various ascii-encoded representations.}
\declaremodule{builtin}{binascii}
\modulesynopsis{Tools for converting between binary and various
-\section{Standard Module \module{binhex}}
+\section{\module{binhex} ---
+ Encode and decode files in binhex4 format.}
\declaremodule{standard}{binhex}
\modulesynopsis{Encode and decode files in binhex4 format.}
% example based on the PyModules FAQ entry by Aaron Watters
% <arw@pythonpros.com>.
-\section{Standard Module \module{bisect}}
+\section{\module{bisect} ---
+ Array bisection algorithms for binary searching.}
\declaremodule{standard}{bisect}
\modulesynopsis{Array bisection algorithms for binary searching.}
-\section{Built-in Module \module{__builtin__}}
+\section{\module{__builtin__} ---
+ Built-in functions.}
\declaremodule[builtin]{builtin}{__builtin__}
\modulesynopsis{The set of built-in functions.}
% This section was contributed by Drew Csillag <drew_csillag@geocities.com>.
-\section{Standard Module \module{calendar}}
+\section{\module{calendar} ---
+ Functions that emulate the \UNIX{} \program{cal} program.}
\declaremodule{standard}{calendar}
\modulesynopsis{Functions that emulate the \UNIX{} \program{cal}
-\section{Built-in Module \module{cd}}
+\section{\module{cd} ---
+ Interface to the CD-ROM on Silicon Graphics systems.}
\declaremodule{builtin}{cd}
\modulesynopsis{Interface to the CD-ROM on Silicon Graphics systems.}
-\section{Standard Module \module{cgi}}
+\section{\module{cgi} ---
+ Common Gateway Interface support.}
\declaremodule{standard}{cgi}
-\modulesynopsis{Common Gateway Interface, used to interpret forms in server-side
-scripts.}
+\modulesynopsis{Common Gateway Interface support, used to interpret
+forms in server-side scripts.}
\indexii{WWW}{server}
\indexii{CGI}{protocol}
-\section{Built-in Module \module{cmath}}
+\section{\module{cmath} ---
+ Mathematical functions for complex numbers.}
\declaremodule{builtin}{cmath}
-% Documentation by ESR
-\section{Standard Module \module{cmd}}
+\section{\module{cmd} ---
+ Build line-oriented command interpreters.}
\declaremodule{standard}{cmd}
+\sectionauthor{Eric S. Raymond}{esr@snark.thyrsus.com}
-\modulesynopsis{Build line-oriented command interpreters; this is used by module
-\module{pdb}.}
+\modulesynopsis{Build line-oriented command interpreters; this is used
+by module \module{pdb}.}
The \class{Cmd} class provides a simple framework for writing
-\section{Standard Module \module{code}}
+\section{\module{code} ---
+ Code object services.}
\declaremodule{standard}{code}
\modulesynopsis{Code object services.}
-% Documentation written by Sue Williams.
-
-\section{Standard Module \module{commands}}
+\section{\module{commands} ---
+ Wrapper functions for \function{os.popen()}.}
\declaremodule{standard}{commands}
+\sectionauthor{Sue Williams}{sbw@provis.com}
\modulesynopsis{Wrapper functions for \function{os.popen()}.}
-\section{Standard Module \module{copy}}
+\section{\module{copy} ---
+ Shallow and deep copy operations.}
\declaremodule{standard}{copy}
\modulesynopsis{Shallow and deep copy operations.}
-\section{Standard Module \module{copy_reg}}
+\section{\module{copy_reg} ---
+ Register \module{pickle} support functions.}
\declaremodule[copyreg]{standard}{copy_reg}
\modulesynopsis{Register \module{pickle} support functions.}
-\section{Built-in Module \module{crypt}}
+\section{\module{crypt} ---
+ The \cfunction{crypt()} function used to check \UNIX{} passwords.}
\declaremodule{builtin}{crypt}
\modulesynopsis{The \cfunction{crypt()} function used to check \UNIX{} passwords.}
-\section{Built-in Module \module{dbm}}
+\section{\module{dbm} ---
+ The standard ``database'' interface, based on ndbm.}
\declaremodule{builtin}{dbm}
\modulesynopsis{The standard ``database'' interface, based on ndbm.}
-\section{Standard Module \module{dis}}
+\section{\module{dis} ---
+ Disassembler.}
\declaremodule{standard}{dis}
\modulesynopsis{Disassembler.}
-\section{Standard Module \module{errno}}
+\section{\module{errno} ---
+ Standard errno system symbols.}
\declaremodule{standard}{errno}
\modulesynopsis{Standard errno system symbols.}
% Manual text by Jaap Vermeulen
-\section{Built-in Module \module{fcntl}}
+\section{\module{fcntl} ---
+ The \function{fcntl()} and \function{ioctl()} system calls.}
\declaremodule{builtin}{fcntl}
\modulesynopsis{The \function{fcntl()} and \function{ioctl()} system calls.}
-% Documentation heavily adapted from module docstring.
-
-\section{Standard Module \module{fileinput}}
+\section{\module{fileinput} ---
+ Iteration over lines from multiple input streams.}
\declaremodule{standard}{fileinput}
+\moduleauthor{Guido van Rossum}{guido@python.org}
+\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}
-\modulesynopsis{Perl-like iteration over lines from multiple input streams, with
-``save in place'' capability.}
+\modulesynopsis{Perl-like iteration over lines from multiple input
+streams, with ``save in place'' capability.}
This module implements a helper class and functions to quickly write a
-\section{Built-in Module \module{fl}}
+\section{\module{fl} ---
+ FORMS library interface for GUI applications.}
\declaremodule{builtin}{fl}
\modulesynopsis{FORMS library interface for GUI applications.}
\lineiii{automatic}{int (read-only)}{(see FORMS docs)}
\end{tableiii}
-\section{Standard Module \module{FL}}
+\section{\module{FL} ---
+ Constants used with the \module{fl} module.}
\declaremodule{standard}{FL}
\modulesynopsis{Constants used with the \module{fl} module.}
from FL import *
\end{verbatim}
-\section{Standard Module \module{flp}}
+\section{\module{flp} ---
+ Loading functions for stored FORMS designs.}
\declaremodule{standard}{flp}
\modulesynopsis{Loading functions for stored FORMS designs.}
-\section{Built-in Module \module{fm}}
+\section{\module{fm} ---
+ \emph{Font Manager} interface for SGI workstations.}
\declaremodule{builtin}{fm}
\modulesynopsis{\emph{Font Manager} interface for SGI workstations.}
-\section{Standard Module \module{fnmatch}}
+\section{\module{fnmatch} ---
+ \UNIX{} shell style pathname pattern matching.}
\declaremodule{standard}{fnmatch}
\modulesynopsis{\UNIX{} shell style pathname pattern matching.}
-\section{Standard Module \module{formatter}}
+\section{\module{formatter} ---
+ Generic output formatter and device interface.}
\declaremodule{standard}{formatter}
\modulesynopsis{Generic output formatter and device interface.}
-\section{Standard Module \module{ftplib}}
+\section{\module{ftplib} ---
+ FTP protocol client.}
\declaremodule{standard}{ftplib}
\modulesynopsis{FTP protocol client (requires sockets).}
-\section{Built-in Functions}
-\label{built-in-funcs}
+\section{Built-in Functions \label{built-in-funcs}}
The Python interpreter has a number of functions built into it that
are always available. They are listed here in alphabetical order.
-\section{Built-in Module \module{gdbm}}
+\section{\module{gdbm} ---
+ GNU's reinterpretation of dbm.}
\declaremodule{builtin}{gdbm}
\modulesynopsis{GNU's reinterpretation of dbm.}
-\section{Standard Module \module{getopt}}
+\section{\module{getopt} ---
+ Parser for command line options.}
\declaremodule{standard}{getopt}
\modulesynopsis{Parser for command line options.}
-\section{Built-in Module \module{gl}}
+\section{\module{gl} ---
+ Functions from the Silicon Graphics \emph{Graphics Library}.}
\declaremodule{builtin}{gl}
\modulesynopsis{Functions from the Silicon Graphics \emph{Graphics Library}.}
main()
\end{verbatim}
%
-\section{Standard Module \module{DEVICE}}
+\section{\module{DEVICE} ---
+ Constants used with the \module{gl} module.}
\declaremodule{standard}{DEVICE}
\modulesynopsis{Constants used with the \module{gl} module.}
Read the module source file for details.
-\section{Standard Module \module{GL}}
+\section{\module{GL} ---
+ Constants used with the \module{gl} module.}
\declaremodule{standard}{GL}
\modulesynopsis{Constants used with the \module{gl} module.}
-\section{Standard Module \module{glob}}
+\section{\module{glob} ---
+ \UNIX{} shell style pathname pattern expansion.}
\declaremodule{standard}{glob}
\modulesynopsis{\UNIX{} shell style pathname pattern expansion.}
-\section{Standard Module \module{gopherlib}}
+\section{\module{gopherlib} ---
+ Gopher protocol client.}
\declaremodule{standard}{gopherlib}
\modulesynopsis{Gopher protocol client (requires sockets).}
-\section{Built-in Module \module{grp}}
+\section{\module{grp} ---
+ The group database.}
\declaremodule{builtin}{grp}
-\section{Standard Module \module{gzip}}
+\section{\module{gzip} ---
+ \program{gzip} compression and decompression using files.}
\declaremodule{standard}{gzip}
\modulesynopsis{Interfaces for \program{gzip} compression and
-\section{Standard Module \module{htmllib}}
+\section{\module{htmllib} ---
+ A parser for HTML documents.}
\declaremodule{standard}{htmllib}
\modulesynopsis{A parser for HTML documents.}
-\section{Standard Module \module{httplib}}
+\section{\module{httplib} ---
+ HTTP protocol client.}
\declaremodule{standard}{httplib}
\modulesynopsis{HTTP protocol client (requires sockets).}
-\section{Built-in Module \module{imageop}}
+\section{\module{imageop} ---
+ Manipulate raw image data.}
\declaremodule{builtin}{imageop}
\modulesynopsis{Manipulate raw image data.}
% Based on HTML documentation by Piers Lauder <piers@staff.cs.usyd.edu.au>;
% converted by Fred L. Drake, Jr. <fdrake@acm.org>.
-%
-% The imaplib module was written by Piers Lauder.
-\section{Standard Module \module{imaplib}}
+\section{\module{imaplib} ---
+ IMAP4 protocol client.}
\declaremodule{standard}{imaplib}
+\moduleauthor{Piers Lauder}{piers@staff.cs.usyd.edu.au}
+\sectionauthor{Piers Lauder}{piers@staff.cs.usyd.edu.au}
\modulesynopsis{IMAP4 protocol client (requires sockets).}
-\section{Built-in Module \module{imgfile}}
+\section{\module{imgfile} ---
+ Support for SGI imglib files.}
\declaremodule{builtin}{imgfile}
\modulesynopsis{Support for SGI imglib files.}
-\section{Standard Module \module{imghdr}}
+\section{\module{imghdr} ---
+ Determine the type of image contained in a file or byte stream.}
\declaremodule{standard}{imghdr}
\modulesynopsis{Determine the type of image contained in a file or byte stream.}
-\section{Built-in Module \module{imp}}
+\section{\module{imp} ---
+ Access the implementation of the \keyword{import} statement.}
\declaremodule{builtin}{imp}
\modulesynopsis{Access the implementation of the \keyword{import} statement.}
-\section{Built-in Module \module{jpeg}}
+\section{\module{jpeg} ---
+ Read and write image files in compressed JPEG format.}
\declaremodule{builtin}{jpeg}
\modulesynopsis{Read and write image files in compressed JPEG format.}
-\section{Standard Module \module{keyword}}
+\section{\module{keyword} ---
+ Test whether a string is a Python keyword.}
\declaremodule{standard}{keyword}
-\modulesynopsis{Test whether a string is a keyword in the Python language.}
+\modulesynopsis{Test whether a string is a keyword in Python.}
This module allows a Python program to determine if a string is a
-\section{Standard Module \module{locale}}
+\section{\module{locale} ---
+ Internationalization services.}
\declaremodule{standard}{locale}
-\section{Standard Module \module{mailbox}}
+\section{\module{mailbox} ---
+ Read various mailbox formats.}
\declaremodule{standard}{mailbox}
\modulesynopsis{Read various mailbox formats.}
-\section{Standard Module \module{mailcap}}
+\section{\module{mailcap} ---
+ Mailcap file handling.}
\declaremodule{standard}{mailcap}
\modulesynopsis{Mailcap file handling.}
-\section{Built-in Module \module{__main__}}
+\section{\module{__main__} ---
+ Top-level script environment.}
\declaremodule[main]{builtin}{__main__}
\modulesynopsis{The environment where the top-level script is run.}
-\section{Built-in Module \module{marshal}}
+\section{\module{marshal} ---
+ Python object serialization (with different constraints).}
\declaremodule{builtin}{marshal}
-\modulesynopsis{Convert Python objects to streams of bytes and back (with
-different constraints).}
+\modulesynopsis{Convert Python objects to streams of bytes and back
+(with different constraints).}
This module contains functions that can read and write Python
-\section{Built-in Module \module{math}}
+\section{\module{math} ---
+ Mathematical functions (\function{sin()} etc.).}
\declaremodule{builtin}{math}
-\section{Built-in Module \module{md5}}
+\section{\module{md5} ---
+ MD5 message digest algorithm.}
\declaremodule{builtin}{md5}
\modulesynopsis{RSA's MD5 message digest algorithm.}
-\section{Standard Module \module{mimetools}}
+\section{\module{mimetools} ---
+ Tools for parsing MIME style message bodies.}
\declaremodule{standard}{mimetools}
\modulesynopsis{Tools for parsing MIME style message bodies.}
% <fdrake@acm.org>, based in part on original docstrings in the
% mimetypes module.
-\section{Standard Module \module{mimetypes}}
+\section{\module{mimetypes} ---
+ Mapping of filename extensions to MIME types.}
\declaremodule{standard}{mimetypes}
\modulesynopsis{Mapping of filename extensions to MIME types.}
-\section{Standard Module \module{mimify}}
+\section{\module{mimify} ---
+ Mimification and unmimification of mail messages.}
\declaremodule{standard}{mimify}
\modulesynopsis{Mimification and unmimification of mail messages.}
-\section{Built-in Module \module{mpz}}
+\section{\module{mpz} ---
+ GNU MP library for arbitrary precision arithmetic.}
\declaremodule{builtin}{mpz}
-\modulesynopsis{Interface to the GNU MP library for arbitrary precision arithmetic.}
+\modulesynopsis{Interface to the GNU MP library for arbitrary
+precision arithmetic.}
This is an optional module. It is only available when Python is
-% Documentation by ESR
-\section{Standard Module \module{multifile}}
+\section{\module{multifile} ---
+ Support for reading files which contain distinct parts.}
\declaremodule{standard}{multifile}
+\sectionauthor{Eric S. Raymond}{esr@snark.thyrsus.com}
\modulesynopsis{Support for reading files which contain distinct
parts, such as some MIME data.}
-\section{Standard Module \module{ni}}
+\section{\module{ni} ---
+ None}
\declaremodule{standard}{ni}
\modulesynopsis{None}
-\section{Standard Module \module{nntplib}}
+\section{\module{nntplib} ---
+ NNTP protocol client.}
\declaremodule{standard}{nntplib}
\modulesynopsis{NNTP protocol client (requires sockets).}
-% Contributed by Skip Montanaro, from the module's doc strings.
-
-\section{Built-in Module \module{operator}}
+\section{\module{operator} ---
+ Standard operators as functions.}
\declaremodule{builtin}{operator}
+\sectionauthor{Skip Montanaro}{skip@automatrix.com}
\modulesynopsis{All Python's standard operators as built-in functions.}
\end{funcdesc}
\begin{funcdesc}{truth}{o}
-Return 1 if \var{o} is true, and 0 otherwise.
+Return \code{1} if \var{o} is true, and 0 otherwise.
\end{funcdesc}
\begin{funcdesc}{concat}{a, b}
-\section{Standard Module \module{os}}
+\section{\module{os} ---
+ Miscellaneous OS interfaces.}
\declaremodule{standard}{os}
\modulesynopsis{Miscellaneous OS interfaces.}
-\section{Standard Module \module{panel}}
+\section{\module{panel} ---
+ None}
\declaremodule{standard}{panel}
\modulesynopsis{None}
or
\code{panel.defpanellist()}.
-\section{Standard Module \module{panelparser}}
+\section{\module{panelparser} ---
+ None}
\declaremodule{standard}{panelparser}
\modulesynopsis{None}
For more details, read the module file.
% XXXXJH should be funcdesc, I think
-\section{Built-in Module \module{pnl}}
+\section{\module{pnl} ---
+ None}
\declaremodule{builtin}{pnl}
\modulesynopsis{None}
% in any way.
%
-\section{Built-in Module \module{parser}}
+\section{\module{parser} ---
+ Access parse trees of Python code.}
\declaremodule{builtin}{parser}
+\moduleauthor{Fred L. Drake, Jr.}{fdrake@acm.org}
+\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}
-\modulesynopsis{Retrieve and submit parse trees from and to the runtime support
-environment.}
+\modulesynopsis{Access parse trees of Python source code.}
\index{parsing!Python source code}
-\section{Standard Module \module{pickle}}
+\section{\module{pickle} ---
+ Python object serialization.}
\declaremodule{standard}{pickle}
\modulesynopsis{Convert Python objects to streams of bytes and back.}
\end{seealso}
-\section{Built-in Module \module{cPickle}}
+\section{\module{cPickle} ---
+ Alternate implementation of \module{pickle}.}
\declaremodule{builtin}{cPickle}
\modulesynopsis{Faster version of \module{pickle}, but not subclassable.}
% <drew_csillag@geocities.com>, with some re-organization by Fred L.
% Drake, Jr. <fdrake@acm.org>.
-\section{Standard Module \module{popen2}}
+\section{\module{popen2} ---
+ Subprocesses with accessible standard I/O streams.}
\declaremodule{standard}{popen2}
+\sectionauthor{Drew Csillag}{drew_csillag@geocities.com}
+
\modulesynopsis{Subprocesses with accessible standard I/O streams.}
%it since I just stole most of it from the poplib.py source code and
%the imaplib ``chapter''.
-\section{Standard Module \module{poplib}}
+\section{\module{poplib} ---
+ POP3 protocol client.}
\declaremodule{standard}{poplib}
\modulesynopsis{POP3 protocol client (requires sockets).}
-\section{Built-in Module \module{posix}}
+\section{\module{posix} ---
+ The most common \POSIX{} system calls.}
\declaremodule{builtin}{posix}
\modulesynopsis{The most common \POSIX{} system calls (normally used via module
% Manual text and implementation by Jaap Vermeulen
-\section{Standard Module \module{posixfile}}
+\section{\module{posixfile} ---
+ A file-like object with support for locking.}
\declaremodule{builtin}{posixfile}
\modulesynopsis{A file-like object with support for locking.}
-\section{Standard Module \module{posixpath}}
+\section{\module{posixpath} ---
+ Common \POSIX{} pathname manipulations.}
\declaremodule{standard}{posixpath}
\modulesynopsis{Common \POSIX{} pathname manipulations.}
%% Author: Fred L. Drake, Jr. <fdrake@acm.org>
-\section{Standard Module \module{pprint}}
+\section{\module{pprint} ---
+ Data pretty printer.}
\declaremodule{standard}{pprint}
\modulesynopsis{Data pretty printer.}
-\section{Built-in Module \module{pwd}}
+\section{\module{pwd} ---
+ The password database.}
\declaremodule{builtin}{pwd}
-\section{Standard Module \module{Queue}}
+\section{\module{Queue} ---
+ A synchronized queue class.}
\declaremodule{standard}{Queue}
-\modulesynopsis{A stynchronized queue class.}
+\modulesynopsis{A synchronized queue class.}
-\section{Standard Module \module{quopri}}
+\section{\module{quopri} ---
+ Encode and decode MIME quoted-printable encoding.}
\declaremodule{standard}{quopri}
-\modulesynopsis{Encode/decode binary files using the MIME quoted-printable encoding.}
+\modulesynopsis{Encode and decode files using the MIME
+quoted-printable encoding.}
This module performs quoted-printable transport encoding and decoding,
-\section{Standard Module \module{rand}}
+\section{\module{rand} ---
+ None}
\declaremodule{standard}{rand}
\modulesynopsis{None}
-\section{Standard Module \module{random}}
+\section{\module{random} ---
+ Generate pseudo-random numbers with various distributions.}
\declaremodule{standard}{random}
-\modulesynopsis{Generate pseudo-random numbers with various common distributions.}
+\modulesynopsis{Generate pseudo-random numbers with various common
+distributions.}
This module implements pseudo-random number generators for various
-\section{Standard Module \module{re}}
+\section{\module{re} ---
+ New Perl-style regular expression search and match operations.}
\declaremodule{standard}{re}
\moduleauthor{Andrew M. Kuchling}{akuchling@acm.org}
\sectionauthor{Andrew M. Kuchling}{akuchling@acm.org}
-\section{Built-in Module \module{regex}}
+\section{\module{regex} ---
+ Regular expression search and match operations.}
\declaremodule{builtin}{regex}
\modulesynopsis{Regular expression search and match operations.}
-\section{Standard Module \module{regsub}}
+\section{\module{regsub} ---
+ Substitution and splitting operations that use regular expressions.}
\declaremodule{standard}{regsub}
\modulesynopsis{Substitution and splitting operations that use regular expressions.}
-\section{Built-in Module \module{resource}}
+\section{\module{resource} ---
+ Resource usage information.}
\declaremodule{builtin}{resource}
-\section{Standard Module \module{rexec}}
+\section{\module{rexec} ---
+ Basic restricted execution framework.}
\declaremodule{standard}{rexec}
\modulesynopsis{Basic restricted execution framework.}
-\section{Standard Module \module{rfc822}}
+\section{\module{rfc822} ---
+ Parse RFC 822 mail headers.}
\declaremodule{standard}{rfc822}
\modulesynopsis{Parse \rfc{822} style mail headers.}
-\section{Built-in Module \module{rgbimg}}
+\section{\module{rgbimg} ---
+ Read and write image files in ``SGI RGB'' format.}
\declaremodule{builtin}{rgbimg}
\modulesynopsis{Read and write image files in ``SGI RGB'' format (the module is
-\emph{not} SGI specific though)!}
+\emph{not} SGI specific though!).}
The \module{rgbimg} module allows Python programs to access SGI imglib image
-\section{Built-in Module \module{rotor}}
+\section{\module{rotor} ---
+ Enigma-like encryption and decryption.}
\declaremodule{builtin}{rotor}
\modulesynopsis{Enigma-like encryption and decryption.}
-\section{Built-in Module \module{select}}
+\section{\module{select} ---
+ Wait for I/O completion on multiple streams.}
\declaremodule{builtin}{select}
\modulesynopsis{Wait for I/O completion on multiple streams.}
-\section{Standard Module \module{sgmllib}}
+\section{\module{sgmllib} ---
+ Simple SGML parser.}
\declaremodule{standard}{sgmllib}
\modulesynopsis{Only as much of an SGML parser as needed to parse HTML.}
-\section{Standard Module \module{shelve}}
+\section{\module{shelve} ---
+ Python object persistency.}
\declaremodule{standard}{shelve}
\modulesynopsis{Python object persistency.}
-\section{Built-in Module \module{signal}}
+\section{\module{signal} ---
+ Set handlers for asynchronous events.}
\declaremodule{builtin}{signal}
-\section{Standard Module \module{site}}
+\section{\module{site} ---
+ A standard way to reference site-specific modules.}
\declaremodule{standard}{site}
\modulesynopsis{A standard way to reference site-specific modules.}
-% Documentation by ESR
-\section{Standard Module \module{smtplib}}
+\section{\module{smtplib} ---
+ SMTP protocol client.}
\declaremodule{standard}{smtplib}
+\sectionauthor{Eric S. Raymond}{esr@snark.thyrsus.com}
\modulesynopsis{SMTP protocol client (requires sockets).}
-\section{Built-in Module \module{socket}}
+\section{\module{socket} ---
+ Low-level networking interface.}
\declaremodule{builtin}{socket}
\modulesynopsis{Low-level networking interface.}
-\section{Standard Module \module{SocketServer}}
+\section{\module{SocketServer} ---
+ A framework for network servers.}
\declaremodule{standard}{SocketServer}
\modulesynopsis{A framework for network servers.}
-\section{Built-in Module \module{soundex}}
+\section{\module{soundex} ---
+ None}
\declaremodule{builtin}{soundex}
\modulesynopsis{None}
-% By Skip Montanaro
-
-\section{Standard Module \module{stat}}
+\section{\module{stat} ---
+ Utilities for interpreting \function{stat()} results.}
\declaremodule{standard}{stat}
+\sectionauthor{Skip Montanaro}{skip@automatrix.com}
+
\modulesynopsis{Utilities for interpreting the results of
\function{os.stat()}, \function{os.lstat()} and \function{os.fstat()}.}
-The \code{stat} module defines constants and functions for interpreting the
-results of \code{os.stat()} and \code{os.lstat()} (if they exist).
-For complete details about the \code{stat()} and \code{lstat()} system
-calls, consult your local man pages.
+The \module{stat} module defines constants and functions for
+interpreting the results of \function{os.stat()} and
+\function{os.lstat()} (if they exist). For complete details about the
+\cfunction{stat()} and \cfunction{lstat()} system calls, consult your
+local man pages.
-The \code{stat} module defines the following functions:
+The \module{stat} module defines the following functions:
\begin{funcdesc}{S_ISDIR}{mode}
under X11, Win32 for Windows and Windows NT, and a collection of
native toolkit interfaces for the Macintosh.
-\section{Built-in Module \module{stdwin}}
+\section{\module{stdwin} ---
+ None}
\declaremodule{builtin}{stdwin}
\modulesynopsis{None}
main()
\end{verbatim}
%
-\section{Standard Module \module{stdwinevents}}
+\section{\module{stdwinevents} ---
+ None}
\declaremodule{standard}{stdwinevents}
\modulesynopsis{None}
>>>
\end{verbatim}
%
-\section{Standard Module \module{rect}}
+\section{\module{rect} ---
+ None}
\declaremodule{standard}{rect}
\modulesynopsis{None}
-\section{Standard Module \module{string}}
+\section{\module{string} ---
+ Common string operations.}
\declaremodule{standard}{string}
\modulesynopsis{Common string operations.}
-\section{Standard Module \module{StringIO}}
+\section{\module{StringIO} ---
+ Read and write strings as if they were files.}
\declaremodule{standard}{StringIO}
\end{methoddesc}
-\section{Built-in Module \module{cStringIO}}
+\section{\module{cStringIO} ---
+ Faster version of \module{StringIO}, but not subclassable.}
\declaremodule{builtin}{cStringIO}
\modulesynopsis{Faster version of \module{StringIO}, but not subclassable.}
-\section{Built-in Module \module{struct}}
+\section{\module{struct} ---
+ Interpret strings as packed binary data.}
\declaremodule{builtin}{struct}
\modulesynopsis{Interpret strings as packed binary data.}
-\section{Built-in Module \module{sunaudiodev}}
+\section{\module{sunaudiodev} ---
+ Access to Sun audio hardware.}
\declaremodule{builtin}{sunaudiodev}
-\modulesynopsis{None}
+\modulesynopsis{Access to Sun audio hardware.}
-This module allows you to access the sun audio interface. The sun
+This module allows you to access the Sun audio interface. The Sun
audio hardware is capable of recording and playing back audio data
in u-LAW\index{u-LAW} format with a sample rate of 8K per second. A
full description can be found in the \manpage{audio}{7I} manual page.
-\section{Standard Module \module{symbol}}
+\section{\module{symbol} ---
+ Constants representing internal nodes of the parse tree.}
\declaremodule{standard}{symbol}
\modulesynopsis{Constants representing internal nodes of the parse tree.}
-\section{Built-in Module \module{sys}}
+\section{\module{sys} ---
+ System-specific parameters and functions.}
\declaremodule{builtin}{sys}
-\modulesynopsis{Access system specific parameters and functions.}
+\modulesynopsis{Access system-specific parameters and functions.}
This module provides access to some variables used or maintained by the
interpreter and to functions that interact strongly with the interpreter.
-\section{Built-in Module \module{syslog}}
+\section{\module{syslog} ---
+ \UNIX{} syslog library routines.}
\declaremodule{builtin}{syslog}
\modulesynopsis{An interface to the \UNIX{} syslog library routines.}
-\section{Standard Module \module{tempfile}}
+\section{\module{tempfile} ---
+ Generate temporary file names.}
\declaremodule{standard}{tempfile}
\modulesynopsis{Generate temporary file names.}
% ==== 1. ====
-% Choose one of the following section headers and index entries;
-% \section generates the section header, \declmodule produces the
-% appropriate index entry for this module. Note that these should
-% only be used for the defining entry for the module. Other
-% references to the module should use \refbimodindex, \refstmodindex,
-% \refexmodindex or \refmodindex, as appropriate.
+% The section prologue. Give the section a title and provide some
+% meta-information. References to the module should use
+% \refbimodindex, \refstmodindex, \refexmodindex or \refmodindex, as
+% appropriate.
-\section{Built-in Module \module{spam}} % If implemented in C, in
-\declaremodule{builtin}{spam} % standard library
+\section{\module{spam} ---
+ Short one-line descrition, for section title.}
-\section{Standard Module \module{spam}} % If implemented in Python, in
-\declaremodule{standard}{spam} % standard library
+% Choose one of these to specify the module module name. If there's
+% an underscore in the name, use
+% \declaremodule[modname]{...}{mod_name} instead.
+%
+\declaremodule{builtin}{spam} % standard library, in C
+\declaremodule{standard}{spam} % standard library, in Python
+\declaremodule{extension}{spam} % not standard, in C
+\declaremodule{}{spam} % not standard, in Python
-\section{Extension Module \module{spam}}% If implemented in C, but not
-\declaremodule{extension}{spam} % in standard library
+% These apply to all modules:
-\section{Module \module{spam}} % If implemented in Python, but not
-\declaremodule{}{spam} % in standard library
+\moduleauthor{name}{email} % Author of the module code;
+ % omit if not known.
+\sectionauthor{name}{email} % Author of the documentation.
+% Leave at least one blank line after this, to simplify ad-hoc tools
+% that are sometimes used to massage these files.
\modulesynopsis{This is a one-line descrition, for the chapter header.}
-\section{Built-in Module \module{termios}}
+\section{\module{termios} ---
+ \POSIX{} style tty control.}
\declaremodule{builtin}{termios}
\modulesynopsis{\POSIX{} style tty control.}
return passwd
\end{verbatim}
-\section{Standard Module \module{TERMIOS}}
+\section{\module{TERMIOS} ---
+ Constants used with the \module{termios} module.}
\declaremodule[TERMIOSuppercase]{standard}{TERMIOS}
-\modulesynopsis{The symbolic constants required to use the \module{termios} module.}
+\modulesynopsis{Symbolic constants required to use the
+\module{termios} module.}
\indexii{\POSIX{}}{I/O control}
\indexii{tty}{I/O control}
-\section{Built-in Module \module{thread}}
+\section{\module{thread} ---
+ Multiple threads of control.}
\declaremodule{builtin}{thread}
-\modulesynopsis{Create multiple threads of control within one namespace.}
+\modulesynopsis{Create multiple threads of control within one interpreter.}
This module provides low-level primitives for working with multiple
-\section{Standard Module \module{threading}}
+\section{\module{threading} ---
+ Higher-level threading interfaces.}
\declaremodule{standard}{threading}
\modulesynopsis{Higher-level threading interfaces.}
-\section{Built-in Module \module{time}}
+\section{\module{time} ---
+ Time access and conversions.}
\declaremodule{builtin}{time}
\modulesynopsis{Time access and conversions.}
-\section{Standard Module \module{token}}
+\section{\module{token} ---
+ Constants representing terminal nodes of the parse tree.}
\declaremodule{standard}{token}
\modulesynopsis{Constants representing terminal nodes of the parse tree.}
-\section{Standard Module \module{traceback}}
+\section{\module{traceback} ---
+ Print or retrieve a stack traceback.}
\declaremodule{standard}{traceback}
\modulesynopsis{Print or retrieve a stack traceback.}
-\section{Standard Module \module{types}}
+\section{\module{types} ---
+ Names for all built-in types.}
\declaremodule{standard}{types}
\modulesynopsis{Names for all built-in types.}
-\section{Standard Module \module{urllib}}
+\section{\module{urllib} ---
+ Open an arbitrary object given by URL.}
\declaremodule{standard}{urllib}
\modulesynopsis{Open an arbitrary object given by URL (requires sockets).}
-\section{Standard Module \module{urlparse}}
+\section{\module{urlparse} ---
+ Parse URLs into components.}
\declaremodule{standard}{urlparse}
\modulesynopsis{Parse URLs into components.}
-\section{Standard Module \module{user}}
+\section{\module{user} ---
+ A standard way to reference user-specific modules.}
\declaremodule{standard}{user}
\modulesynopsis{A standard way to reference user-specific modules.}
-\section{Standard Module \module{UserDict}}
+\section{\module{UserDict} ---
+ Class wrapper for dictionary objects.}
\declaremodule{standard}{UserDict}
\modulesynopsis{Class wrapper for dictionary objects.}
\end{memberdesc}
-\section{Standard Module \module{UserList}}
+\section{\module{UserList} ---
+ Class wrapper for list objects.}
\declaremodule{standard}{UserList}
\modulesynopsis{Class wrapper for list objects.}
-\section{Standard Module \module{uu}}
+\section{\module{uu} ---
+ Encode and decode files in uuencode format.}
\declaremodule{standard}{uu}
\modulesynopsis{Encode and decode files in uuencode format.}
-\section{Standard Module \module{whichdb}}
+\section{\module{whichdb} ---
+ Guess which DBM-style module created a given database.}
\declaremodule{standard}{whichdb}
\modulesynopsis{Guess which DBM-style module created a given database.}
-\section{Standard Module \module{whrandom}}
+\section{\module{whrandom} ---
+ Floating point pseudo-random number generator.}
\declaremodule{standard}{whrandom}
\modulesynopsis{Floating point pseudo-random number generator.}
-\section{Standard Module \module{xdrlib}}
+\section{\module{xdrlib} ---
+ Encode and decode XDR data.}
\declaremodule{standard}{xdrlib}
\modulesynopsis{Encoders and decoders for the External Data
-Representation.}
+Representation (XDR).}
\index{XDR}
\index{External Data Representation}
-\section{Standard Module \module{xmllib}}
+\section{\module{xmllib} ---
+ A parser for XML documents.}
% Author: Sjoerd Mullender
\declaremodule{standard}{xmllib}
% XXX The module has been extended (by Jeremy) but this documentation
% hasn't been updated completely.
-\section{Built-in Module \module{zlib}}
+\section{\module{zlib} ---
+ Compression and decompression compatible with \program{gzip}.}
\declaremodule{builtin}{zlib}
\modulesynopsis{Low-level interface to compression and decompression
% ==== 1. ====
-% Choose one of the following section headers and index entries;
-% \section generates the section header, \declmodule produces the
-% appropriate index entry for this module. Note that these should
-% only be used for the defining entry for the module. Other
-% references to the module should use \refbimodindex, \refstmodindex,
-% \refexmodindex or \refmodindex, as appropriate.
+% The section prologue. Give the section a title and provide some
+% meta-information. References to the module should use
+% \refbimodindex, \refstmodindex, \refexmodindex or \refmodindex, as
+% appropriate.
-\section{Built-in Module \module{spam}} % If implemented in C, in
-\declaremodule{builtin}{spam} % standard library
+\section{\module{spam} ---
+ Short one-line descrition, for section title.}
-\section{Standard Module \module{spam}} % If implemented in Python, in
-\declaremodule{standard}{spam} % standard library
+% Choose one of these to specify the module module name. If there's
+% an underscore in the name, use
+% \declaremodule[modname]{...}{mod_name} instead.
+%
+\declaremodule{builtin}{spam} % standard library, in C
+\declaremodule{standard}{spam} % standard library, in Python
+\declaremodule{extension}{spam} % not standard, in C
+\declaremodule{}{spam} % not standard, in Python
-\section{Extension Module \module{spam}}% If implemented in C, but not
-\declaremodule{extension}{spam} % in standard library
+% These apply to all modules:
-\section{Module \module{spam}} % If implemented in Python, but not
-\declaremodule{}{spam} % in standard library
+\moduleauthor{name}{email} % Author of the module code;
+ % omit if not known.
+\sectionauthor{name}{email} % Author of the documentation.
+% Leave at least one blank line after this, to simplify ad-hoc tools
+% that are sometimes used to massage these files.
\modulesynopsis{This is a one-line descrition, for the chapter header.}
projects / python / commitdiff