summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libimaplib.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-04-22 16:46:18 (GMT)
committerFred Drake <fdrake@acm.org>1999-04-22 16:46:18 (GMT)
commitb774550ba5f7d8f0315e0c46d09531b41fe4bfb8 (patch)
treefb81f0542b7379e57db0d014b8ccdb4293796c39 /Doc/lib/libimaplib.tex
parentdd6c6d9b0a5d2bab8f0e4771d9406dd35c035a63 (diff)
downloadcpython-b774550ba5f7d8f0315e0c46d09531b41fe4bfb8.zip
cpython-b774550ba5f7d8f0315e0c46d09531b41fe4bfb8.tar.gz
cpython-b774550ba5f7d8f0315e0c46d09531b41fe4bfb8.tar.bz2
Minor logical markup nits.
Make some module references hyperlinks.
Diffstat (limited to 'Doc/lib/libimaplib.tex')
-rw-r--r--Doc/lib/libimaplib.tex20
1 files changed, 10 insertions, 10 deletions
diff --git a/Doc/lib/libimaplib.tex b/Doc/lib/libimaplib.tex
index 14daf41..294963f 100644
--- a/Doc/lib/libimaplib.tex
+++ b/Doc/lib/libimaplib.tex
@@ -2,13 +2,13 @@
% converted by Fred L. Drake, Jr. <fdrake@acm.org>.
\section{\module{imaplib} ---
- IMAP4 protocol client.}
+ IMAP4 protocol client}
+
\declaremodule{standard}{imaplib}
+\modulesynopsis{IMAP4 protocol client (requires sockets).}
\moduleauthor{Piers Lauder}{piers@staff.cs.usyd.edu.au}
\sectionauthor{Piers Lauder}{piers@staff.cs.usyd.edu.au}
-\modulesynopsis{IMAP4 protocol client (requires sockets).}
-
\indexii{IMAP4}{protocol}
This module defines a class, \class{IMAP4}, which encapsulates a
@@ -17,7 +17,7 @@ protocol as defined in \rfc{2060}. It is backward compatible with
IMAP4 (\rfc{1730}) servers, but note that the \samp{STATUS} command is
not supported in IMAP4.
-A single class is provided by the \code{imaplib} module:
+A single class is provided by the \module{imaplib} module:
\begin{classdesc}{IMAP4}{\optional{host\optional{, port}}}
This class implements the actual IMAP4 protocol. The connection is
@@ -45,7 +45,7 @@ The following utility functions are defined:
\begin{funcdesc}{Internaldate2tuple}{datestr}
Converts an IMAP4 INTERNALDATE string to Coordinated Universal
- Time. Returns a \module{time} module tuple.
+ Time. Returns a \refmodule{time} module tuple.
\end{funcdesc}
\begin{funcdesc}{Int2AP}{num}
@@ -59,7 +59,7 @@ The following utility functions are defined:
\end{funcdesc}
\begin{funcdesc}{Time2Internaldate}{date_time}
- Converts a \module{time} module tuple to an IMAP4
+ Converts a \refmodule{time} module tuple to an IMAP4
\samp{INTERNALDATE} representation. Returns a string in the form:
\code{"DD-Mmm-YYYY HH:MM:SS +HHMM"} (including double-quotes).
\end{funcdesc}
@@ -71,8 +71,8 @@ The following utility functions are defined:
All IMAP4rev1 commands are represented by methods of the same name,
either upper-case or lower-case.
-Each command returns a tuple: \code{(}\var{type}, \code{[}\var{data},
-...\code{])} where \var{type} is usually \code{'OK'} or \code{'NO'},
+Each command returns a tuple: \code{(\var{type}, [\var{data},
+...])} where \var{type} is usually \code{'OK'} or \code{'NO'},
and \var{data} is either the text from the command response, or
mandated results from the command.
@@ -201,8 +201,8 @@ The following attributes are defined on instances of \class{IMAP4}:
\begin{memberdesc}{PROTOCOL_VERSION}
-The most recent supported protocol in the \samp{CAPABILITY}
-response from the server.
+The most recent supported protocol in the
+\samp{CAPABILITY} response from the server.
\end{memberdesc}
\begin{memberdesc}{debug}