Commit 88adcdfb authored by Fred Drake's avatar Fred Drake

Added \platform annotations.

parent e5b23a1e
\section{\module{al} ---
Audio functions on the SGI.}
\declaremodule{builtin}{al}
Audio functions on the SGI}
\declaremodule{builtin}{al}
\platform{IRIX}
\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.
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
below.
......@@ -163,15 +164,16 @@ Get status information on last error.
\section{\module{AL} ---
Constants used with the \module{al} module.}
\declaremodule{standard}{AL}
Constants used with the \module{al} module}
\declaremodule{standard}{AL}
\platform{IRIX}
\modulesynopsis{Constants used with the \module{al} module.}
This module defines symbolic constants needed to use the built-in
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
the defined names. Suggested use:
......
\chapter{Amoeba Specific Services}
\section{\module{amoeba} ---
Amoeba system support.}
\declaremodule{builtin}{amoeba}
Amoeba system support}
\declaremodule{builtin}{amoeba}
\platform{Amoeba}
\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
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}
Stores a capability in the Amoeba directory tree.
Arguments are the pathname (a string) and the capability (a capability
object as returned by
\code{name_lookup()}).
\function{name_lookup()}).
\end{funcdesc}
\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.
Arguments are the pathname and the new capability.
(This differs from
\code{name_append()}
\function{name_append()}
in the behavior when the pathname already exists:
\code{name_append()}
\function{name_append()}
finds this an error while
\code{name_replace()}
\function{name_replace()}
allows it, as its name suggests.)
\end{funcdesc}
......@@ -62,7 +63,7 @@ in C.
The exception raised when an Amoeba function returns an error.
The value accompanying this exception is a pair containing the numeric
error code and the corresponding string, as returned by the C function
\code{err_why()}.
\cfunction{err_why()}.
\end{excdesc}
\begin{funcdesc}{timeout}{msecs}
......
......@@ -2,6 +2,7 @@
CD-ROM access on SGI systems}
\declaremodule{builtin}{cd}
\platform{IRIX}
\modulesynopsis{Interface to the CD-ROM on Silicon Graphics systems.}
......
\section{\module{crypt} ---
The \cfunction{crypt()} function used to check \UNIX{} passwords.}
\declaremodule{builtin}{crypt}
Function used to check \UNIX{} passwords}
\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,
......@@ -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
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
either \code{.}, \code{/}, or an alphanumeric character. Returns the
hashed password as a string, which will be composed of characters from
the same alphabet as the salt.
either \character{.}, \character{/}, or an alphanumeric character.
Returns the hashed password as a string, which will be composed of
characters from the same alphabet as the salt.
\end{funcdesc}
The module and documentation were written by Steve Majewski.
......
......@@ -2,6 +2,7 @@
Simple ``database'' interface}
\declaremodule{builtin}{dbm}
\platform{UNIX}
\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
(dictionaries), except that keys and values are always strings.
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
provides a similar interface using the GNU GDBM library.
......
% Manual text by Jaap Vermeulen
\section{\module{fcntl} ---
The \function{fcntl()} and \function{ioctl()} system calls.}
\declaremodule{builtin}{fcntl}
The \function{fcntl()} and \function{ioctl()} system calls}
\declaremodule{builtin}{fcntl}
\platform{UNIX}
\modulesynopsis{The \function{fcntl()} and \function{ioctl()} system calls.}
\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
present, it can either be an integer value, or a string. With
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
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
is the contents of the buffer, converted to a string object. In
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
\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
\program{h2py} script, found in the \file{Tools/scripts/} directory.
......
\section{\module{fl} ---
FORMS library interface for GUI applications.}
\declaremodule{builtin}{fl}
FORMS library interface for GUI applications}
\declaremodule{builtin}{fl}
\platform{IRIX}
\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
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
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:
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
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}
Create a form with given type, width and height. This returns a
......@@ -73,7 +74,7 @@ Set the graphics modes.
\end{funcdesc}
\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}.
\end{funcdesc}
......@@ -143,7 +144,7 @@ See the description in the FORMS documentation of
\label{form-objects}
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
pointer; please refer to the official FORMS documentation for
descriptions.
......@@ -465,16 +466,18 @@ FORMS objects have these data attributes; see the FORMS documentation:
\lineiii{automatic}{int (read-only)}{(see FORMS docs)}
\end{tableiii}
\section{\module{FL} ---
Constants used with the \module{fl} module.}
\declaremodule{standard}{FL}
Constants used with the \module{fl} module}
\declaremodule{standard}{FL}
\platform{IRIX}
\modulesynopsis{Constants used with the \module{fl} module.}
This module defines symbolic constants needed to use the built-in
module \module{fl} (see above); they are equivalent to those defined in
the \C{} header file \code{<forms.h>} except that the name prefix
module \refmodule{fl} (see above); they are equivalent to those defined in
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
the defined names. Suggested use:
......@@ -483,16 +486,18 @@ import fl
from FL import *
\end{verbatim}
\section{\module{flp} ---
Loading functions for stored FORMS designs.}
\declaremodule{standard}{flp}
Functions for loading stored FORMS designs}
\modulesynopsis{Loading functions for 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
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
directory for a description.
......
......@@ -2,6 +2,7 @@
\emph{Font Manager} interface}
\declaremodule{builtin}{fm}
\platform{IRIX}
\modulesynopsis{\emph{Font Manager} interface for SGI workstations.}
......
......@@ -2,6 +2,7 @@
GNU's reinterpretation of dbm}
\declaremodule{builtin}{gdbm}
\platform{UNIX}
\modulesynopsis{GNU's reinterpretation of dbm.}
......
......@@ -2,6 +2,7 @@
\emph{Graphics Library} interface}
\declaremodule{builtin}{gl}
\platform{IRIX}
\modulesynopsis{Functions from the Silicon Graphics \emph{Graphics Library}.}
......@@ -185,11 +186,13 @@ def main():
main()
\end{verbatim}
%
\section{\module{DEVICE} ---
Constants used with the \module{gl} module.}
\declaremodule{standard}{DEVICE}
Constants used with the \module{gl} module}
\declaremodule{standard}{DEVICE}
\platform{IRIX}
\modulesynopsis{Constants used with the \module{gl} module.}
This modules defines the constants used by the Silicon Graphics
......@@ -199,9 +202,10 @@ Read the module source file for details.
\section{\module{GL} ---
Constants used with the \module{gl} module.}
\declaremodule{standard}{GL}
Constants used with the \module{gl} module}
\declaremodule{standard}{GL}
\platform{IRIX}
\modulesynopsis{Constants used with the \module{gl} module.}
This module contains constants used by the Silicon Graphics
......
\section{\module{grp} ---
The group database.}
\declaremodule{builtin}{grp}
The group database}
\declaremodule{builtin}{grp}
\platform{UNIX}
\modulesynopsis{The group database (\function{getgrnam()} and friends).}
This module provides access to the \UNIX{} group database.
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.
(Note that most users are not explicitly listed as members of the
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:
......
\section{\module{imgfile} ---
Support for SGI imglib files.}
\declaremodule{builtin}{imgfile}
Support for SGI imglib files}
\declaremodule{builtin}{imgfile}
\platform{IRIX}
\modulesynopsis{Support for SGI imglib files.}
......
......@@ -2,6 +2,7 @@
Read and write JPEG files}
\declaremodule{builtin}{jpeg}
\platform{IRIX}
\modulesynopsis{Read and write image files in compressed JPEG format.}
......
......@@ -2,6 +2,7 @@
Useful routines from the MS VC++ runtime}
\declaremodule{builtin}{msvcrt}
\platform{Windows}
\modulesynopsis{Miscellaneous useful routines from the MS VC++ runtime.}
\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}
......
% 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} ---
Subprocesses with accessible standard I/O streams.}
\declaremodule{standard}{popen2}
\sectionauthor{Drew Csillag}{drew_csillag@geocities.com}
Subprocesses with accessible standard I/O streams}
\declaremodule[popentwo]{standard}{popen2}
\platform{UNIX}
\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
......
\section{\module{posix} ---
The most common \POSIX{} system calls.}
\declaremodule{builtin}{posix}
The most common \POSIX{} system calls}
\declaremodule{builtin}{posix}
\platform{UNIX}
\modulesynopsis{The most common \POSIX{} system calls (normally used
via module \module{os}).}
......
% Manual text and implementation by Jaap Vermeulen
\section{\module{posixfile} ---
A file-like object with support for locking.}
\declaremodule{builtin}{posixfile}
File-like objects with locking support}
\declaremodule{builtin}{posixfile}
\platform{UNIX}
\modulesynopsis{A file-like object with support for locking.}
\moduleauthor{Jaap Vermeulen}{}
\sectionauthor{Jaap Vermeulen}{}
\indexii{\POSIX{}}{file object}
......
\section{\module{pwd} ---
The password database.}
\declaremodule{builtin}{pwd}
The password database}
\declaremodule{builtin}{pwd}
\platform{UNIX}
\modulesynopsis{The password database (\function{getpwnam()} and friends).}
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_shell}.
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:
......
\section{\module{resource} ---
Resource usage information.}
\declaremodule{builtin}{resource}
Resource usage information}
\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
system resources utilized by a program.
......@@ -76,7 +79,7 @@ value to denote the same resource.
\begin{datadesc}{RLIMIT_CPU}
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
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,
e.g. flush open files to disk.)
\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
consumed by either the current process or its children, as specified
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.
The elements of the return value each
......@@ -183,7 +186,7 @@ These functiona are used to retrieve resource usage information:
bytes.
\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
should be provided for.
......
\section{\module{stat} ---
Utilities for interpreting \function{stat()} results.}
\declaremodule{standard}{stat}
\sectionauthor{Skip Montanaro}{skip@automatrix.com}
Interpreting \function{stat()} results}
\declaremodule{standard}{stat}
\platform{UNIX}
\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
......@@ -46,7 +46,7 @@ Return non-zero if the mode was gotten from a socket.
\end{funcdesc}
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}
Inode protection mode.
......@@ -109,7 +109,15 @@ def process(dir, func):
print 'Skipping %s/%s' % (dir, f)
def f(file):
-Egon
print 'frobbed', file
if __name__ == '__main__': process(sys.argv[1], f)
\end{verbatim}
-Egon
\section{\module{sunaudiodev} ---
Access to Sun audio hardware.}
\declaremodule{builtin}{sunaudiodev}
\declaremodule{builtin}{sunaudiodev}
\platform{SunOS}
\modulesynopsis{Access to Sun audio hardware.}
......
\section{\module{syslog} ---
\UNIX{} syslog library routines.}
\declaremodule{builtin}{syslog}
\UNIX{} syslog library routines}
\declaremodule{builtin}{syslog}
\platform{UNIX}
\modulesynopsis{An interface to the \UNIX{} syslog library routines.}
......
\section{\module{termios} ---
\POSIX{} style tty control.}
\declaremodule{builtin}{termios}
\POSIX{} style tty control}
\declaremodule{builtin}{termios}
\platform{UNIX}
\modulesynopsis{\POSIX{} style tty 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()}.
This module should be used in conjunction with the
\module{TERMIOS}\refstmodindex{TERMIOS} module, which defines the
relevant symbolic constants (see the next section).
\refmodule[TERMIOSuppercase]{TERMIOS}\refstmodindex{TERMIOS} module,
which defines the relevant symbolic constants (see the next section).
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
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
constants defined in the \module{TERMIOS} module.
constants defined in the \refmodule[TERMIOSuppercase]{TERMIOS}
module.
\end{funcdesc}
\begin{funcdesc}{tcsetattr}{fd, when, attributes}
......@@ -97,18 +99,19 @@ def getpass(prompt = "Password: "):
\section{\module{TERMIOS} ---
Constants used with \module{termios}}
Constants used with the \module{termios} module}
\declaremodule[TERMIOSuppercase]{standard}{TERMIOS}
\platform{UNIX}
\modulesynopsis{Symbolic constants required to use the
\module{termios} module.}
\module{termios} module.}
\indexii{\POSIX{}}{I/O control}
\indexii{tty}{I/O control}
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)
for a list of those constants.
......
......@@ -2,6 +2,7 @@
Sound-playing interface for Windows}
\declaremodule{builtin}{winsound}
\platform{Windows}
\modulesynopsis{Access to the sound-playing machinery for Windows.}
\moduleauthor{Toby Dickenson}{htrd90@zepler.org}
\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}
......
\section{\module{ctb} ---
Interface to the Communications Tool Box.}
\declaremodule{builtin}{ctb}
Interface to the Communications Tool Box}
\declaremodule{builtin}{ctb}
\platform{Mac}
\modulesynopsis{Interfaces to the Communications Tool Box. Only the Connection
Manager is supported.}
......@@ -48,8 +49,8 @@ Alternatively, passing \code{None} for \var{sizes} will result in
default buffer sizes.
\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
of \code{-1} is indefinite, meaning that the command runs to completion.
......
This diff is collapsed.
......@@ -41,8 +41,9 @@ The following modules are documented here:
\section{\module{mac} ---
Implementations for the \module{os} module}
\declaremodule{builtin}{mac}
\declaremodule{builtin}{mac}
\platform{Mac}
\modulesynopsis{Implementations for the \module{os} module.}
......@@ -82,8 +83,10 @@ One additional function is available:
\section{\module{macpath} ---
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.}
......
\section{\module{macconsole} ---
Think C's console package.}
\declaremodule{builtin}{macconsole}
Think C's console package}
\declaremodule{builtin}{macconsole}
\platform{Mac}
\modulesynopsis{Think C's console package.}
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.
\begin{datadesc}{options}
......
\section{\module{macdnr} ---
Interfaces to the Macintosh Domain Name Resolver.}
\declaremodule{builtin}{macdnr}
Interface to the Macintosh Domain Name Resolver}
\declaremodule{builtin}{macdnr}
\platform{Mac}
\modulesynopsis{Interfaces to the Macintosh Domain Name Resolver.}
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
all Mac Python versions.
\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.
\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
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
strings, without worrying about idle time, etc:
\begin{verbatim}
>>> def gethostname(name):
... import macdnr
......
\section{\module{macfs} ---
FSSpec, the Alias Manager, \program{finder} aliases,
and the Standard File package.}
\declaremodule{builtin}{macfs}
Various file system services}
\declaremodule{builtin}{macfs}
\platform{Mac}
\modulesynopsis{Support for FSSpec, the Alias Manager,
\program{finder} aliases, and the Standard File package.}
This module provides access to Macintosh FSSpec handling, the Alias
Manager, \program{finder} aliases and the Standard File package.
\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.
\end{funcdesc}
\subsection{FSSpec objects}
\label{fsspec-objects}
\subsection{FSSpec objects \label{fsspec-objects}}
\begin{memberdesc}[FSSpec]{data}
The raw data from the FSSpec object, suitable for passing
......@@ -168,8 +167,7 @@ Python.
\end{methoddesc}
\subsection{Alias Objects}
\label{alias-objects}
\subsection{Alias Objects \label{alias-objects}}
\begin{memberdesc}[Alias]{data}
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.
\subsection{FInfo Objects}
\label{finfo-objects}
\subsection{FInfo Objects \label{finfo-objects}}
See \emph{Inside Macintosh: Files} for a complete description of what
the various fields mean.
......
\section{\module{ic} ---
Access to Internet Config.}
\declaremodule{builtin}{ic}
Access to Internet Config}
\declaremodule{builtin}{ic}
\platform{Mac}
\modulesynopsis{Access to Internet Config.}
This module provides access to Macintosh Internet Config package,
which stores preferences for Internet programs such as mail address,
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
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{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
4-character creator type, \var{postcreator} is the 4-character creator
code of an
......
\section{\module{MacOS} ---
Access to MacOS specific interpreter features.}
\declaremodule{builtin}{MacOS}
Access to MacOS interpreter features}
\declaremodule{builtin}{MacOS}
\platform{Mac}
\modulesynopsis{Access to MacOS specific interpreter features.}
This module provides access to MacOS specific functionality in the
Python interpreter, such as how the interpreter eventloop functions
and the like. Use with care.
......
\section{\module{macostools} ---
Convenience routines for file manipulation.}
\declaremodule{standard}{macostools}
Convenience routines for file manipulation}
\declaremodule{standard}{macostools}
\platform{Mac}
\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()}
could conceivably have incompatible behaviour in some cases.
\section{\module{findertools} ---
Wrappers around the \program{finder}'s Apple Events interface.}
\declaremodule{standard}{findertools}
The \program{finder}'s Apple Events interface}
\declaremodule{standard}{findertools}
\platform{Mac}
\modulesynopsis{Wrappers around the \program{finder}'s Apple Events interface.}
......
\section{\module{macspeech} ---
Interface to the Macintosh Speech Manager.}
\declaremodule{builtin}{macspeech}
Interface to the Macintosh Speech Manager}
\declaremodule{builtin}{macspeech}
\platform{Mac}
\modulesynopsis{Interface to the Macintosh Speech Manager.}
This module provides an interface to the Macintosh Speech Manager,
\index{Macintosh Speech Manager}
\index{Speech Manager, Macintosh}
......
\section{\module{mactcp} ---
The MacTCP interfaces.}
\declaremodule{builtin}{mactcp}
The MacTCP interfaces}
\declaremodule{builtin}{mactcp}
\platform{Mac}
\modulesynopsis{The MacTCP interfaces.}
This module provides an interface to the Macintosh TCP/IP driver%
\index{MacTCP} MacTCP. There is an accompanying module,
\module{macdnr}\refbimodindex{macdnr}, which provides an interface to
the name-server (allowing you to translate hostnames to IP addresses),
a module \module{MACTCPconst}\refstmodindex{MACTCPconst} which has
symbolic names for constants constants used by MacTCP. Since the
built-in module \module{socket} is also available on the Macintosh it
is usually easier to use sockets instead of the Macintosh-specific
MacTCP API.
\refmodule{macdnr}\refbimodindex{macdnr}, which provides an interface
to the name-server (allowing you to translate hostnames to IP
addresses), a module \module{MACTCPconst}\refstmodindex{MACTCPconst}
which has symbolic names for constants constants used by MacTCP. Since
the built-in module \module{socket}\refbimodindex{socket} is also
available on the Macintosh it is usually easier to use sockets instead
of the Macintosh-specific MacTCP API.
A complete description of the MacTCP interface can be found in the
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
data arrival. Macintosh documentation calls this the
\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.
It is safe to do further calls from \var{asr}.
\end{memberdesc}
......@@ -70,11 +70,11 @@ calls other than \method{wait()}, \method{isdone()} or
\end{methoddesc}
\begin{methoddesc}[TCP Stream]{wait}{}
Wait for \code{PassiveOpen} to complete.
Wait for \method{PassiveOpen()} to complete.
\end{methoddesc}
\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}
\begin{methoddesc}[TCP Stream]{GetSockName}{}
......
\section{\module{EasyDialogs} ---
Basic Macintosh dialogs.}
\declaremodule{standard}{EasyDialogs}
Basic Macintosh dialogs}
\declaremodule{standard}{EasyDialogs}
\platform{Mac}
\modulesynopsis{Basic Macintosh dialogs.}
The \module{EasyDialogs} module contains some simple dialogs for
the Macintosh, modelled after the \module{stdwin} dialogs with similar
names. All routines have an optional parameter \var{id} with which you
can override the DLOG resource used for the dialog, as long as the
item numbers correspond. See the source for details.
the Macintosh, modelled after the
\module{stdwin}\refbimodindex{stdwin} dialogs with similar names. All
routines have an optional parameter \var{id} with which you can
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:
......
\section{\module{MiniAEFrame} ---
Support to act as an Open Scripting Architecture server.}
\declaremodule{standard}{MiniAEFrame}
Open Scripting Architecture server support}
\declaremodule{standard}{MiniAEFrame}
\platform{Mac}
\modulesynopsis{Support to act as an Open Scripting Architecture (OSA) server
(``Apple Events'').}
......@@ -11,7 +12,7 @@ that can function as an Open Scripting Architecture
\index{Open Scripting Architecture}
(OSA) server, i.e. receive and process
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
that handles argument names better and possibly automates making your
......@@ -38,8 +39,7 @@ provide its own windows, etc.
\end{classdesc}
\subsection{AEServer Objects}
\label{aeserver-objects}
\subsection{AEServer Objects \label{aeserver-objects}}
\begin{methoddesc}[AEServer]{installaehandler}{classe, type, callback}
Installs an AppleEvent handler. \var{classe} and \var{type} are the
......
......@@ -7,6 +7,7 @@
\makeindex % tell \index to actually write the
% .idx file
\makemodindex % ... and the module index as well.
\ignorePlatformAnnotation{Mac}
\begin{document}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment