diff options
Diffstat (limited to 'Doc')
126 files changed, 364 insertions, 209 deletions
diff --git a/Doc/lib/libaifc.tex b/Doc/lib/libaifc.tex index d7433e7..76ff871 100644 --- a/Doc/lib/libaifc.tex +++ b/Doc/lib/libaifc.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libal.tex b/Doc/lib/libal.tex index 8b9a8f8..e1b1e6f 100644 --- a/Doc/lib/libal.tex +++ b/Doc/lib/libal.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{al}} +\section{\module{al} --- + Audio functions on the SGI.} \declaremodule{builtin}{al} \modulesynopsis{Audio functions on the SGI.} @@ -161,7 +162,8 @@ Get status information on last error. \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.} diff --git a/Doc/lib/libamoeba.tex b/Doc/lib/libamoeba.tex index e59b487..3bc7b89 100644 --- a/Doc/lib/libamoeba.tex +++ b/Doc/lib/libamoeba.tex @@ -1,6 +1,7 @@ \chapter{Amoeba Specific Services} -\section{Built-in Module \module{amoeba}} +\section{\module{amoeba} --- + None} \declaremodule{builtin}{amoeba} \modulesynopsis{None} diff --git a/Doc/lib/libanydbm.tex b/Doc/lib/libanydbm.tex index 2344c5a..11f5783 100644 --- a/Doc/lib/libanydbm.tex +++ b/Doc/lib/libanydbm.tex @@ -1,4 +1,5 @@ -\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.} @@ -46,7 +47,8 @@ strings. -\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.} diff --git a/Doc/lib/libarray.tex b/Doc/lib/libarray.tex index 4c8b5f2..b36ee26 100644 --- a/Doc/lib/libarray.tex +++ b/Doc/lib/libarray.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libaudioop.tex b/Doc/lib/libaudioop.tex index 5081a60..2a3e9b0 100644 --- a/Doc/lib/libaudioop.tex +++ b/Doc/lib/libaudioop.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{audioop}} +\section{\module{audioop} --- + Manipulate raw audio data.} \declaremodule{builtin}{audioop} \modulesynopsis{Manipulate raw audio data.} diff --git a/Doc/lib/libbase64.tex b/Doc/lib/libbase64.tex index 2d34e1d..aa68c04 100644 --- a/Doc/lib/libbase64.tex +++ b/Doc/lib/libbase64.tex @@ -1,7 +1,9 @@ -\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} diff --git a/Doc/lib/libbasehttp.tex b/Doc/lib/libbasehttp.tex index e680305..0a8a0fc 100644 --- a/Doc/lib/libbasehttp.tex +++ b/Doc/lib/libbasehttp.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{BaseHTTPServer}} +\section{\module{BaseHTTPServer} --- + Basic HTTP server.} \declaremodule{standard}{BaseHTTPServer} \modulesynopsis{Basic HTTP server (base class for diff --git a/Doc/lib/libbastion.tex b/Doc/lib/libbastion.tex index 08b435d..15bb029 100644 --- a/Doc/lib/libbastion.tex +++ b/Doc/lib/libbastion.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{Bastion}} +\section{\module{Bastion} --- + Providing restricted access to objects.} \declaremodule{standard}{Bastion} \modulesynopsis{Providing restricted access to objects.} diff --git a/Doc/lib/libbinascii.tex b/Doc/lib/libbinascii.tex index aedb696..239565a 100644 --- a/Doc/lib/libbinascii.tex +++ b/Doc/lib/libbinascii.tex @@ -1,4 +1,5 @@ -\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 diff --git a/Doc/lib/libbinhex.tex b/Doc/lib/libbinhex.tex index 782a272..1829b40 100644 --- a/Doc/lib/libbinhex.tex +++ b/Doc/lib/libbinhex.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libbisect.tex b/Doc/lib/libbisect.tex index dd40bc4..246d6c7 100644 --- a/Doc/lib/libbisect.tex +++ b/Doc/lib/libbisect.tex @@ -2,7 +2,8 @@ % 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.} diff --git a/Doc/lib/libbltin.tex b/Doc/lib/libbltin.tex index 3c5dad4..7e10985 100644 --- a/Doc/lib/libbltin.tex +++ b/Doc/lib/libbltin.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{__builtin__}} +\section{\module{__builtin__} --- + Built-in functions.} \declaremodule[builtin]{builtin}{__builtin__} \modulesynopsis{The set of built-in functions.} diff --git a/Doc/lib/libcalendar.tex b/Doc/lib/libcalendar.tex index 553f8fa..0c7207b 100644 --- a/Doc/lib/libcalendar.tex +++ b/Doc/lib/libcalendar.tex @@ -1,6 +1,7 @@ % 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} diff --git a/Doc/lib/libcd.tex b/Doc/lib/libcd.tex index 7c114d8..656d156 100644 --- a/Doc/lib/libcd.tex +++ b/Doc/lib/libcd.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libcgi.tex b/Doc/lib/libcgi.tex index de8d86d..b24d490 100644 --- a/Doc/lib/libcgi.tex +++ b/Doc/lib/libcgi.tex @@ -1,8 +1,9 @@ -\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} diff --git a/Doc/lib/libcmath.tex b/Doc/lib/libcmath.tex index 5337967..d5328e3 100644 --- a/Doc/lib/libcmath.tex +++ b/Doc/lib/libcmath.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{cmath}} +\section{\module{cmath} --- + Mathematical functions for complex numbers.} \declaremodule{builtin}{cmath} diff --git a/Doc/lib/libcmd.tex b/Doc/lib/libcmd.tex index d5d6cf8..153d7a3 100644 --- a/Doc/lib/libcmd.tex +++ b/Doc/lib/libcmd.tex @@ -1,9 +1,10 @@ -% 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 diff --git a/Doc/lib/libcode.tex b/Doc/lib/libcode.tex index 12728c7..ab80fc1 100644 --- a/Doc/lib/libcode.tex +++ b/Doc/lib/libcode.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{code}} +\section{\module{code} --- + Code object services.} \declaremodule{standard}{code} \modulesynopsis{Code object services.} diff --git a/Doc/lib/libcommands.tex b/Doc/lib/libcommands.tex index bea1401..6b49fae 100644 --- a/Doc/lib/libcommands.tex +++ b/Doc/lib/libcommands.tex @@ -1,7 +1,7 @@ -% 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()}.} diff --git a/Doc/lib/libcopy.tex b/Doc/lib/libcopy.tex index c019476..14e667e 100644 --- a/Doc/lib/libcopy.tex +++ b/Doc/lib/libcopy.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{copy}} +\section{\module{copy} --- + Shallow and deep copy operations.} \declaremodule{standard}{copy} \modulesynopsis{Shallow and deep copy operations.} diff --git a/Doc/lib/libcopyreg.tex b/Doc/lib/libcopyreg.tex index 0874b4e..e6e6e44 100644 --- a/Doc/lib/libcopyreg.tex +++ b/Doc/lib/libcopyreg.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libcrypt.tex b/Doc/lib/libcrypt.tex index 418b9d5..1702324 100644 --- a/Doc/lib/libcrypt.tex +++ b/Doc/lib/libcrypt.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libdbm.tex b/Doc/lib/libdbm.tex index b7ee647..2efa6e0 100644 --- a/Doc/lib/libdbm.tex +++ b/Doc/lib/libdbm.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libdis.tex b/Doc/lib/libdis.tex index 9c7fee6..116225c 100644 --- a/Doc/lib/libdis.tex +++ b/Doc/lib/libdis.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{dis}} +\section{\module{dis} --- + Disassembler.} \declaremodule{standard}{dis} \modulesynopsis{Disassembler.} diff --git a/Doc/lib/liberrno.tex b/Doc/lib/liberrno.tex index c21f0fd..7e0c1a9 100644 --- a/Doc/lib/liberrno.tex +++ b/Doc/lib/liberrno.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{errno}} +\section{\module{errno} --- + Standard errno system symbols.} \declaremodule{standard}{errno} \modulesynopsis{Standard errno system symbols.} diff --git a/Doc/lib/libfcntl.tex b/Doc/lib/libfcntl.tex index e693067..c64cc83 100644 --- a/Doc/lib/libfcntl.tex +++ b/Doc/lib/libfcntl.tex @@ -1,5 +1,6 @@ % 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.} diff --git a/Doc/lib/libfileinput.tex b/Doc/lib/libfileinput.tex index 1613cfa..5f9fc10 100644 --- a/Doc/lib/libfileinput.tex +++ b/Doc/lib/libfileinput.tex @@ -1,10 +1,11 @@ -% 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 diff --git a/Doc/lib/libfl.tex b/Doc/lib/libfl.tex index 601b2c8..3ff90a4 100644 --- a/Doc/lib/libfl.tex +++ b/Doc/lib/libfl.tex @@ -1,4 +1,5 @@ -\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.} @@ -464,7 +465,8 @@ FORMS objects have these data attributes; see the FORMS documentation: \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.} @@ -481,7 +483,8 @@ import fl 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.} diff --git a/Doc/lib/libfm.tex b/Doc/lib/libfm.tex index b52fd26..381d93e 100644 --- a/Doc/lib/libfm.tex +++ b/Doc/lib/libfm.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libfnmatch.tex b/Doc/lib/libfnmatch.tex index b1f3a1b..78d0318 100644 --- a/Doc/lib/libfnmatch.tex +++ b/Doc/lib/libfnmatch.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{fnmatch}} +\section{\module{fnmatch} --- + \UNIX{} shell style pathname pattern matching.} \declaremodule{standard}{fnmatch} \modulesynopsis{\UNIX{} shell style pathname pattern matching.} diff --git a/Doc/lib/libformatter.tex b/Doc/lib/libformatter.tex index c1cf14f..9bb12b2 100644 --- a/Doc/lib/libformatter.tex +++ b/Doc/lib/libformatter.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{formatter}} +\section{\module{formatter} --- + Generic output formatter and device interface.} \declaremodule{standard}{formatter} \modulesynopsis{Generic output formatter and device interface.} diff --git a/Doc/lib/libftplib.tex b/Doc/lib/libftplib.tex index 166fd6e..5840e83 100644 --- a/Doc/lib/libftplib.tex +++ b/Doc/lib/libftplib.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{ftplib}} +\section{\module{ftplib} --- + FTP protocol client.} \declaremodule{standard}{ftplib} \modulesynopsis{FTP protocol client (requires sockets).} diff --git a/Doc/lib/libfuncs.tex b/Doc/lib/libfuncs.tex index bc121c1..7f00121 100644 --- a/Doc/lib/libfuncs.tex +++ b/Doc/lib/libfuncs.tex @@ -1,5 +1,4 @@ -\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. diff --git a/Doc/lib/libgdbm.tex b/Doc/lib/libgdbm.tex index 844c3b3..adb1304 100644 --- a/Doc/lib/libgdbm.tex +++ b/Doc/lib/libgdbm.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{gdbm}} +\section{\module{gdbm} --- + GNU's reinterpretation of dbm.} \declaremodule{builtin}{gdbm} \modulesynopsis{GNU's reinterpretation of dbm.} diff --git a/Doc/lib/libgetopt.tex b/Doc/lib/libgetopt.tex index 6f839a7..72824a7 100644 --- a/Doc/lib/libgetopt.tex +++ b/Doc/lib/libgetopt.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{getopt}} +\section{\module{getopt} --- + Parser for command line options.} \declaremodule{standard}{getopt} \modulesynopsis{Parser for command line options.} diff --git a/Doc/lib/libgl.tex b/Doc/lib/libgl.tex index 6824418..6940437 100644 --- a/Doc/lib/libgl.tex +++ b/Doc/lib/libgl.tex @@ -1,4 +1,5 @@ -\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}.} @@ -185,7 +186,8 @@ def main(): 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.} @@ -196,7 +198,8 @@ This modules defines the constants used by the Silicon Graphics 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.} diff --git a/Doc/lib/libglob.tex b/Doc/lib/libglob.tex index 8c93e43..5ef06f3 100644 --- a/Doc/lib/libglob.tex +++ b/Doc/lib/libglob.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{glob}} +\section{\module{glob} --- + \UNIX{} shell style pathname pattern expansion.} \declaremodule{standard}{glob} \modulesynopsis{\UNIX{} shell style pathname pattern expansion.} diff --git a/Doc/lib/libgopherlib.tex b/Doc/lib/libgopherlib.tex index a6e6fc3..e2cbaa2 100644 --- a/Doc/lib/libgopherlib.tex +++ b/Doc/lib/libgopherlib.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{gopherlib}} +\section{\module{gopherlib} --- + Gopher protocol client.} \declaremodule{standard}{gopherlib} \modulesynopsis{Gopher protocol client (requires sockets).} diff --git a/Doc/lib/libgrp.tex b/Doc/lib/libgrp.tex index 986c831..b15128d 100644 --- a/Doc/lib/libgrp.tex +++ b/Doc/lib/libgrp.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{grp}} +\section{\module{grp} --- + The group database.} \declaremodule{builtin}{grp} diff --git a/Doc/lib/libgzip.tex b/Doc/lib/libgzip.tex index 4bc7d80..3bae734 100644 --- a/Doc/lib/libgzip.tex +++ b/Doc/lib/libgzip.tex @@ -1,4 +1,5 @@ -\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 diff --git a/Doc/lib/libhtmllib.tex b/Doc/lib/libhtmllib.tex index 899e76e..100be55 100644 --- a/Doc/lib/libhtmllib.tex +++ b/Doc/lib/libhtmllib.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{htmllib}} +\section{\module{htmllib} --- + A parser for HTML documents.} \declaremodule{standard}{htmllib} \modulesynopsis{A parser for HTML documents.} diff --git a/Doc/lib/libhttplib.tex b/Doc/lib/libhttplib.tex index e217967..51b74eb 100644 --- a/Doc/lib/libhttplib.tex +++ b/Doc/lib/libhttplib.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{httplib}} +\section{\module{httplib} --- + HTTP protocol client.} \declaremodule{standard}{httplib} \modulesynopsis{HTTP protocol client (requires sockets).} diff --git a/Doc/lib/libimageop.tex b/Doc/lib/libimageop.tex index 1c01241..ded5b51 100644 --- a/Doc/lib/libimageop.tex +++ b/Doc/lib/libimageop.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{imageop}} +\section{\module{imageop} --- + Manipulate raw image data.} \declaremodule{builtin}{imageop} \modulesynopsis{Manipulate raw image data.} diff --git a/Doc/lib/libimaplib.tex b/Doc/lib/libimaplib.tex index 5501cd2..14daf41 100644 --- a/Doc/lib/libimaplib.tex +++ b/Doc/lib/libimaplib.tex @@ -1,10 +1,11 @@ % 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).} diff --git a/Doc/lib/libimgfile.tex b/Doc/lib/libimgfile.tex index d4c3002..7ea57a4 100644 --- a/Doc/lib/libimgfile.tex +++ b/Doc/lib/libimgfile.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{imgfile}} +\section{\module{imgfile} --- + Support for SGI imglib files.} \declaremodule{builtin}{imgfile} \modulesynopsis{Support for SGI imglib files.} diff --git a/Doc/lib/libimghdr.tex b/Doc/lib/libimghdr.tex index 637dca2..2a162a2 100644 --- a/Doc/lib/libimghdr.tex +++ b/Doc/lib/libimghdr.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libimp.tex b/Doc/lib/libimp.tex index 945ffde..bf50143 100644 --- a/Doc/lib/libimp.tex +++ b/Doc/lib/libimp.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libjpeg.tex b/Doc/lib/libjpeg.tex index 2c227ff..9c2c57a 100644 --- a/Doc/lib/libjpeg.tex +++ b/Doc/lib/libjpeg.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libkeyword.tex b/Doc/lib/libkeyword.tex index 24635a5..16cff84 100644 --- a/Doc/lib/libkeyword.tex +++ b/Doc/lib/libkeyword.tex @@ -1,7 +1,8 @@ -\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 diff --git a/Doc/lib/liblocale.tex b/Doc/lib/liblocale.tex index 9b08872..d70ffcf 100644 --- a/Doc/lib/liblocale.tex +++ b/Doc/lib/liblocale.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{locale}} +\section{\module{locale} --- + Internationalization services.} \declaremodule{standard}{locale} diff --git a/Doc/lib/libmailbox.tex b/Doc/lib/libmailbox.tex index 5ebc57d..8110291 100644 --- a/Doc/lib/libmailbox.tex +++ b/Doc/lib/libmailbox.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{mailbox}} +\section{\module{mailbox} --- + Read various mailbox formats.} \declaremodule{standard}{mailbox} \modulesynopsis{Read various mailbox formats.} diff --git a/Doc/lib/libmailcap.tex b/Doc/lib/libmailcap.tex index 8c8b705..e6c5396 100644 --- a/Doc/lib/libmailcap.tex +++ b/Doc/lib/libmailcap.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{mailcap}} +\section{\module{mailcap} --- + Mailcap file handling.} \declaremodule{standard}{mailcap} \modulesynopsis{Mailcap file handling.} diff --git a/Doc/lib/libmain.tex b/Doc/lib/libmain.tex index 39edfd7..949d2b2 100644 --- a/Doc/lib/libmain.tex +++ b/Doc/lib/libmain.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libmarshal.tex b/Doc/lib/libmarshal.tex index ab7cd05..a30dd1e 100644 --- a/Doc/lib/libmarshal.tex +++ b/Doc/lib/libmarshal.tex @@ -1,8 +1,9 @@ -\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 diff --git a/Doc/lib/libmath.tex b/Doc/lib/libmath.tex index 7ecda2e..49bc226 100644 --- a/Doc/lib/libmath.tex +++ b/Doc/lib/libmath.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{math}} +\section{\module{math} --- + Mathematical functions (\function{sin()} etc.).} \declaremodule{builtin}{math} diff --git a/Doc/lib/libmd5.tex b/Doc/lib/libmd5.tex index b754a66..85b380b 100644 --- a/Doc/lib/libmd5.tex +++ b/Doc/lib/libmd5.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{md5}} +\section{\module{md5} --- + MD5 message digest algorithm.} \declaremodule{builtin}{md5} \modulesynopsis{RSA's MD5 message digest algorithm.} diff --git a/Doc/lib/libmimetools.tex b/Doc/lib/libmimetools.tex index 4cb1300..1b90d89 100644 --- a/Doc/lib/libmimetools.tex +++ b/Doc/lib/libmimetools.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libmimetypes.tex b/Doc/lib/libmimetypes.tex index afd5cca..0beb5f5 100644 --- a/Doc/lib/libmimetypes.tex +++ b/Doc/lib/libmimetypes.tex @@ -2,7 +2,8 @@ % <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.} diff --git a/Doc/lib/libmimify.tex b/Doc/lib/libmimify.tex index 87740b3..7d91d99 100644 --- a/Doc/lib/libmimify.tex +++ b/Doc/lib/libmimify.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{mimify}} +\section{\module{mimify} --- + Mimification and unmimification of mail messages.} \declaremodule{standard}{mimify} \modulesynopsis{Mimification and unmimification of mail messages.} diff --git a/Doc/lib/libmpz.tex b/Doc/lib/libmpz.tex index 98f09a8..c761ea1 100644 --- a/Doc/lib/libmpz.tex +++ b/Doc/lib/libmpz.tex @@ -1,7 +1,9 @@ -\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 diff --git a/Doc/lib/libmultifile.tex b/Doc/lib/libmultifile.tex index 9cca993..d3fb862 100644 --- a/Doc/lib/libmultifile.tex +++ b/Doc/lib/libmultifile.tex @@ -1,6 +1,7 @@ -% 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.} diff --git a/Doc/lib/libni.tex b/Doc/lib/libni.tex index e962eea..fa2b3ee 100644 --- a/Doc/lib/libni.tex +++ b/Doc/lib/libni.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{ni}} +\section{\module{ni} --- + None} \declaremodule{standard}{ni} \modulesynopsis{None} diff --git a/Doc/lib/libnntplib.tex b/Doc/lib/libnntplib.tex index d6e0f81..8b59fed 100644 --- a/Doc/lib/libnntplib.tex +++ b/Doc/lib/libnntplib.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{nntplib}} +\section{\module{nntplib} --- + NNTP protocol client.} \declaremodule{standard}{nntplib} \modulesynopsis{NNTP protocol client (requires sockets).} diff --git a/Doc/lib/liboperator.tex b/Doc/lib/liboperator.tex index f5186e0..c329009 100644 --- a/Doc/lib/liboperator.tex +++ b/Doc/lib/liboperator.tex @@ -1,7 +1,7 @@ -% 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.} @@ -90,7 +90,7 @@ Return the outcome of \keyword{not} \var{o}. \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} diff --git a/Doc/lib/libos.tex b/Doc/lib/libos.tex index 41198ec..75d4182 100644 --- a/Doc/lib/libos.tex +++ b/Doc/lib/libos.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{os}} +\section{\module{os} --- + Miscellaneous OS interfaces.} \declaremodule{standard}{os} \modulesynopsis{Miscellaneous OS interfaces.} diff --git a/Doc/lib/libpanel.tex b/Doc/lib/libpanel.tex index 66ac2a8..cc56dad 100644 --- a/Doc/lib/libpanel.tex +++ b/Doc/lib/libpanel.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{panel}} +\section{\module{panel} --- + None} \declaremodule{standard}{panel} \modulesynopsis{None} @@ -31,7 +32,8 @@ before calling or \code{panel.defpanellist()}. -\section{Standard Module \module{panelparser}} +\section{\module{panelparser} --- + None} \declaremodule{standard}{panelparser} \modulesynopsis{None} @@ -49,7 +51,8 @@ to Python strings and sub-expressions (recursively) to Python lists. 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} diff --git a/Doc/lib/libparser.tex b/Doc/lib/libparser.tex index cbea16d..80ad493 100644 --- a/Doc/lib/libparser.tex +++ b/Doc/lib/libparser.tex @@ -9,11 +9,13 @@ % 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} diff --git a/Doc/lib/libpickle.tex b/Doc/lib/libpickle.tex index 60999eb..6f9ece7 100644 --- a/Doc/lib/libpickle.tex +++ b/Doc/lib/libpickle.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{pickle}} +\section{\module{pickle} --- + Python object serialization.} \declaremodule{standard}{pickle} \modulesynopsis{Convert Python objects to streams of bytes and back.} @@ -274,7 +275,8 @@ registration} \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.} diff --git a/Doc/lib/libpopen2.tex b/Doc/lib/libpopen2.tex index d36be01..30d6e04 100644 --- a/Doc/lib/libpopen2.tex +++ b/Doc/lib/libpopen2.tex @@ -2,9 +2,12 @@ % <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.} diff --git a/Doc/lib/libpoplib.tex b/Doc/lib/libpoplib.tex index 2c21a7f..e3ec5e1 100644 --- a/Doc/lib/libpoplib.tex +++ b/Doc/lib/libpoplib.tex @@ -3,7 +3,8 @@ %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).} diff --git a/Doc/lib/libposix.tex b/Doc/lib/libposix.tex index dbfc692..e3f2929 100644 --- a/Doc/lib/libposix.tex +++ b/Doc/lib/libposix.tex @@ -1,4 +1,5 @@ -\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 diff --git a/Doc/lib/libposixfile.tex b/Doc/lib/libposixfile.tex index b1742f1..9c0ffd8 100644 --- a/Doc/lib/libposixfile.tex +++ b/Doc/lib/libposixfile.tex @@ -1,5 +1,6 @@ % 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.} diff --git a/Doc/lib/libposixpath.tex b/Doc/lib/libposixpath.tex index 87c8010..83f468d 100644 --- a/Doc/lib/libposixpath.tex +++ b/Doc/lib/libposixpath.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{posixpath}} +\section{\module{posixpath} --- + Common \POSIX{} pathname manipulations.} \declaremodule{standard}{posixpath} \modulesynopsis{Common \POSIX{} pathname manipulations.} diff --git a/Doc/lib/libpprint.tex b/Doc/lib/libpprint.tex index 0632875..d676dc4 100644 --- a/Doc/lib/libpprint.tex +++ b/Doc/lib/libpprint.tex @@ -1,6 +1,7 @@ %% 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.} diff --git a/Doc/lib/libpwd.tex b/Doc/lib/libpwd.tex index 32113b4..7841c1e 100644 --- a/Doc/lib/libpwd.tex +++ b/Doc/lib/libpwd.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{pwd}} +\section{\module{pwd} --- + The password database.} \declaremodule{builtin}{pwd} diff --git a/Doc/lib/libqueue.tex b/Doc/lib/libqueue.tex index 3231e11..667d813 100644 --- a/Doc/lib/libqueue.tex +++ b/Doc/lib/libqueue.tex @@ -1,7 +1,8 @@ -\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.} diff --git a/Doc/lib/libquopri.tex b/Doc/lib/libquopri.tex index 6b1d209..748579d 100644 --- a/Doc/lib/libquopri.tex +++ b/Doc/lib/libquopri.tex @@ -1,7 +1,9 @@ -\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, diff --git a/Doc/lib/librand.tex b/Doc/lib/librand.tex index 7a5adea..e335718 100644 --- a/Doc/lib/librand.tex +++ b/Doc/lib/librand.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{rand}} +\section{\module{rand} --- + None} \declaremodule{standard}{rand} \modulesynopsis{None} diff --git a/Doc/lib/librandom.tex b/Doc/lib/librandom.tex index 4806876..63abbb3 100644 --- a/Doc/lib/librandom.tex +++ b/Doc/lib/librandom.tex @@ -1,7 +1,9 @@ -\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 diff --git a/Doc/lib/libre.tex b/Doc/lib/libre.tex index 79d93ad..a453fbf 100644 --- a/Doc/lib/libre.tex +++ b/Doc/lib/libre.tex @@ -1,4 +1,5 @@ -\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} diff --git a/Doc/lib/libregex.tex b/Doc/lib/libregex.tex index 253d50b..ffe959a 100644 --- a/Doc/lib/libregex.tex +++ b/Doc/lib/libregex.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libregsub.tex b/Doc/lib/libregsub.tex index 0a75f36..b779193 100644 --- a/Doc/lib/libregsub.tex +++ b/Doc/lib/libregsub.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libresource.tex b/Doc/lib/libresource.tex index 887268e..1d70e9e 100644 --- a/Doc/lib/libresource.tex +++ b/Doc/lib/libresource.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{resource}} +\section{\module{resource} --- + Resource usage information.} \declaremodule{builtin}{resource} diff --git a/Doc/lib/librexec.tex b/Doc/lib/librexec.tex index 8881c93..a7e8913 100644 --- a/Doc/lib/librexec.tex +++ b/Doc/lib/librexec.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{rexec}} +\section{\module{rexec} --- + Basic restricted execution framework.} \declaremodule{standard}{rexec} \modulesynopsis{Basic restricted execution framework.} diff --git a/Doc/lib/librfc822.tex b/Doc/lib/librfc822.tex index e9317d2..61aadd8 100644 --- a/Doc/lib/librfc822.tex +++ b/Doc/lib/librfc822.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{rfc822}} +\section{\module{rfc822} --- + Parse RFC 822 mail headers.} \declaremodule{standard}{rfc822} \modulesynopsis{Parse \rfc{822} style mail headers.} diff --git a/Doc/lib/librgbimg.tex b/Doc/lib/librgbimg.tex index d06eb76..5ef0603 100644 --- a/Doc/lib/librgbimg.tex +++ b/Doc/lib/librgbimg.tex @@ -1,8 +1,9 @@ -\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 diff --git a/Doc/lib/librotor.tex b/Doc/lib/librotor.tex index a59e2ca..5cfe2b7 100644 --- a/Doc/lib/librotor.tex +++ b/Doc/lib/librotor.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{rotor}} +\section{\module{rotor} --- + Enigma-like encryption and decryption.} \declaremodule{builtin}{rotor} \modulesynopsis{Enigma-like encryption and decryption.} diff --git a/Doc/lib/libselect.tex b/Doc/lib/libselect.tex index b8dfacc..eec8de1 100644 --- a/Doc/lib/libselect.tex +++ b/Doc/lib/libselect.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libsgmllib.tex b/Doc/lib/libsgmllib.tex index 642dacd..a8dfa0b 100644 --- a/Doc/lib/libsgmllib.tex +++ b/Doc/lib/libsgmllib.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libshelve.tex b/Doc/lib/libshelve.tex index 6b5aa76..4b7f773 100644 --- a/Doc/lib/libshelve.tex +++ b/Doc/lib/libshelve.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{shelve}} +\section{\module{shelve} --- + Python object persistency.} \declaremodule{standard}{shelve} \modulesynopsis{Python object persistency.} diff --git a/Doc/lib/libsignal.tex b/Doc/lib/libsignal.tex index 86d6967..ee68ace 100644 --- a/Doc/lib/libsignal.tex +++ b/Doc/lib/libsignal.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{signal}} +\section{\module{signal} --- + Set handlers for asynchronous events.} \declaremodule{builtin}{signal} diff --git a/Doc/lib/libsite.tex b/Doc/lib/libsite.tex index 020b266..e8bafd6 100644 --- a/Doc/lib/libsite.tex +++ b/Doc/lib/libsite.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libsmtplib.tex b/Doc/lib/libsmtplib.tex index 21cadce..d7929eb 100644 --- a/Doc/lib/libsmtplib.tex +++ b/Doc/lib/libsmtplib.tex @@ -1,6 +1,7 @@ -% 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).} diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex index 47a2914..c6476b9 100644 --- a/Doc/lib/libsocket.tex +++ b/Doc/lib/libsocket.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{socket}} +\section{\module{socket} --- + Low-level networking interface.} \declaremodule{builtin}{socket} \modulesynopsis{Low-level networking interface.} diff --git a/Doc/lib/libsocksvr.tex b/Doc/lib/libsocksvr.tex index a07b0e3..80ac724 100644 --- a/Doc/lib/libsocksvr.tex +++ b/Doc/lib/libsocksvr.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{SocketServer}} +\section{\module{SocketServer} --- + A framework for network servers.} \declaremodule{standard}{SocketServer} \modulesynopsis{A framework for network servers.} diff --git a/Doc/lib/libsoundex.tex b/Doc/lib/libsoundex.tex index 83e8bc7..8073a8c 100644 --- a/Doc/lib/libsoundex.tex +++ b/Doc/lib/libsoundex.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{soundex}} +\section{\module{soundex} --- + None} \declaremodule{builtin}{soundex} \modulesynopsis{None} diff --git a/Doc/lib/libstat.tex b/Doc/lib/libstat.tex index 102630a..b74e98b 100644 --- a/Doc/lib/libstat.tex +++ b/Doc/lib/libstat.tex @@ -1,18 +1,20 @@ -% 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} diff --git a/Doc/lib/libstdwin.tex b/Doc/lib/libstdwin.tex index 64ccdd9..9edfba5 100644 --- a/Doc/lib/libstdwin.tex +++ b/Doc/lib/libstdwin.tex @@ -14,7 +14,8 @@ of dialogs. For most platforms, alternative, native solutions exist 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} @@ -777,7 +778,8 @@ def main(): main() \end{verbatim} % -\section{Standard Module \module{stdwinevents}} +\section{\module{stdwinevents} --- + None} \declaremodule{standard}{stdwinevents} \modulesynopsis{None} @@ -794,7 +796,8 @@ Suggested usage is >>> \end{verbatim} % -\section{Standard Module \module{rect}} +\section{\module{rect} --- + None} \declaremodule{standard}{rect} \modulesynopsis{None} diff --git a/Doc/lib/libstring.tex b/Doc/lib/libstring.tex index 226f453..f7189fd 100644 --- a/Doc/lib/libstring.tex +++ b/Doc/lib/libstring.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{string}} +\section{\module{string} --- + Common string operations.} \declaremodule{standard}{string} \modulesynopsis{Common string operations.} diff --git a/Doc/lib/libstringio.tex b/Doc/lib/libstringio.tex index 6b7d2c5..0e59e03 100644 --- a/Doc/lib/libstringio.tex +++ b/Doc/lib/libstringio.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{StringIO}} +\section{\module{StringIO} --- + Read and write strings as if they were files.} \declaremodule{standard}{StringIO} @@ -28,7 +29,8 @@ Free the memory buffer. \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.} diff --git a/Doc/lib/libstruct.tex b/Doc/lib/libstruct.tex index 08b930c..be7d80b 100644 --- a/Doc/lib/libstruct.tex +++ b/Doc/lib/libstruct.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libsunaudio.tex b/Doc/lib/libsunaudio.tex index 920b048..cc7c1ed 100644 --- a/Doc/lib/libsunaudio.tex +++ b/Doc/lib/libsunaudio.tex @@ -1,10 +1,11 @@ -\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. diff --git a/Doc/lib/libsymbol.tex b/Doc/lib/libsymbol.tex index 6dbc76e..7d9f9ac 100644 --- a/Doc/lib/libsymbol.tex +++ b/Doc/lib/libsymbol.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libsys.tex b/Doc/lib/libsys.tex index 1f37bc8..eadd978 100644 --- a/Doc/lib/libsys.tex +++ b/Doc/lib/libsys.tex @@ -1,7 +1,8 @@ -\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. diff --git a/Doc/lib/libsyslog.tex b/Doc/lib/libsyslog.tex index cd32bbf..70a05be 100644 --- a/Doc/lib/libsyslog.tex +++ b/Doc/lib/libsyslog.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libtempfile.tex b/Doc/lib/libtempfile.tex index dadd357..95034bb 100644 --- a/Doc/lib/libtempfile.tex +++ b/Doc/lib/libtempfile.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{tempfile}} +\section{\module{tempfile} --- + Generate temporary file names.} \declaremodule{standard}{tempfile} \modulesynopsis{Generate temporary file names.} diff --git a/Doc/lib/libtemplate.tex b/Doc/lib/libtemplate.tex index e82bb21..cff05d1 100644 --- a/Doc/lib/libtemplate.tex +++ b/Doc/lib/libtemplate.tex @@ -3,26 +3,32 @@ % ==== 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.} diff --git a/Doc/lib/libtermios.tex b/Doc/lib/libtermios.tex index 18b63bf..9c9c3c8 100644 --- a/Doc/lib/libtermios.tex +++ b/Doc/lib/libtermios.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{termios}} +\section{\module{termios} --- + \POSIX{} style tty control.} \declaremodule{builtin}{termios} \modulesynopsis{\POSIX{} style tty control.} @@ -94,10 +95,12 @@ def getpass(prompt = "Password: "): 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} diff --git a/Doc/lib/libthread.tex b/Doc/lib/libthread.tex index 2e55b41..df87118 100644 --- a/Doc/lib/libthread.tex +++ b/Doc/lib/libthread.tex @@ -1,7 +1,8 @@ -\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 diff --git a/Doc/lib/libthreading.tex b/Doc/lib/libthreading.tex index 928b422..d2c5ff3 100644 --- a/Doc/lib/libthreading.tex +++ b/Doc/lib/libthreading.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{threading}} +\section{\module{threading} --- + Higher-level threading interfaces.} \declaremodule{standard}{threading} \modulesynopsis{Higher-level threading interfaces.} diff --git a/Doc/lib/libtime.tex b/Doc/lib/libtime.tex index caafd50..f63ecb0 100644 --- a/Doc/lib/libtime.tex +++ b/Doc/lib/libtime.tex @@ -1,4 +1,5 @@ -\section{Built-in Module \module{time}} +\section{\module{time} --- + Time access and conversions.} \declaremodule{builtin}{time} \modulesynopsis{Time access and conversions.} diff --git a/Doc/lib/libtoken.tex b/Doc/lib/libtoken.tex index ce3bd5c..87477c5 100644 --- a/Doc/lib/libtoken.tex +++ b/Doc/lib/libtoken.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libtraceback.tex b/Doc/lib/libtraceback.tex index 29c8ac6..e2a7e07 100644 --- a/Doc/lib/libtraceback.tex +++ b/Doc/lib/libtraceback.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{traceback}} +\section{\module{traceback} --- + Print or retrieve a stack traceback.} \declaremodule{standard}{traceback} \modulesynopsis{Print or retrieve a stack traceback.} diff --git a/Doc/lib/libtypes.tex b/Doc/lib/libtypes.tex index f3c4ee0..5f9034c 100644 --- a/Doc/lib/libtypes.tex +++ b/Doc/lib/libtypes.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{types}} +\section{\module{types} --- + Names for all built-in types.} \declaremodule{standard}{types} \modulesynopsis{Names for all built-in types.} diff --git a/Doc/lib/liburllib.tex b/Doc/lib/liburllib.tex index 7a98582..ab57e55 100644 --- a/Doc/lib/liburllib.tex +++ b/Doc/lib/liburllib.tex @@ -1,4 +1,5 @@ -\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).} diff --git a/Doc/lib/liburlparse.tex b/Doc/lib/liburlparse.tex index 9a2b4f5..60c83cc 100644 --- a/Doc/lib/liburlparse.tex +++ b/Doc/lib/liburlparse.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{urlparse}} +\section{\module{urlparse} --- + Parse URLs into components.} \declaremodule{standard}{urlparse} \modulesynopsis{Parse URLs into components.} diff --git a/Doc/lib/libuser.tex b/Doc/lib/libuser.tex index 5527225..484af7e 100644 --- a/Doc/lib/libuser.tex +++ b/Doc/lib/libuser.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libuserdict.tex b/Doc/lib/libuserdict.tex index 6c29906..f37d4cc 100644 --- a/Doc/lib/libuserdict.tex +++ b/Doc/lib/libuserdict.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{UserDict}} +\section{\module{UserDict} --- + Class wrapper for dictionary objects.} \declaremodule{standard}{UserDict} \modulesynopsis{Class wrapper for dictionary objects.} @@ -24,7 +25,8 @@ class. \end{memberdesc} -\section{Standard Module \module{UserList}} +\section{\module{UserList} --- + Class wrapper for list objects.} \declaremodule{standard}{UserList} \modulesynopsis{Class wrapper for list objects.} diff --git a/Doc/lib/libuu.tex b/Doc/lib/libuu.tex index b052de7..4145823 100644 --- a/Doc/lib/libuu.tex +++ b/Doc/lib/libuu.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libwhichdb.tex b/Doc/lib/libwhichdb.tex index db4f555..b3035cf 100644 --- a/Doc/lib/libwhichdb.tex +++ b/Doc/lib/libwhichdb.tex @@ -1,4 +1,5 @@ -\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.} diff --git a/Doc/lib/libwhrandom.tex b/Doc/lib/libwhrandom.tex index bc7d402..8df1b77 100644 --- a/Doc/lib/libwhrandom.tex +++ b/Doc/lib/libwhrandom.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{whrandom}} +\section{\module{whrandom} --- + Floating point pseudo-random number generator.} \declaremodule{standard}{whrandom} \modulesynopsis{Floating point pseudo-random number generator.} diff --git a/Doc/lib/libxdrlib.tex b/Doc/lib/libxdrlib.tex index 6de8d92..3565eb7 100644 --- a/Doc/lib/libxdrlib.tex +++ b/Doc/lib/libxdrlib.tex @@ -1,8 +1,9 @@ -\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} diff --git a/Doc/lib/libxmllib.tex b/Doc/lib/libxmllib.tex index 129ab17..d8aa3ed 100644 --- a/Doc/lib/libxmllib.tex +++ b/Doc/lib/libxmllib.tex @@ -1,4 +1,5 @@ -\section{Standard Module \module{xmllib}} +\section{\module{xmllib} --- + A parser for XML documents.} % Author: Sjoerd Mullender \declaremodule{standard}{xmllib} diff --git a/Doc/lib/libzlib.tex b/Doc/lib/libzlib.tex index 0369507..9dbb16b 100644 --- a/Doc/lib/libzlib.tex +++ b/Doc/lib/libzlib.tex @@ -1,7 +1,8 @@ % 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 diff --git a/Doc/templates/module.tex b/Doc/templates/module.tex index e82bb21..cff05d1 100644 --- a/Doc/templates/module.tex +++ b/Doc/templates/module.tex @@ -3,26 +3,32 @@ % ==== 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.} |