summaryrefslogtreecommitdiffstats
path: root/Doc/mac
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1995-03-13 10:03:32 (GMT)
committerGuido van Rossum <guido@python.org>1995-03-13 10:03:32 (GMT)
commit6bb1adc7ee688be85b839b747cf25a9e6254cc22 (patch)
tree8cb910de69fa0322275e60763bfc93a1ea12386f /Doc/mac
parenta8a8d4aadd49e3776e2212318331105c939974b4 (diff)
downloadcpython-6bb1adc7ee688be85b839b747cf25a9e6254cc22.zip
cpython-6bb1adc7ee688be85b839b747cf25a9e6254cc22.tar.gz
cpython-6bb1adc7ee688be85b839b747cf25a9e6254cc22.tar.bz2
small changes by Soren Larsen
Diffstat (limited to 'Doc/mac')
-rw-r--r--Doc/mac/libctb.tex20
-rw-r--r--Doc/mac/libmacconsole.tex15
-rw-r--r--Doc/mac/libmacfs.tex24
-rw-r--r--Doc/mac/libmacspeech.tex12
-rw-r--r--Doc/mac/libmactcp.tex48
5 files changed, 59 insertions, 60 deletions
diff --git a/Doc/mac/libctb.tex b/Doc/mac/libctb.tex
index d15177e..3928498 100644
--- a/Doc/mac/libctb.tex
+++ b/Doc/mac/libctb.tex
@@ -30,14 +30,14 @@ Bits in the status as returned by \var{Status}.
\end{datadesc}
\begin{funcdesc}{available}{}
-Returns 1 if the communication toolbox is available, zero otherwise.
+Return 1 if the communication toolbox is available, zero otherwise.
\end{funcdesc}
\begin{funcdesc}{CMNew}{name\, sizes}
Create a connection object using the connection tool named
\var{name}. \var{sizes} is a 6-tuple given buffer sizes for data in,
data out, control in, control out, attention in and attention out.
-Alternatively, passing \var{None} will result in default buffer sizes.
+Alternatively, passing \code{None} will result in default buffer sizes.
\end{funcdesc}
\subsection{connection object}
@@ -47,14 +47,14 @@ of \code{-1} is indefinite, meaning that the command runs to completion.
\renewcommand{\indexsubitem}{(connection object method)}
\begin{datadesc}{callback}
-If this member is set to a value other than \var{None} it should point
+If this member is set to a value other than \code{None} it should point
to a function accepting a single argument (the connection
object). This will make all connection object methods work
asynchronously, with the callback routine being called upon
completion.
{\em Note:} for reasons beyond my understanding the callback routine
-is never called currently. You are advised against using asynchronous
+is currently never called. You are advised against using asynchronous
calls for the time being.
\end{datadesc}
@@ -76,15 +76,15 @@ Accept (when \var{yesno} is non-zero) or reject an incoming call after
\begin{funcdesc}{Close}{timeout\, now}
Close a connection. When \var{now} is zero, the close is orderly
-(i.e. outstanding output is flushed, etc) with a timeout of
+(i.e.\ outstanding output is flushed, etc.)\ with a timeout of
\var{timeout} seconds. When \var{now} is non-zero the close is
-immedeate, discarding output.
+immediate, discarding output.
\end{funcdesc}
\begin{funcdesc}{Read}{len\, chan\, timeout}
-Read \var{len} bytes or until \var{timeout} seconds have passed from
+Read \var{len} bytes, or until \var{timeout} seconds have passed, from
the channel \var{chan} (which is one of \var{cmData}, \var{cmCntl} or
-\var{cmAttn}). Returns a 2-tuple: the data read and the end-of-message
+\var{cmAttn}). Return a 2-tuple:\ the data read and the end-of-message
flag.
\end{funcdesc}
@@ -97,8 +97,8 @@ the number of bytes written.
\end{funcdesc}
\begin{funcdesc}{Status}{}
-Return connection status as the 2-tuple \code{(sizes,
-flags)}. \var{Sizes} is a 6-tuple giving the actual buffer sizes used
+Return connection status as the 2-tuple \code{(\var{sizes},
+\var{flags})}. \var{sizes} is a 6-tuple giving the actual buffer sizes used
(see \var{CMNew}), \var{flags} is a set of bits describing the state
of the connection.
\end{funcdesc}
diff --git a/Doc/mac/libmacconsole.tex b/Doc/mac/libmacconsole.tex
index 0be429b..2f60890 100644
--- a/Doc/mac/libmacconsole.tex
+++ b/Doc/mac/libmacconsole.tex
@@ -23,13 +23,13 @@ etc).
\end{datadesc}
\begin{funcdesc}{copen}{}
-Open a new console window. Returns a console window object.
+Open a new console window. Return a console window object.
\end{funcdesc}
\begin{funcdesc}{fopen}{fp}
Return the console window object corresponding with the given file
-object. \var{Fp} should be one of \var{sys.stdin}, \var{sys.stdout} or
-\var{sys.stderr}.
+object. \var{fp} should be one of \code{sys.stdin}, \code{sys.stdout} or
+\code{sys.stderr}.
\end{funcdesc}
\subsection{macconsole options object}
@@ -57,8 +57,7 @@ The title of the window.
\end{datadesc}
\begin{datadesc}{pause_atexit}
-If set non-zero, the window will wait for user action before closing
-the window.
+If set non-zero, the window will wait for user action before closing.
\end{datadesc}
\subsection{console window object}
@@ -88,13 +87,13 @@ Clear to end-of-line.
\end{funcdesc}
\begin{funcdesc}{inverse}{onoff}
-Enable inverse-video mode: characters with the high bit set are
+Enable inverse-video mode:\ characters with the high bit set are
displayed in inverse video (this disables the upper half of a
-non-ascii character set).
+non-\ASCII{} character set).
\end{funcdesc}
\begin{funcdesc}{gotoxy}{x\, y}
-Set the cursor to position \code{(x, y)}.
+Set the cursor to position \code{(\var{x}, \var{y})}.
\end{funcdesc}
\begin{funcdesc}{hide}{}
diff --git a/Doc/mac/libmacfs.tex b/Doc/mac/libmacfs.tex
index bd22498..80ec76d 100644
--- a/Doc/mac/libmacfs.tex
+++ b/Doc/mac/libmacfs.tex
@@ -7,9 +7,9 @@ This module provides access to macintosh FSSpec handling, the Alias
Manager, finder aliases and the Standard File package.
Whenever a function or method expects a \var{file} argument, this
-argument can be one of three things: (1) a full or partial macintosh
+argument can be one of three things:\ (1) a full or partial Macintosh
pathname, (2) an FSSpec object or (3) a 3-tuple \code{(wdRefNum,
-parID, name)} as described in Inside Mac VI. A description of aliases
+parID, name)} as described in Inside Mac VI\@. A description of aliases
and the standard file package can also be found there.
\begin{funcdesc}{FSSpec}{file}
@@ -26,15 +26,15 @@ Create an Alias object given the raw data for the alias.
\end{funcdesc}
\begin{funcdesc}{ResolveAliasFile}{file}
-Resolve an alias file. Returns a 3-tuple \code{(fsspec, isfolder,
-aliased)} where \var{fsspec} is the resulting FSSpec object,
+Resolve an alias file. Returns a 3-tuple \code{(\var{fsspec}, \var{isfolder},
+\var{aliased})} where \var{fsspec} is the resulting FSSpec object,
\var{isfolder} is true if \var{fsspec} points to a folder and
\var{aliased} is true if the file was an alias in the first place
(otherwise the FSSpec object for the file itself is returned).
\end{funcdesc}
\begin{funcdesc}{StandardGetFile}{\optional{type\, ...}}
-Present the user with a standard ``open onput file''
+Present the user with a standard ``open input file''
dialog. Optionally, you can pass up to four 4-char file types to limit
the files the user can choose from. The function returns an FSSpec
object and a flag indicating that the user completed the dialog
@@ -44,14 +44,14 @@ without cancelling.
\begin{funcdesc}{StandardPutFile}{prompt\, \optional{default}}
Present the user with a standard ``open output file''
dialog. \var{prompt} is the prompt string, and the optional
-\var{default} argument initialized the output file name. The function
+\var{default} argument initializes the output file name. The function
returns an FSSpec object and a flag indicating that the user completed
the dialog without cancelling.
\end{funcdesc}
\begin{funcdesc}{GetDirectory}{}
Present the user with a non-standard ``select a directory''
-dialog. Returns an FSSpec object and a success-indicator.
+dialog. Return an FSSpec object and a success-indicator.
\end{funcdesc}
\subsection{FSSpec objects}
@@ -67,13 +67,13 @@ Return the full pathname of the file described by the FSSpec object.
\end{funcdesc}
\begin{funcdesc}{as_tuple}{}
-Return the \code{(wdRefNum, parID, name)} tuple of the file described
+Return the \code{(\var{wdRefNum}, \var{parID}, \var{name})} tuple of the file described
by the FSSpec object.
\end{funcdesc}
\begin{funcdesc}{NewAlias}{\optional{file}}
Create an Alias object pointing to the file described by this
-FSSpec. If the optional \code{file} parameter is present the alias
+FSSpec. If the optional \var{file} parameter is present the alias
will be relative to that file, otherwise it will be absolute.
\end{funcdesc}
@@ -99,7 +99,7 @@ or transmitting to other programs.
\begin{funcdesc}{Resolve}{\optional{file}}
Resolve the alias. If the alias was created as a relative alias you
-should pass the file relative to which it is. Returns the FSSpec for
+should pass the file relative to which it is. Return the FSSpec for
the file pointed to and a flag indicating whether the alias object
itself was modified during the search process.
\end{funcdesc}
@@ -113,9 +113,9 @@ Update the alias to point to the \var{file} given. If \var{file2} is
present a relative alias will be created.
\end{funcdesc}
-Note that is currently not possible to directly manipulate a resource
+Note that it is currently not possible to directly manipulate a resource
as an alias object. Hence, after calling \var{Update} or after
-\var{Resolve} indicates that the alias has changed the python program
+\var{Resolve} indicates that the alias has changed the Python program
is responsible for getting the \var{data} from the alias object and
modifying the resource.
diff --git a/Doc/mac/libmacspeech.tex b/Doc/mac/libmacspeech.tex
index 0c1d88c..737016e 100644
--- a/Doc/mac/libmacspeech.tex
+++ b/Doc/mac/libmacspeech.tex
@@ -4,18 +4,18 @@
\renewcommand{\indexsubitem}{(in module macspeech)}
This module provides an interface to the Macintosh Speech Manager,
-allowing you to let the macintosh utter phrases. You need a version of
+allowing you to let the Macintosh utter phrases. You need a version of
the speech manager extension (version 1 and 2 have been tested) in
your \code{Extensions} folder for this to work. The module does not
provide full access to all features of the Speech Manager yet.
\begin{funcdesc}{Available}{}
Test availability of the Speech Manager extension (and, on the
-PowerPC, the Speech Manager shared library). Returns 0 or 1.
+PowerPC, the Speech Manager shared library). Return 0 or 1.
\end{funcdesc}
\begin{funcdesc}{Version}{}
-Return the (integer) version of the Speech Manager.
+Return the (integer) version number of the Speech Manager.
\end{funcdesc}
\begin{funcdesc}{SpeakString}{str}
@@ -43,7 +43,7 @@ yet possible to access the parameters of a voice.
\renewcommand{\indexsubitem}{(voice object method)}
\begin{funcdesc}{GetGender}{}
-Return the gender of the voice: 0 for male, 1 for female and -1 for neuter.
+Return the gender of the voice:\ 0 for male, 1 for female and $-1$ for neuter.
\end{funcdesc}
\begin{funcdesc}{NewChannel}{}
@@ -54,7 +54,7 @@ Return a new speech channel object using this voice.
A speech channel object allows you to speak strings with slightly more
control than \code{SpeakString()}, and allows you to use multiple
speakers at the same time. Please note that channel pitch and rate are
-interrelated in some way, so that to make your macintosh sing you will
+interrelated in some way, so that to make your Macintosh sing you will
have to adjust both.
\renewcommand{\indexsubitem}{(speech channel object method)}
@@ -67,7 +67,7 @@ Stop babbling.
\end{funcdesc}
\begin{funcdesc}{GetPitch}{}
-Returns the current pitch of the channel, as a floating-point number.
+Return the current pitch of the channel, as a floating-point number.
\end{funcdesc}
\begin{funcdesc}{SetPitch}{pitch}
diff --git a/Doc/mac/libmactcp.tex b/Doc/mac/libmactcp.tex
index 6f8719e..11c0114 100644
--- a/Doc/mac/libmactcp.tex
+++ b/Doc/mac/libmactcp.tex
@@ -3,11 +3,11 @@
\renewcommand{\indexsubitem}{(in module mactcp)}
This module provides an interface to the Macintosh TCP/IP driver
-MacTCP. There is an accompanying module \var{macdnr} which provides an
+MacTCP\@. There is an accompanying module \code{macdnr} which provides an
interface to the name-server (allowing you to translate hostnames to
-ip-addresses), a module \var{MACTCP} which has symbolic names for
-constants constants used by MacTCP and a wrapper module \var{socket}
-which mimics the unix socket interface (as far as possible).
+ip-addresses), a module \code{MACTCP} which has symbolic names for
+constants constants used by MacTCP and a wrapper module \code{socket}
+which mimics the \UNIX{} socket interface (as far as possible).
A complete description of the MacTCP interface can be found in the
Apple MacTCP API documentation.
@@ -26,14 +26,14 @@ Return the 32-bit integer network mask of the interface.
\end{funcdesc}
\begin{funcdesc}{TCPCreate}{size}
-Create a TCP Stream object. \var{Size} is the size of the receive
+Create a TCP Stream object. \var{size} is the size of the receive
buffer, \code{4096} is suggested by various sources.
\end{funcdesc}
\begin{funcdesc}{UDPCreate}{size, port}
-Create a UDP stream object. \var{Size} is the size of the receive
+Create a UDP stream object. \var{size} is the size of the receive
buffer (and, hence, the size of the biggest datagram you can receive
-on this port). \var{Port} is the UDP port number you want to receive
+on this port). \var{port} is the UDP port number you want to receive
datagrams on, a value of zero will make MacTCP select a free port.
\end{funcdesc}
@@ -41,30 +41,30 @@ datagrams on, a value of zero will make MacTCP select a free port.
\renewcommand{\indexsubitem}{(TCP stream method)}
\begin{datadesc}{asr}
-When set to a value different than \var{None} this should point to a
-function with two integer parameters: an event code and a detail. This
+When set to a value different than \code{None} this should point to a
+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. In addition, it is called with eventcode
-\var{MACTCP.PassiveOpenDone} when a \var{PassiveOpen} completes. This
-is a python addition to the MacTCP semantics.
-It is safe to do further calls from the asr.
+\code{MACTCP.PassiveOpenDone} when a \code{PassiveOpen} completes. This
+is a Python addition to the MacTCP semantics.
+It is safe to do further calls from the \code{asr}.
\end{datadesc}
\begin{funcdesc}{PassiveOpen}{port}
Wait for an incoming connection on TCP port \var{port} (zero makes the
-system pick a free port). The call returns immedeately, and you should
+system pick a free port). The call returns immediately, and you should
use \var{wait} to wait for completion. You should not issue any method
calls other than
-\var{wait}, \var{isdone} or \var{GetSockName} before the call
+\code{wait}, \code{isdone} or \code{GetSockName} before the call
completes.
\end{funcdesc}
\begin{funcdesc}{wait}{}
-Wait for \var{PassiveOpen} to complete.
+Wait for \code{PassiveOpen} to complete.
\end{funcdesc}
\begin{funcdesc}{isdone}{}
-Return 1 if a \var{PassiveOpen} is completed.
+Return 1 if a \code{PassiveOpen} has completed.
\end{funcdesc}
\begin{funcdesc}{GetSockName}{}
@@ -73,9 +73,9 @@ Return the TCP address of this side of a connection as a 2-tuple
\end{funcdesc}
\begin{funcdesc}{ActiveOpen}{lport\, host\, rport}
-Open an outgoing connection to TCP address \code{(host, rport)}. Use
+Open an outgoing connection to TCP address \code{(\var{host}, \var{rport})}. Use
local port \var{lport} (zero makes the system pick a free port). This
-call blocks until the connection is established.
+call blocks until the connection has been established.
\end{funcdesc}
\begin{funcdesc}{Send}{buf\, push\, urgent}
@@ -87,7 +87,7 @@ are flags as specified by the TCP standard.
Receive data. The call returns when \var{timeout} seconds have passed
or when (according to the MacTCP documentation) ``a reasonable amount
of data has been received''. The return value is a 3-tuple
-\code{(data, urgent, mark)}. If urgent data is outstanding \var{Rcv}
+\code{(\var{data}, \var{urgent}, \var{mark})}. If urgent data is outstanding \code{Rcv}
will always return that before looking at any normal data. The first
call returning urgent data will have the \var{urgent} flag set, the
last will have the \var{mark} flag set.
@@ -95,7 +95,7 @@ last will have the \var{mark} flag set.
\begin{funcdesc}{Close}{}
Tell MacTCP that no more data will be transmitted on this
-connection. The call returnes when all data has been acknowledged by
+connection. The call returns when all data has been acknowledged by
the receiving side.
\end{funcdesc}
@@ -131,7 +131,7 @@ amtUnackedData} is what you can pass to \code{Send} without blocking.
\end{datadesc}
\begin{datadesc}{amtUnreadData}
-The number of bytes received but not yet read (what you can \var{Recv}
+The number of bytes received but not yet read (what you can \code{Recv}
without blocking).
\end{datadesc}
@@ -145,7 +145,7 @@ about UDP.
\begin{datadesc}{asr}
The asynchronous service routine to be called on events such as
-datagram arrival without outstanding \var{Read} call. The asr has a
+datagram arrival without outstanding \code{Read} call. The \code{asr} has a
single argument, the event code.
\end{datadesc}
@@ -154,8 +154,8 @@ A read-only member giving the port number of this UDP stream.
\end{datadesc}
\begin{funcdesc}{Read}{timeout}
-Read a datagram, waiting at most \var{timeout} seconds (-1 is
-indefinite). Returns the data.
+Read a datagram, waiting at most \var{timeout} seconds ($-1$ is
+indefinite). Return the data.
\end{funcdesc}
\begin{funcdesc}{Write}{host\, port\, buf}