Added \platform annotations.

This commit is contained in:
Fred Drake 1999-03-02 16:37:17 +00:00
parent 46a9438c43
commit f6863c1909
38 changed files with 297 additions and 242 deletions

View file

@ -1,7 +1,8 @@
\section{\module{al} --- \section{\module{al} ---
Audio functions on the SGI.} Audio functions on the SGI}
\declaremodule{builtin}{al}
\declaremodule{builtin}{al}
\platform{IRIX}
\modulesynopsis{Audio functions on the SGI.} \modulesynopsis{Audio functions on the SGI.}
@ -13,9 +14,9 @@ releases before 4.0.5. Again, see the manual to check whether a
specific function is available on your platform. specific function is available on your platform.
All functions and methods defined in this module are equivalent to All functions and methods defined in this module are equivalent to
the \C{} functions with \samp{AL} prefixed to their name. the C functions with \samp{AL} prefixed to their name.
Symbolic constants from the \C{} header file \code{<audio.h>} are Symbolic constants from the C header file \code{<audio.h>} are
defined in the standard module \module{AL}\refstmodindex{AL}, see defined in the standard module \module{AL}\refstmodindex{AL}, see
below. below.
@ -163,15 +164,16 @@ Get status information on last error.
\section{\module{AL} --- \section{\module{AL} ---
Constants used with the \module{al} module.} Constants used with the \module{al} module}
\declaremodule{standard}{AL}
\declaremodule{standard}{AL}
\platform{IRIX}
\modulesynopsis{Constants used with the \module{al} module.} \modulesynopsis{Constants used with the \module{al} module.}
This module defines symbolic constants needed to use the built-in This module defines symbolic constants needed to use the built-in
module \module{al} (see above); they are equivalent to those defined module \module{al} (see above); they are equivalent to those defined
in the \C{} header file \code{<audio.h>} except that the name prefix in the C header file \code{<audio.h>} except that the name prefix
\samp{AL_} is omitted. Read the module source for a complete list of \samp{AL_} is omitted. Read the module source for a complete list of
the defined names. Suggested use: the defined names. Suggested use:

View file

@ -1,9 +1,10 @@
\chapter{Amoeba Specific Services} \chapter{Amoeba Specific Services}
\section{\module{amoeba} --- \section{\module{amoeba} ---
Amoeba system support.} Amoeba system support}
\declaremodule{builtin}{amoeba}
\declaremodule{builtin}{amoeba}
\platform{Amoeba}
\modulesynopsis{Functions for the Amoeba operating system.} \modulesynopsis{Functions for the Amoeba operating system.}
@ -12,13 +13,13 @@ Amoeba applications. It is only available on systems that support
Amoeba operations. RPC errors and other Amoeba errors are reported as Amoeba operations. RPC errors and other Amoeba errors are reported as
the exception \code{amoeba.error = 'amoeba.error'}. the exception \code{amoeba.error = 'amoeba.error'}.
The module \code{amoeba} defines the following items: The module \module{amoeba} defines the following items:
\begin{funcdesc}{name_append}{path, cap} \begin{funcdesc}{name_append}{path, cap}
Stores a capability in the Amoeba directory tree. Stores a capability in the Amoeba directory tree.
Arguments are the pathname (a string) and the capability (a capability Arguments are the pathname (a string) and the capability (a capability
object as returned by object as returned by
\code{name_lookup()}). \function{name_lookup()}).
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{name_delete}{path} \begin{funcdesc}{name_delete}{path}
@ -38,11 +39,11 @@ object, to which various interesting operations apply, described below.
Replaces a capability in the Amoeba directory tree. Replaces a capability in the Amoeba directory tree.
Arguments are the pathname and the new capability. Arguments are the pathname and the new capability.
(This differs from (This differs from
\code{name_append()} \function{name_append()}
in the behavior when the pathname already exists: in the behavior when the pathname already exists:
\code{name_append()} \function{name_append()}
finds this an error while finds this an error while
\code{name_replace()} \function{name_replace()}
allows it, as its name suggests.) allows it, as its name suggests.)
\end{funcdesc} \end{funcdesc}
@ -62,7 +63,7 @@ in C.
The exception raised when an Amoeba function returns an error. The exception raised when an Amoeba function returns an error.
The value accompanying this exception is a pair containing the numeric The value accompanying this exception is a pair containing the numeric
error code and the corresponding string, as returned by the C function error code and the corresponding string, as returned by the C function
\code{err_why()}. \cfunction{err_why()}.
\end{excdesc} \end{excdesc}
\begin{funcdesc}{timeout}{msecs} \begin{funcdesc}{timeout}{msecs}

View file

@ -2,6 +2,7 @@
CD-ROM access on SGI systems} CD-ROM access on SGI systems}
\declaremodule{builtin}{cd} \declaremodule{builtin}{cd}
\platform{IRIX}
\modulesynopsis{Interface to the CD-ROM on Silicon Graphics systems.} \modulesynopsis{Interface to the CD-ROM on Silicon Graphics systems.}

View file

@ -1,8 +1,12 @@
\section{\module{crypt} --- \section{\module{crypt} ---
The \cfunction{crypt()} function used to check \UNIX{} passwords.} Function used to check \UNIX{} passwords}
\declaremodule{builtin}{crypt}
\modulesynopsis{The \cfunction{crypt()} function used to check \UNIX{} passwords.} \declaremodule{builtin}{crypt}
\platform{UNIX}
\modulesynopsis{The \cfunction{crypt()} function used to check \UNIX{}
passwords.}
\moduleauthor{Steven D. Majewski}{sdm7g@virginia.edu}
\sectionauthor{Steven D. Majewski}{sdm7g@virginia.edu}
This module implements an interface to the \manpage{crypt}{3} routine, This module implements an interface to the \manpage{crypt}{3} routine,
@ -16,9 +20,9 @@ attempting to crack \UNIX{} passwords with a dictionary.
\var{word} will usually be a user's password. \var{salt} is a \var{word} will usually be a user's password. \var{salt} is a
2-character string which will be used to select one of 4096 variations 2-character string which will be used to select one of 4096 variations
of DES\indexii{cipher}{DES}. The characters in \var{salt} must be of DES\indexii{cipher}{DES}. The characters in \var{salt} must be
either \code{.}, \code{/}, or an alphanumeric character. Returns the either \character{.}, \character{/}, or an alphanumeric character.
hashed password as a string, which will be composed of characters from Returns the hashed password as a string, which will be composed of
the same alphabet as the salt. characters from the same alphabet as the salt.
\end{funcdesc} \end{funcdesc}
The module and documentation were written by Steve Majewski. The module and documentation were written by Steve Majewski.

View file

@ -2,6 +2,7 @@
Simple ``database'' interface} Simple ``database'' interface}
\declaremodule{builtin}{dbm} \declaremodule{builtin}{dbm}
\platform{UNIX}
\modulesynopsis{The standard ``database'' interface, based on ndbm.} \modulesynopsis{The standard ``database'' interface, based on ndbm.}
@ -9,7 +10,7 @@ The \module{dbm} module provides an interface to the \UNIX{}
\code{(n)dbm} library. Dbm objects behave like mappings \code{(n)dbm} library. Dbm objects behave like mappings
(dictionaries), except that keys and values are always strings. (dictionaries), except that keys and values are always strings.
Printing a dbm object doesn't print the keys and values, and the Printing a dbm object doesn't print the keys and values, and the
\code{items()} and \code{values()} methods are not supported. \method{items()} and \method{values()} methods are not supported.
See also the \refmodule{gdbm}\refbimodindex{gdbm} module, which See also the \refmodule{gdbm}\refbimodindex{gdbm} module, which
provides a similar interface using the GNU GDBM library. provides a similar interface using the GNU GDBM library.

View file

@ -1,8 +1,9 @@
% Manual text by Jaap Vermeulen % Manual text by Jaap Vermeulen
\section{\module{fcntl} --- \section{\module{fcntl} ---
The \function{fcntl()} and \function{ioctl()} system calls.} The \function{fcntl()} and \function{ioctl()} system calls}
\declaremodule{builtin}{fcntl}
\declaremodule{builtin}{fcntl}
\platform{UNIX}
\modulesynopsis{The \function{fcntl()} and \function{ioctl()} system calls.} \modulesynopsis{The \function{fcntl()} and \function{ioctl()} system calls.}
\indexii{UNIX@\UNIX{}}{file control} \indexii{UNIX@\UNIX{}}{file control}
@ -24,10 +25,10 @@ The module defines the following functions:
is optional, and defaults to the integer value \code{0}. When is optional, and defaults to the integer value \code{0}. When
present, it can either be an integer value, or a string. With present, it can either be an integer value, or a string. With
the argument missing or an integer value, the return value of this the argument missing or an integer value, the return value of this
function is the integer return value of the \C{} \cfunction{fcntl()} function is the integer return value of the C \cfunction{fcntl()}
call. When the argument is a string it represents a binary call. When the argument is a string it represents a binary
structure, e.g.\ created by \function{struct.pack()}. The binary structure, e.g.\ created by \function{struct.pack()}. The binary
data is copied to a buffer whose address is passed to the \C{} data is copied to a buffer whose address is passed to the C
\cfunction{fcntl()} call. The return value after a successful call \cfunction{fcntl()} call. The return value after a successful call
is the contents of the buffer, converted to a string object. In is the contents of the buffer, converted to a string object. In
case the \cfunction{fcntl()} fails, an \exception{IOError} is case the \cfunction{fcntl()} fails, an \exception{IOError} is
@ -54,7 +55,7 @@ manual for details.
If the library modules \module{FCNTL}\refstmodindex{FCNTL} or If the library modules \module{FCNTL}\refstmodindex{FCNTL} or
\module{IOCTL}\refstmodindex{IOCTL} are missing, you can find the \module{IOCTL}\refstmodindex{IOCTL} are missing, you can find the
opcodes in the \C{} include files \code{<sys/fcntl.h>} and opcodes in the C include files \code{<sys/fcntl.h>} and
\code{<sys/ioctl.h>}. You can create the modules yourself with the \code{<sys/ioctl.h>}. You can create the modules yourself with the
\program{h2py} script, found in the \file{Tools/scripts/} directory. \program{h2py} script, found in the \file{Tools/scripts/} directory.

View file

@ -1,7 +1,8 @@
\section{\module{fl} --- \section{\module{fl} ---
FORMS library interface for GUI applications.} FORMS library interface for GUI applications}
\declaremodule{builtin}{fl}
\declaremodule{builtin}{fl}
\platform{IRIX}
\modulesynopsis{FORMS library interface for GUI applications.} \modulesynopsis{FORMS library interface for GUI applications.}
@ -11,9 +12,9 @@ library can be retrieved by anonymous ftp from host
\samp{ftp.cs.ruu.nl}, directory \file{SGI/FORMS}. It was last tested \samp{ftp.cs.ruu.nl}, directory \file{SGI/FORMS}. It was last tested
with version 2.0b. with version 2.0b.
Most functions are literal translations of their \C{} equivalents, Most functions are literal translations of their C equivalents,
dropping the initial \samp{fl_} from their name. Constants used by dropping the initial \samp{fl_} from their name. Constants used by
the library are defined in module \module{FL} described below. the library are defined in module \refmodule{FL} described below.
The creation of objects is a little different in Python than in C: The creation of objects is a little different in Python than in C:
instead of the `current form' maintained by the library to which new instead of the `current form' maintained by the library to which new
@ -45,7 +46,7 @@ function \cfunction{foreground()} and to the FORMS routine
Module \module{fl} defines the following functions. For more Module \module{fl} defines the following functions. For more
information about what they do, see the description of the equivalent information about what they do, see the description of the equivalent
\C{} function in the FORMS documentation: C function in the FORMS documentation:
\begin{funcdesc}{make_form}{type, width, height} \begin{funcdesc}{make_form}{type, width, height}
Create a form with given type, width and height. This returns a Create a form with given type, width and height. This returns a
@ -73,7 +74,7 @@ Set the graphics modes.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{get_rgbmode}{} \begin{funcdesc}{get_rgbmode}{}
Return the current rgb mode. This is the value of the \C{} global Return the current rgb mode. This is the value of the C global
variable \cdata{fl_rgbmode}. variable \cdata{fl_rgbmode}.
\end{funcdesc} \end{funcdesc}
@ -143,7 +144,7 @@ See the description in the FORMS documentation of
\label{form-objects} \label{form-objects}
Form objects (returned by \function{make_form()} above) have the Form objects (returned by \function{make_form()} above) have the
following methods. Each method corresponds to a \C{} function whose following methods. Each method corresponds to a C function whose
name is prefixed with \samp{fl_}; and whose first argument is a form name is prefixed with \samp{fl_}; and whose first argument is a form
pointer; please refer to the official FORMS documentation for pointer; please refer to the official FORMS documentation for
descriptions. descriptions.
@ -465,16 +466,18 @@ FORMS objects have these data attributes; see the FORMS documentation:
\lineiii{automatic}{int (read-only)}{(see FORMS docs)} \lineiii{automatic}{int (read-only)}{(see FORMS docs)}
\end{tableiii} \end{tableiii}
\section{\module{FL} ---
Constants used with the \module{fl} module.}
\declaremodule{standard}{FL}
\section{\module{FL} ---
Constants used with the \module{fl} module}
\declaremodule{standard}{FL}
\platform{IRIX}
\modulesynopsis{Constants used with the \module{fl} module.} \modulesynopsis{Constants used with the \module{fl} module.}
This module defines symbolic constants needed to use the built-in This module defines symbolic constants needed to use the built-in
module \module{fl} (see above); they are equivalent to those defined in module \refmodule{fl} (see above); they are equivalent to those defined in
the \C{} header file \code{<forms.h>} except that the name prefix the C header file \code{<forms.h>} except that the name prefix
\samp{FL_} is omitted. Read the module source for a complete list of \samp{FL_} is omitted. Read the module source for a complete list of
the defined names. Suggested use: the defined names. Suggested use:
@ -483,16 +486,18 @@ import fl
from FL import * from FL import *
\end{verbatim} \end{verbatim}
\section{\module{flp} ---
Loading functions for stored FORMS designs.}
\declaremodule{standard}{flp}
\modulesynopsis{Loading functions for stored FORMS designs.} \section{\module{flp} ---
Functions for loading stored FORMS designs}
\declaremodule{standard}{flp}
\platform{IRIX}
\modulesynopsis{Functions for loading stored FORMS designs.}
This module defines functions that can read form definitions created This module defines functions that can read form definitions created
by the `form designer' (\program{fdesign}) program that comes with the by the `form designer' (\program{fdesign}) program that comes with the
FORMS library (see module \module{fl} above). FORMS library (see module \refmodule{fl} above).
For now, see the file \file{flp.doc} in the Python library source For now, see the file \file{flp.doc} in the Python library source
directory for a description. directory for a description.

View file

@ -2,6 +2,7 @@
\emph{Font Manager} interface} \emph{Font Manager} interface}
\declaremodule{builtin}{fm} \declaremodule{builtin}{fm}
\platform{IRIX}
\modulesynopsis{\emph{Font Manager} interface for SGI workstations.} \modulesynopsis{\emph{Font Manager} interface for SGI workstations.}

View file

@ -2,6 +2,7 @@
GNU's reinterpretation of dbm} GNU's reinterpretation of dbm}
\declaremodule{builtin}{gdbm} \declaremodule{builtin}{gdbm}
\platform{UNIX}
\modulesynopsis{GNU's reinterpretation of dbm.} \modulesynopsis{GNU's reinterpretation of dbm.}

View file

@ -2,6 +2,7 @@
\emph{Graphics Library} interface} \emph{Graphics Library} interface}
\declaremodule{builtin}{gl} \declaremodule{builtin}{gl}
\platform{IRIX}
\modulesynopsis{Functions from the Silicon Graphics \emph{Graphics Library}.} \modulesynopsis{Functions from the Silicon Graphics \emph{Graphics Library}.}
@ -185,11 +186,13 @@ def main():
main() main()
\end{verbatim} \end{verbatim}
%
\section{\module{DEVICE} ---
Constants used with the \module{gl} module.}
\declaremodule{standard}{DEVICE}
\section{\module{DEVICE} ---
Constants used with the \module{gl} module}
\declaremodule{standard}{DEVICE}
\platform{IRIX}
\modulesynopsis{Constants used with the \module{gl} module.} \modulesynopsis{Constants used with the \module{gl} module.}
This modules defines the constants used by the Silicon Graphics This modules defines the constants used by the Silicon Graphics
@ -199,9 +202,10 @@ Read the module source file for details.
\section{\module{GL} --- \section{\module{GL} ---
Constants used with the \module{gl} module.} Constants used with the \module{gl} module}
\declaremodule{standard}{GL}
\declaremodule{standard}{GL}
\platform{IRIX}
\modulesynopsis{Constants used with the \module{gl} module.} \modulesynopsis{Constants used with the \module{gl} module.}
This module contains constants used by the Silicon Graphics This module contains constants used by the Silicon Graphics

View file

@ -1,10 +1,11 @@
\section{\module{grp} --- \section{\module{grp} ---
The group database.} The group database}
\declaremodule{builtin}{grp} \declaremodule{builtin}{grp}
\platform{UNIX}
\modulesynopsis{The group database (\function{getgrnam()} and friends).} \modulesynopsis{The group database (\function{getgrnam()} and friends).}
This module provides access to the \UNIX{} group database. This module provides access to the \UNIX{} group database.
It is available on all \UNIX{} versions. It is available on all \UNIX{} versions.
@ -18,7 +19,7 @@ The gid is an integer, name and password are strings, and the member
list is a list of strings. list is a list of strings.
(Note that most users are not explicitly listed as members of the (Note that most users are not explicitly listed as members of the
group they are in according to the password database.) group they are in according to the password database.)
A \code{KeyError} exception is raised if the entry asked for cannot be found. \exception{KeyError} is raised if the entry asked for cannot be found.
It defines the following items: It defines the following items:

View file

@ -1,7 +1,8 @@
\section{\module{imgfile} --- \section{\module{imgfile} ---
Support for SGI imglib files.} Support for SGI imglib files}
\declaremodule{builtin}{imgfile}
\declaremodule{builtin}{imgfile}
\platform{IRIX}
\modulesynopsis{Support for SGI imglib files.} \modulesynopsis{Support for SGI imglib files.}

View file

@ -2,6 +2,7 @@
Read and write JPEG files} Read and write JPEG files}
\declaremodule{builtin}{jpeg} \declaremodule{builtin}{jpeg}
\platform{IRIX}
\modulesynopsis{Read and write image files in compressed JPEG format.} \modulesynopsis{Read and write image files in compressed JPEG format.}

View file

@ -2,6 +2,7 @@
Useful routines from the MS VC++ runtime} Useful routines from the MS VC++ runtime}
\declaremodule{builtin}{msvcrt} \declaremodule{builtin}{msvcrt}
\platform{Windows}
\modulesynopsis{Miscellaneous useful routines from the MS VC++ runtime.} \modulesynopsis{Miscellaneous useful routines from the MS VC++ runtime.}
\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org} \sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}

View file

@ -1,14 +1,10 @@
% This section was contributed by Drew Csillag
% <drew_csillag@geocities.com>, with some re-organization by Fred L.
% Drake, Jr. <fdrake@acm.org>.
\section{\module{popen2} --- \section{\module{popen2} ---
Subprocesses with accessible standard I/O streams.} Subprocesses with accessible standard I/O streams}
\declaremodule{standard}{popen2}
\sectionauthor{Drew Csillag}{drew_csillag@geocities.com}
\declaremodule[popentwo]{standard}{popen2}
\platform{UNIX}
\modulesynopsis{Subprocesses with accessible standard I/O streams.} \modulesynopsis{Subprocesses with accessible standard I/O streams.}
\sectionauthor{Drew Csillag}{drew_csillag@geocities.com}
This module allows you to spawn processes and connect their This module allows you to spawn processes and connect their

View file

@ -1,7 +1,8 @@
\section{\module{posix} --- \section{\module{posix} ---
The most common \POSIX{} system calls.} The most common \POSIX{} system calls}
\declaremodule{builtin}{posix}
\declaremodule{builtin}{posix}
\platform{UNIX}
\modulesynopsis{The most common \POSIX{} system calls (normally used \modulesynopsis{The most common \POSIX{} system calls (normally used
via module \module{os}).} via module \module{os}).}

View file

@ -1,9 +1,13 @@
% Manual text and implementation by Jaap Vermeulen % Manual text and implementation by Jaap Vermeulen
\section{\module{posixfile} --- \section{\module{posixfile} ---
A file-like object with support for locking.} File-like objects with locking support}
\declaremodule{builtin}{posixfile}
\declaremodule{builtin}{posixfile}
\platform{UNIX}
\modulesynopsis{A file-like object with support for locking.} \modulesynopsis{A file-like object with support for locking.}
\moduleauthor{Jaap Vermeulen}{}
\sectionauthor{Jaap Vermeulen}{}
\indexii{\POSIX{}}{file object} \indexii{\POSIX{}}{file object}

View file

@ -1,8 +1,8 @@
\section{\module{pwd} --- \section{\module{pwd} ---
The password database.} The password database}
\declaremodule{builtin}{pwd} \declaremodule{builtin}{pwd}
\platform{UNIX}
\modulesynopsis{The password database (\function{getpwnam()} and friends).} \modulesynopsis{The password database (\function{getpwnam()} and friends).}
This module provides access to the \UNIX{} password database. This module provides access to the \UNIX{} password database.
@ -18,7 +18,7 @@ following items from the password database (see \code{<pwd.h>}), in order:
\code{pw_dir}, \code{pw_dir},
\code{pw_shell}. \code{pw_shell}.
The uid and gid items are integers, all others are strings. The uid and gid items are integers, all others are strings.
A \code{KeyError} exception is raised if the entry asked for cannot be found. \exception{KeyError} is raised if the entry asked for cannot be found.
It defines the following items: It defines the following items:

View file

@ -1,11 +1,14 @@
\section{\module{resource} --- \section{\module{resource} ---
Resource usage information.} Resource usage information}
\declaremodule{builtin}{resource} \declaremodule{builtin}{resource}
\platform{UNIX}
\modulesynopsis{An interface to provide resource usage information on
the current process.}
\moduleauthor{Jeremy Hylton}{jhylton@cnri.reston.va.us}
\sectionauthor{Jeremy Hylton}{jhylton@cnri.reston.va.us}
\modulesynopsis{An interface to provide resource usage information on the current
process.}
This module provides basic mechanisms for measuring and controlling This module provides basic mechanisms for measuring and controlling
system resources utilized by a program. system resources utilized by a program.
@ -76,7 +79,7 @@ value to denote the same resource.
\begin{datadesc}{RLIMIT_CPU} \begin{datadesc}{RLIMIT_CPU}
The maximum amount of CPU time (in seconds) that a process can The maximum amount of CPU time (in seconds) that a process can
use. If this limit is exceeded, a \constant{SIGXCPU} signal is sent to use. If this limit is exceeded, a \constant{SIGXCPU} signal is sent to
the process. (See the \module{signal} module documentation for the process. (See the \refmodule{signal} module documentation for
information about how to catch this signal and do something useful, information about how to catch this signal and do something useful,
e.g. flush open files to disk.) e.g. flush open files to disk.)
\end{datadesc} \end{datadesc}
@ -134,7 +137,7 @@ These functiona are used to retrieve resource usage information:
This function returns a large tuple that describes the resources This function returns a large tuple that describes the resources
consumed by either the current process or its children, as specified consumed by either the current process or its children, as specified
by the \var{who} parameter. The \var{who} parameter should be by the \var{who} parameter. The \var{who} parameter should be
specified using one of the \code{RUSAGE_*} constants described specified using one of the \constant{RUSAGE_*} constants described
below. below.
The elements of the return value each The elements of the return value each
@ -183,7 +186,7 @@ These functiona are used to retrieve resource usage information:
bytes. bytes.
\end{funcdesc} \end{funcdesc}
The following \code{RUSAGE_*} symbols are passed to the The following \constant{RUSAGE_*} symbols are passed to the
\function{getrusage()} function to specify which processes information \function{getrusage()} function to specify which processes information
should be provided for. should be provided for.

View file

@ -1,11 +1,11 @@
\section{\module{stat} --- \section{\module{stat} ---
Utilities for interpreting \function{stat()} results.} Interpreting \function{stat()} results}
\declaremodule{standard}{stat} \declaremodule{standard}{stat}
\sectionauthor{Skip Montanaro}{skip@automatrix.com} \platform{UNIX}
\modulesynopsis{Utilities for interpreting the results of \modulesynopsis{Utilities for interpreting the results of
\function{os.stat()}, \function{os.lstat()} and \function{os.fstat()}.} \function{os.stat()}, \function{os.lstat()} and \function{os.fstat()}.}
\sectionauthor{Skip Montanaro}{skip@automatrix.com}
The \module{stat} module defines constants and functions for The \module{stat} module defines constants and functions for
@ -46,7 +46,7 @@ Return non-zero if the mode was gotten from a socket.
\end{funcdesc} \end{funcdesc}
All the data items below are simply symbolic indexes into the 10-tuple All the data items below are simply symbolic indexes into the 10-tuple
returned by \code{os.stat()} or \code{os.lstat()}. returned by \function{os.stat()} or \function{os.lstat()}.
\begin{datadesc}{ST_MODE} \begin{datadesc}{ST_MODE}
Inode protection mode. Inode protection mode.
@ -109,7 +109,15 @@ def process(dir, func):
print 'Skipping %s/%s' % (dir, f) print 'Skipping %s/%s' % (dir, f)
def f(file): def f(file):
-Egon
print 'frobbed', file print 'frobbed', file
if __name__ == '__main__': process(sys.argv[1], f) if __name__ == '__main__': process(sys.argv[1], f)
\end{verbatim} \end{verbatim}
-Egon

View file

@ -1,7 +1,8 @@
\section{\module{sunaudiodev} --- \section{\module{sunaudiodev} ---
Access to Sun audio hardware.} Access to Sun audio hardware.}
\declaremodule{builtin}{sunaudiodev}
\declaremodule{builtin}{sunaudiodev}
\platform{SunOS}
\modulesynopsis{Access to Sun audio hardware.} \modulesynopsis{Access to Sun audio hardware.}

View file

@ -1,7 +1,8 @@
\section{\module{syslog} --- \section{\module{syslog} ---
\UNIX{} syslog library routines.} \UNIX{} syslog library routines}
\declaremodule{builtin}{syslog}
\declaremodule{builtin}{syslog}
\platform{UNIX}
\modulesynopsis{An interface to the \UNIX{} syslog library routines.} \modulesynopsis{An interface to the \UNIX{} syslog library routines.}

View file

@ -1,7 +1,8 @@
\section{\module{termios} --- \section{\module{termios} ---
\POSIX{} style tty control.} \POSIX{} style tty control}
\declaremodule{builtin}{termios}
\declaremodule{builtin}{termios}
\platform{UNIX}
\modulesynopsis{\POSIX{} style tty control.} \modulesynopsis{\POSIX{} style tty control.}
\indexii{\POSIX{}}{I/O control} \indexii{\POSIX{}}{I/O control}
@ -19,8 +20,8 @@ first argument. This must be an integer file descriptor, such as
returned by \code{sys.stdin.fileno()}. returned by \code{sys.stdin.fileno()}.
This module should be used in conjunction with the This module should be used in conjunction with the
\module{TERMIOS}\refstmodindex{TERMIOS} module, which defines the \refmodule[TERMIOSuppercase]{TERMIOS}\refstmodindex{TERMIOS} module,
relevant symbolic constants (see the next section). which defines the relevant symbolic constants (see the next section).
The module defines the following functions: The module defines the following functions:
@ -33,7 +34,8 @@ length 1, except the items with indices \constant{TERMIOS.VMIN} and
\constant{TERMIOS.VTIME}, which are integers when these fields are \constant{TERMIOS.VTIME}, which are integers when these fields are
defined). The interpretation of the flags and the speeds as well as defined). The interpretation of the flags and the speeds as well as
the indexing in the \var{cc} array must be done using the symbolic the indexing in the \var{cc} array must be done using the symbolic
constants defined in the \module{TERMIOS} module. constants defined in the \refmodule[TERMIOSuppercase]{TERMIOS}
module.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{tcsetattr}{fd, when, attributes} \begin{funcdesc}{tcsetattr}{fd, when, attributes}
@ -97,18 +99,19 @@ def getpass(prompt = "Password: "):
\section{\module{TERMIOS} --- \section{\module{TERMIOS} ---
Constants used with \module{termios}} Constants used with the \module{termios} module}
\declaremodule[TERMIOSuppercase]{standard}{TERMIOS} \declaremodule[TERMIOSuppercase]{standard}{TERMIOS}
\platform{UNIX}
\modulesynopsis{Symbolic constants required to use the \modulesynopsis{Symbolic constants required to use the
\module{termios} module.} \module{termios} module.}
\indexii{\POSIX{}}{I/O control} \indexii{\POSIX{}}{I/O control}
\indexii{tty}{I/O control} \indexii{tty}{I/O control}
This module defines the symbolic constants required to use the This module defines the symbolic constants required to use the
\module{termios}\refbimodindex{termios} module (see the previous \refmodule{termios}\refbimodindex{termios} module (see the previous
section). See the \POSIX{} or \UNIX{} manual pages (or the source) section). See the \POSIX{} or \UNIX{} manual pages (or the source)
for a list of those constants. for a list of those constants.

View file

@ -2,6 +2,7 @@
Sound-playing interface for Windows} Sound-playing interface for Windows}
\declaremodule{builtin}{winsound} \declaremodule{builtin}{winsound}
\platform{Windows}
\modulesynopsis{Access to the sound-playing machinery for Windows.} \modulesynopsis{Access to the sound-playing machinery for Windows.}
\moduleauthor{Toby Dickenson}{htrd90@zepler.org} \moduleauthor{Toby Dickenson}{htrd90@zepler.org}
\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org} \sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}

View file

@ -1,7 +1,8 @@
\section{\module{ctb} --- \section{\module{ctb} ---
Interface to the Communications Tool Box.} Interface to the Communications Tool Box}
\declaremodule{builtin}{ctb}
\declaremodule{builtin}{ctb}
\platform{Mac}
\modulesynopsis{Interfaces to the Communications Tool Box. Only the Connection \modulesynopsis{Interfaces to the Communications Tool Box. Only the Connection
Manager is supported.} Manager is supported.}
@ -48,8 +49,8 @@ Alternatively, passing \code{None} for \var{sizes} will result in
default buffer sizes. default buffer sizes.
\end{funcdesc} \end{funcdesc}
\subsection{connection object}
\label{connection-object} \subsection{Connection Objects \label{connection-object}}
For all connection methods that take a \var{timeout} argument, a value For all connection methods that take a \var{timeout} argument, a value
of \code{-1} is indefinite, meaning that the command runs to completion. of \code{-1} is indefinite, meaning that the command runs to completion.

View file

@ -1,7 +1,8 @@
\section{\module{FrameWork} --- \section{\module{FrameWork} ---
Interactive application framework.} Interactive application framework}
\declaremodule{standard}{FrameWork}
\declaremodule{standard}{FrameWork}
\platform{Mac}
\modulesynopsis{Interactive application framework.} \modulesynopsis{Interactive application framework.}
@ -52,7 +53,7 @@ this case menu selection causes the lookup of a method in the topmost
window and the application. The method name is the callback string window and the application. The method name is the callback string
with \code{'domenu_'} prepended. with \code{'domenu_'} prepended.
Calling the \code{MenuBar} \code{fixmenudimstate} method sets the Calling the \code{MenuBar} \method{fixmenudimstate()} method sets the
correct dimming for all menu items based on the current front window. correct dimming for all menu items based on the current front window.
\end{funcdesc} \end{funcdesc}
@ -75,11 +76,11 @@ Creates a modeless dialog window.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{windowbounds}{width, height} \begin{funcdesc}{windowbounds}{width, height}
Return a \code{(left, top, right, bottom)} tuple suitable for creation Return a \code{(\var{left}, \var{top}, \var{right}, \var{bottom})}
of a window of given width and height. The window will be staggered tuple suitable for creation of a window of given width and height. The
with respect to previous windows, and an attempt is made to keep the window will be staggered with respect to previous windows, and an
whole window on-screen. The window will however always be exact the attempt is made to keep the whole window on-screen. The window will
size given, so parts may be offscreen. however always be exact the size given, so parts may be offscreen.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{setwatchcursor}{} \begin{funcdesc}{setwatchcursor}{}
@ -90,31 +91,30 @@ Set the mouse cursor to a watch.
Set the mouse cursor to an arrow. Set the mouse cursor to an arrow.
\end{funcdesc} \end{funcdesc}
\subsection{Application Objects}
\label{application-objects} \subsection{Application Objects \label{application-objects}}
Application objects have the following methods, among others: Application objects have the following methods, among others:
\setindexsubitem{(Application method)}
\begin{funcdesc}{makeusermenus}{} \begin{methoddesc}[Application]{makeusermenus}{}
Override this method if you need menus in your application. Append the Override this method if you need menus in your application. Append the
menus to the attribute \member{menubar}. menus to the attribute \member{menubar}.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{getabouttext}{} \begin{methoddesc}[Application]{getabouttext}{}
Override this method to return a text string describing your Override this method to return a text string describing your
application. Alternatively, override the \method{do_about()} method application. Alternatively, override the \method{do_about()} method
for more elaborate ``about'' messages. for more elaborate ``about'' messages.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{mainloop}{\optional{mask\optional{, wait}}} \begin{methoddesc}[Application]{mainloop}{\optional{mask\optional{, wait}}}
This routine is the main event loop, call it to set your application This routine is the main event loop, call it to set your application
rolling. \var{Mask} is the mask of events you want to handle, rolling. \var{Mask} is the mask of events you want to handle,
\var{wait} is the number of ticks you want to leave to other \var{wait} is the number of ticks you want to leave to other
concurrent application (default 0, which is probably not a good concurrent application (default 0, which is probably not a good
idea). While raising \code{self} to exit the mainloop is still idea). While raising \var{self} to exit the mainloop is still
supported it is not recommended, call \code{self._quit} instead. supported it is not recommended: call \code{self._quit()} instead.
The event loop is split into many small parts, each of which can be The event loop is split into many small parts, each of which can be
overridden. The default methods take care of dispatching events to overridden. The default methods take care of dispatching events to
@ -129,9 +129,9 @@ Calling \function{MacOS.HandleEvent()} is not allowed within
\var{our_dispatch} or its callees, since this may result in an \var{our_dispatch} or its callees, since this may result in an
infinite loop if the code is called through the Python inner-loop infinite loop if the code is called through the Python inner-loop
event handler. event handler.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{asyncevents}{onoff} \begin{methoddesc}[Application]{asyncevents}{onoff}
Call this method with a nonzero parameter to enable Call this method with a nonzero parameter to enable
asynchronous event handling. This will tell the inner interpreter loop asynchronous event handling. This will tell the inner interpreter loop
to call the application event handler \var{async_dispatch} whenever events to call the application event handler \var{async_dispatch} whenever events
@ -144,154 +144,157 @@ events asynchronously. Events you do not handle will be passed to Sioux
and such. and such.
The old on/off value is returned. The old on/off value is returned.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{_quit}{} \begin{methoddesc}[Application]{_quit}{}
Terminate the running \method{mainloop()} call at the next convenient Terminate the running \method{mainloop()} call at the next convenient
moment. moment.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_char}{c, event} \begin{methoddesc}[Application]{do_char}{c, event}
The user typed character \var{c}. The complete details of the event The user typed character \var{c}. The complete details of the event
can be found in the \var{event} structure. This method can also be can be found in the \var{event} structure. This method can also be
provided in a \code{Window} object, which overrides the provided in a \code{Window} object, which overrides the
application-wide handler if the window is frontmost. application-wide handler if the window is frontmost.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_dialogevent}{event} \begin{methoddesc}[Application]{do_dialogevent}{event}
Called early in the event loop to handle modeless dialog events. The Called early in the event loop to handle modeless dialog events. The
default method simply dispatches the event to the relevant dialog (not default method simply dispatches the event to the relevant dialog (not
through the the \code{DialogWindow} object involved). Override if you through the the \code{DialogWindow} object involved). Override if you
need special handling of dialog events (keyboard shortcuts, etc). need special handling of dialog events (keyboard shortcuts, etc).
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{idle}{event} \begin{methoddesc}[Application]{idle}{event}
Called by the main event loop when no events are available. The Called by the main event loop when no events are available. The
null-event is passed (so you can look at mouse position, etc). null-event is passed (so you can look at mouse position, etc).
\end{funcdesc} \end{methoddesc}
\subsection{Window Objects}
\label{window-objects} \subsection{Window Objects \label{window-objects}}
Window objects have the following methods, among others: Window objects have the following methods, among others:
\setindexsubitem{(Window method)} \setindexsubitem{(Window method)}
\begin{funcdesc}{open}{} \begin{methoddesc}[Window]{open}{}
Override this method to open a window. Store the MacOS window-id in Override this method to open a window. Store the MacOS window-id in
\code{self.wid} and call \code{self.do_postopen} to register the \member{self.wid} and call the \method{do_postopen()} method to
window with the parent application. register the window with the parent application.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{close}{} \begin{methoddesc}[Window]{close}{}
Override this method to do any special processing on window Override this method to do any special processing on window
close. Call \code{self.do_postclose} to cleanup the parent state. close. Call the \method{do_postclose()} method to cleanup the parent
\end{funcdesc} state.
\end{methoddesc}
\begin{funcdesc}{do_postresize}{width, height, macoswindowid} \begin{methoddesc}[Window]{do_postresize}{width, height, macoswindowid}
Called after the window is resized. Override if more needs to be done Called after the window is resized. Override if more needs to be done
than calling \code{InvalRect}. than calling \code{InvalRect}.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_contentclick}{local, modifiers, event} \begin{methoddesc}[Window]{do_contentclick}{local, modifiers, event}
The user clicked in the content part of a window. The arguments are The user clicked in the content part of a window. The arguments are
the coordinates (window-relative), the key modifiers and the raw the coordinates (window-relative), the key modifiers and the raw
event. event.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_update}{macoswindowid, event} \begin{methoddesc}[Window]{do_update}{macoswindowid, event}
An update event for the window was received. Redraw the window. An update event for the window was received. Redraw the window.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_activate}{activate, event} \begin{methoddesc}{do_activate}{activate, event}
The window was activated (\code{activate==1}) or deactivated The window was activated (\code{\var{activate} == 1}) or deactivated
(\code{activate==0}). Handle things like focus highlighting, etc. (\code{\var{activate} == 0}). Handle things like focus highlighting,
\end{funcdesc} etc.
\end{methoddesc}
\subsection{ControlsWindow Object}
\label{controlswindow-object} \subsection{ControlsWindow Object \label{controlswindow-object}}
ControlsWindow objects have the following methods besides those of ControlsWindow objects have the following methods besides those of
\code{Window} objects: \code{Window} objects:
\setindexsubitem{(ControlsWindow method)}
\begin{funcdesc}{do_controlhit}{window, control, pcode, event} \begin{methoddesc}[ControlsWindow]{do_controlhit}{window, control,
Part \code{pcode} of control \code{control} was hit by the pcode, event}
Part \var{pcode} of control \var{control} was hit by the
user. Tracking and such has already been taken care of. user. Tracking and such has already been taken care of.
\end{funcdesc} \end{methoddesc}
\subsection{ScrolledWindow Object}
\label{scrolledwindow-object} \subsection{ScrolledWindow Object \label{scrolledwindow-object}}
ScrolledWindow objects are ControlsWindow objects with the following ScrolledWindow objects are ControlsWindow objects with the following
extra methods: extra methods:
\setindexsubitem{(ScrolledWindow method)}
\begin{funcdesc}{scrollbars}{\optional{wantx\optional{, wanty}}} \begin{methoddesc}[ScrolledWindow]{scrollbars}{\optional{wantx\optional{,
wanty}}}
Create (or destroy) horizontal and vertical scrollbars. The arguments Create (or destroy) horizontal and vertical scrollbars. The arguments
specify which you want (default: both). The scrollbars always have specify which you want (default: both). The scrollbars always have
minimum \code{0} and maximum \code{32767}. minimum \code{0} and maximum \code{32767}.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{getscrollbarvalues}{} \begin{methoddesc}[ScrolledWindow]{getscrollbarvalues}{}
You must supply this method. It should return a tuple \code{(\var{x}, You must supply this method. It should return a tuple \code{(\var{x},
\var{y})} giving the current position of the scrollbars (between \var{y})} giving the current position of the scrollbars (between
\code{0} and \code{32767}). You can return \code{None} for either to \code{0} and \code{32767}). You can return \code{None} for either to
indicate the whole document is visible in that direction. indicate the whole document is visible in that direction.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{updatescrollbars}{} \begin{methoddesc}[ScrolledWindow]{updatescrollbars}{}
Call this method when the document has changed. It will call Call this method when the document has changed. It will call
\method{getscrollbarvalues()} and update the scrollbars. \method{getscrollbarvalues()} and update the scrollbars.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{scrollbar_callback}{which, what, value} \begin{methoddesc}[ScrolledWindow]{scrollbar_callback}{which, what, value}
Supplied by you and called after user interaction. \var{which} will Supplied by you and called after user interaction. \var{which} will
be \code{'x'} or \code{'y'}, \var{what} will be \code{'-'}, be \code{'x'} or \code{'y'}, \var{what} will be \code{'-'},
\code{'--'}, \code{'set'}, \code{'++'} or \code{'+'}. For \code{'--'}, \code{'set'}, \code{'++'} or \code{'+'}. For
\code{'set'}, \var{value} will contain the new scrollbar position. \code{'set'}, \var{value} will contain the new scrollbar position.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{scalebarvalues}{absmin, absmax, curmin, curmax} \begin{methoddesc}[ScrolledWindow]{scalebarvalues}{absmin, absmax,
curmin, curmax}
Auxiliary method to help you calculate values to return from Auxiliary method to help you calculate values to return from
\method{getscrollbarvalues()}. You pass document minimum and maximum value \method{getscrollbarvalues()}. You pass document minimum and maximum value
and topmost (leftmost) and bottommost (rightmost) visible values and and topmost (leftmost) and bottommost (rightmost) visible values and
it returns the correct number or \code{None}. it returns the correct number or \code{None}.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_activate}{onoff, event} \begin{methoddesc}[ScrolledWindow]{do_activate}{onoff, event}
Takes care of dimming/highlighting scrollbars when a window becomes Takes care of dimming/highlighting scrollbars when a window becomes
frontmost vv. If you override this method call this one at the end of frontmost vv. If you override this method call this one at the end of
your method. your method.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_postresize}{width, height, window} \begin{methoddesc}[ScrolledWindow]{do_postresize}{width, height, window}
Moves scrollbars to the correct position. Call this method initially Moves scrollbars to the correct position. Call this method initially
if you override it. if you override it.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_controlhit}{window, control, pcode, event} \begin{methoddesc}[ScrolledWindow]{do_controlhit}{window, control,
pcode, event}
Handles scrollbar interaction. If you override it call this method Handles scrollbar interaction. If you override it call this method
first, a nonzero return value indicates the hit was in the scrollbars first, a nonzero return value indicates the hit was in the scrollbars
and has been handled. and has been handled.
\end{funcdesc} \end{methoddesc}
\subsection{DialogWindow Objects}
\label{dialogwindow-objects} \subsection{DialogWindow Objects \label{dialogwindow-objects}}
DialogWindow objects have the following methods besides those of DialogWindow objects have the following methods besides those of
\code{Window} objects: \code{Window} objects:
\setindexsubitem{(DialogWindow method)}
\begin{funcdesc}{open}{resid} \begin{methoddesc}[DialogWindow]{open}{resid}
Create the dialog window, from the DLOG resource with id Create the dialog window, from the DLOG resource with id
\var{resid}. The dialog object is stored in \code{self.wid}. \var{resid}. The dialog object is stored in \member{self.wid}.
\end{funcdesc} \end{methoddesc}
\begin{funcdesc}{do_itemhit}{item, event} \begin{methoddesc}[DialogWindow]{do_itemhit}{item, event}
Item number \var{item} was hit. You are responsible for redrawing Item number \var{item} was hit. You are responsible for redrawing
toggle buttons, etc. toggle buttons, etc.
\end{funcdesc} \end{methoddesc}

View file

@ -41,8 +41,9 @@ The following modules are documented here:
\section{\module{mac} --- \section{\module{mac} ---
Implementations for the \module{os} module} Implementations for the \module{os} module}
\declaremodule{builtin}{mac}
\declaremodule{builtin}{mac}
\platform{Mac}
\modulesynopsis{Implementations for the \module{os} module.} \modulesynopsis{Implementations for the \module{os} module.}
@ -82,8 +83,10 @@ One additional function is available:
\section{\module{macpath} --- \section{\module{macpath} ---
MacOS path manipulation functions} MacOS path manipulation functions}
\declaremodule{standard}{macpath}
\declaremodule{standard}{macpath}
% Could be labeled \platform{Mac}, but the module should work anywhere and
% is distributed with the standard library.
\modulesynopsis{MacOS path manipulation functions.} \modulesynopsis{MacOS path manipulation functions.}

View file

@ -1,13 +1,13 @@
\section{\module{macconsole} --- \section{\module{macconsole} ---
Think C's console package.} Think C's console package}
\declaremodule{builtin}{macconsole}
\declaremodule{builtin}{macconsole}
\platform{Mac}
\modulesynopsis{Think C's console package.} \modulesynopsis{Think C's console package.}
This module is available on the Macintosh, provided Python has been This module is available on the Macintosh, provided Python has been
built using the Think \C{} compiler. It provides an interface to the built using the Think C compiler. It provides an interface to the
Think console package, with which basic text windows can be created. Think console package, with which basic text windows can be created.
\begin{datadesc}{options} \begin{datadesc}{options}

View file

@ -1,12 +1,13 @@
\section{\module{macdnr} --- \section{\module{macdnr} ---
Interfaces to the Macintosh Domain Name Resolver.} Interface to the Macintosh Domain Name Resolver}
\declaremodule{builtin}{macdnr}
\declaremodule{builtin}{macdnr}
\platform{Mac}
\modulesynopsis{Interfaces to the Macintosh Domain Name Resolver.} \modulesynopsis{Interfaces to the Macintosh Domain Name Resolver.}
This module provides an interface to the Macintosh Domain Name This module provides an interface to the Macintosh Domain Name
Resolver. It is usually used in conjunction with the \module{mactcp} Resolver. It is usually used in conjunction with the \refmodule{mactcp}
module, to map hostnames to IP addresses. It may not be available in module, to map hostnames to IP addresses. It may not be available in
all Mac Python versions. all Mac Python versions.
\index{Macintosh Domain Name Resolver} \index{Macintosh Domain Name Resolver}
@ -55,8 +56,8 @@ the hostname of a host willing to accept SMTP\index{SMTP} mail for the
given domain. Returns a dnr result object of the ``mx'' variety. given domain. Returns a dnr result object of the ``mx'' variety.
\end{funcdesc} \end{funcdesc}
\subsection{dnr result object}
\label{dnr-result-object} \subsection{DNR Result Objects \label{dnr-result-object}}
Since the DNR calls all execute asynchronously you do not get the Since the DNR calls all execute asynchronously you do not get the
results back immediately. Instead, you get a dnr result object. You results back immediately. Instead, you get a dnr result object. You
@ -115,6 +116,7 @@ will only return a single mx record. Valid for ``mx'' queries only.
The simplest way to use the module to convert names to dotted-decimal The simplest way to use the module to convert names to dotted-decimal
strings, without worrying about idle time, etc: strings, without worrying about idle time, etc:
\begin{verbatim} \begin{verbatim}
>>> def gethostname(name): >>> def gethostname(name):
... import macdnr ... import macdnr

View file

@ -1,13 +1,12 @@
\section{\module{macfs} --- \section{\module{macfs} ---
FSSpec, the Alias Manager, \program{finder} aliases, Various file system services}
and the Standard File package.}
\declaremodule{builtin}{macfs}
\declaremodule{builtin}{macfs}
\platform{Mac}
\modulesynopsis{Support for FSSpec, the Alias Manager, \modulesynopsis{Support for FSSpec, the Alias Manager,
\program{finder} aliases, and the Standard File package.} \program{finder} aliases, and the Standard File package.}
This module provides access to Macintosh FSSpec handling, the Alias This module provides access to Macintosh FSSpec handling, the Alias
Manager, \program{finder} aliases and the Standard File package. Manager, \program{finder} aliases and the Standard File package.
\index{Macintosh Alias Manager} \index{Macintosh Alias Manager}
@ -111,8 +110,8 @@ Locate the application with 4-char creator code \var{creator}. The
function returns an \pytype{FSSpec} object pointing to the application. function returns an \pytype{FSSpec} object pointing to the application.
\end{funcdesc} \end{funcdesc}
\subsection{FSSpec objects}
\label{fsspec-objects} \subsection{FSSpec objects \label{fsspec-objects}}
\begin{memberdesc}[FSSpec]{data} \begin{memberdesc}[FSSpec]{data}
The raw data from the FSSpec object, suitable for passing The raw data from the FSSpec object, suitable for passing
@ -168,8 +167,7 @@ Python.
\end{methoddesc} \end{methoddesc}
\subsection{Alias Objects} \subsection{Alias Objects \label{alias-objects}}
\label{alias-objects}
\begin{memberdesc}[Alias]{data} \begin{memberdesc}[Alias]{data}
The raw data for the Alias record, suitable for storing in a resource The raw data for the Alias record, suitable for storing in a resource
@ -202,8 +200,7 @@ has changed the Python program is responsible for getting the
resource. resource.
\subsection{FInfo Objects} \subsection{FInfo Objects \label{finfo-objects}}
\label{finfo-objects}
See \emph{Inside Macintosh: Files} for a complete description of what See \emph{Inside Macintosh: Files} for a complete description of what
the various fields mean. the various fields mean.

View file

@ -1,11 +1,11 @@
\section{\module{ic} --- \section{\module{ic} ---
Access to Internet Config.} Access to Internet Config}
\declaremodule{builtin}{ic} \declaremodule{builtin}{ic}
\platform{Mac}
\modulesynopsis{Access to Internet Config.} \modulesynopsis{Access to Internet Config.}
This module provides access to Macintosh Internet Config package, This module provides access to Macintosh Internet Config package,
which stores preferences for Internet programs such as mail address, which stores preferences for Internet programs such as mail address,
default homepage, etc. Also, Internet Config contains an elaborate set default homepage, etc. Also, Internet Config contains an elaborate set
@ -94,10 +94,10 @@ Return the mapping entry for the given \var{file}, which can be passed
as either a filename or an \function{macfs.FSSpec()} result, and which as either a filename or an \function{macfs.FSSpec()} result, and which
need not exist. need not exist.
The mapping entry is returned as a tuple \code{(}\var{version}, The mapping entry is returned as a tuple \code{(\var{version},
\var{type}, \var{creator}, \var{postcreator}, \var{flags}, \var{type}, \var{creator}, \var{postcreator}, \var{flags},
\var{extension}, \var{appname}, \var{postappname}, \var{mimetype}, \var{extension}, \var{appname}, \var{postappname}, \var{mimetype},
\var{entryname}\code{)}, where \var{version} is the entry version \var{entryname})}, where \var{version} is the entry version
number, \var{type} is the 4-character filetype, \var{creator} is the number, \var{type} is the 4-character filetype, \var{creator} is the
4-character creator type, \var{postcreator} is the 4-character creator 4-character creator type, \var{postcreator} is the 4-character creator
code of an code of an

View file

@ -1,11 +1,11 @@
\section{\module{MacOS} --- \section{\module{MacOS} ---
Access to MacOS specific interpreter features.} Access to MacOS interpreter features}
\declaremodule{builtin}{MacOS} \declaremodule{builtin}{MacOS}
\platform{Mac}
\modulesynopsis{Access to MacOS specific interpreter features.} \modulesynopsis{Access to MacOS specific interpreter features.}
This module provides access to MacOS specific functionality in the This module provides access to MacOS specific functionality in the
Python interpreter, such as how the interpreter eventloop functions Python interpreter, such as how the interpreter eventloop functions
and the like. Use with care. and the like. Use with care.

View file

@ -1,7 +1,8 @@
\section{\module{macostools} --- \section{\module{macostools} ---
Convenience routines for file manipulation.} Convenience routines for file manipulation}
\declaremodule{standard}{macostools}
\declaremodule{standard}{macostools}
\platform{Mac}
\modulesynopsis{Convenience routines for file manipulation.} \modulesynopsis{Convenience routines for file manipulation.}
@ -50,10 +51,12 @@ Note that the process of creating finder aliases is not specified in
the Apple documentation. Hence, aliases created with \function{mkalias()} the Apple documentation. Hence, aliases created with \function{mkalias()}
could conceivably have incompatible behaviour in some cases. could conceivably have incompatible behaviour in some cases.
\section{\module{findertools} ---
Wrappers around the \program{finder}'s Apple Events interface.}
\declaremodule{standard}{findertools}
\section{\module{findertools} ---
The \program{finder}'s Apple Events interface}
\declaremodule{standard}{findertools}
\platform{Mac}
\modulesynopsis{Wrappers around the \program{finder}'s Apple Events interface.} \modulesynopsis{Wrappers around the \program{finder}'s Apple Events interface.}

View file

@ -1,11 +1,11 @@
\section{\module{macspeech} --- \section{\module{macspeech} ---
Interface to the Macintosh Speech Manager.} Interface to the Macintosh Speech Manager}
\declaremodule{builtin}{macspeech} \declaremodule{builtin}{macspeech}
\platform{Mac}
\modulesynopsis{Interface to the Macintosh Speech Manager.} \modulesynopsis{Interface to the Macintosh Speech Manager.}
This module provides an interface to the Macintosh Speech Manager, This module provides an interface to the Macintosh Speech Manager,
\index{Macintosh Speech Manager} \index{Macintosh Speech Manager}
\index{Speech Manager, Macintosh} \index{Speech Manager, Macintosh}

View file

@ -1,20 +1,20 @@
\section{\module{mactcp} --- \section{\module{mactcp} ---
The MacTCP interfaces.} The MacTCP interfaces}
\declaremodule{builtin}{mactcp} \declaremodule{builtin}{mactcp}
\platform{Mac}
\modulesynopsis{The MacTCP interfaces.} \modulesynopsis{The MacTCP interfaces.}
This module provides an interface to the Macintosh TCP/IP driver% This module provides an interface to the Macintosh TCP/IP driver%
\index{MacTCP} MacTCP. There is an accompanying module, \index{MacTCP} MacTCP. There is an accompanying module,
\module{macdnr}\refbimodindex{macdnr}, which provides an interface to \refmodule{macdnr}\refbimodindex{macdnr}, which provides an interface
the name-server (allowing you to translate hostnames to IP addresses), to the name-server (allowing you to translate hostnames to IP
a module \module{MACTCPconst}\refstmodindex{MACTCPconst} which has addresses), a module \module{MACTCPconst}\refstmodindex{MACTCPconst}
symbolic names for constants constants used by MacTCP. Since the which has symbolic names for constants constants used by MacTCP. Since
built-in module \module{socket} is also available on the Macintosh it the built-in module \module{socket}\refbimodindex{socket} is also
is usually easier to use sockets instead of the Macintosh-specific available on the Macintosh it is usually easier to use sockets instead
MacTCP API. of the Macintosh-specific MacTCP API.
A complete description of the MacTCP interface can be found in the A complete description of the MacTCP interface can be found in the
Apple MacTCP API documentation. Apple MacTCP API documentation.
@ -55,7 +55,7 @@ function with two integer parameters:\ an event code and a detail. This
function will be called upon network-generated events such as urgent function will be called upon network-generated events such as urgent
data arrival. Macintosh documentation calls this the data arrival. Macintosh documentation calls this the
\dfn{asynchronous service routine}. In addition, it is called with \dfn{asynchronous service routine}. In addition, it is called with
eventcode \code{MACTCP.PassiveOpenDone} when a \code{PassiveOpen} eventcode \code{MACTCP.PassiveOpenDone} when a \method{PassiveOpen()}
completes. This is a Python addition to the MacTCP semantics. completes. This is a Python addition to the MacTCP semantics.
It is safe to do further calls from \var{asr}. It is safe to do further calls from \var{asr}.
\end{memberdesc} \end{memberdesc}
@ -70,11 +70,11 @@ calls other than \method{wait()}, \method{isdone()} or
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[TCP Stream]{wait}{} \begin{methoddesc}[TCP Stream]{wait}{}
Wait for \code{PassiveOpen} to complete. Wait for \method{PassiveOpen()} to complete.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[TCP Stream]{isdone}{} \begin{methoddesc}[TCP Stream]{isdone}{}
Return \code{1} if a \code{PassiveOpen} has completed. Return \code{1} if a \method{PassiveOpen()} has completed.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[TCP Stream]{GetSockName}{} \begin{methoddesc}[TCP Stream]{GetSockName}{}

View file

@ -1,15 +1,17 @@
\section{\module{EasyDialogs} --- \section{\module{EasyDialogs} ---
Basic Macintosh dialogs.} Basic Macintosh dialogs}
\declaremodule{standard}{EasyDialogs}
\declaremodule{standard}{EasyDialogs}
\platform{Mac}
\modulesynopsis{Basic Macintosh dialogs.} \modulesynopsis{Basic Macintosh dialogs.}
The \module{EasyDialogs} module contains some simple dialogs for The \module{EasyDialogs} module contains some simple dialogs for
the Macintosh, modelled after the \module{stdwin} dialogs with similar the Macintosh, modelled after the
names. All routines have an optional parameter \var{id} with which you \module{stdwin}\refbimodindex{stdwin} dialogs with similar names. All
can override the DLOG resource used for the dialog, as long as the routines have an optional parameter \var{id} with which you can
item numbers correspond. See the source for details. override the DLOG resource used for the dialog, as long as the item
numbers correspond. See the source for details.
The \module{EasyDialogs} module defines the following functions: The \module{EasyDialogs} module defines the following functions:

View file

@ -1,7 +1,8 @@
\section{\module{MiniAEFrame} --- \section{\module{MiniAEFrame} ---
Support to act as an Open Scripting Architecture server.} Open Scripting Architecture server support}
\declaremodule{standard}{MiniAEFrame}
\declaremodule{standard}{MiniAEFrame}
\platform{Mac}
\modulesynopsis{Support to act as an Open Scripting Architecture (OSA) server \modulesynopsis{Support to act as an Open Scripting Architecture (OSA) server
(``Apple Events'').} (``Apple Events'').}
@ -11,7 +12,7 @@ that can function as an Open Scripting Architecture
\index{Open Scripting Architecture} \index{Open Scripting Architecture}
(OSA) server, i.e. receive and process (OSA) server, i.e. receive and process
AppleEvents\index{AppleEvents}. It can be used in conjunction with AppleEvents\index{AppleEvents}. It can be used in conjunction with
\module{FrameWork}\refstmodindex{FrameWork} or standalone. \refmodule{FrameWork}\refstmodindex{FrameWork} or standalone.
This module is temporary, it will eventually be replaced by a module This module is temporary, it will eventually be replaced by a module
that handles argument names better and possibly automates making your that handles argument names better and possibly automates making your
@ -38,8 +39,7 @@ provide its own windows, etc.
\end{classdesc} \end{classdesc}
\subsection{AEServer Objects} \subsection{AEServer Objects \label{aeserver-objects}}
\label{aeserver-objects}
\begin{methoddesc}[AEServer]{installaehandler}{classe, type, callback} \begin{methoddesc}[AEServer]{installaehandler}{classe, type, callback}
Installs an AppleEvent handler. \var{classe} and \var{type} are the Installs an AppleEvent handler. \var{classe} and \var{type} are the

View file

@ -7,6 +7,7 @@
\makeindex % tell \index to actually write the \makeindex % tell \index to actually write the
% .idx file % .idx file
\makemodindex % ... and the module index as well. \makemodindex % ... and the module index as well.
\ignorePlatformAnnotation{Mac}
\begin{document} \begin{document}