summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libmailcap.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-08-08 05:39:29 (GMT)
committerFred Drake <fdrake@acm.org>2001-08-08 05:39:29 (GMT)
commit3a5ec57456aca9e64e42d77c97dfc84bcc7710a1 (patch)
treefac7728e693bb48902b29a748f55490e248e0058 /Doc/lib/libmailcap.tex
parenta7d608d1cff4ca8ba70e6d80f8d4be442884912c (diff)
downloadcpython-3a5ec57456aca9e64e42d77c97dfc84bcc7710a1.zip
cpython-3a5ec57456aca9e64e42d77c97dfc84bcc7710a1.tar.gz
cpython-3a5ec57456aca9e64e42d77c97dfc84bcc7710a1.tar.bz2
Clean up some of the markup here -- be more consistent in the use of
semantic labels instead of presentational markup.
Diffstat (limited to 'Doc/lib/libmailcap.tex')
-rw-r--r--Doc/lib/libmailcap.tex18
1 files changed, 9 insertions, 9 deletions
diff --git a/Doc/lib/libmailcap.tex b/Doc/lib/libmailcap.tex
index e6c5396..b221bb3 100644
--- a/Doc/lib/libmailcap.tex
+++ b/Doc/lib/libmailcap.tex
@@ -25,7 +25,7 @@ most \UNIX{} systems.
filename\optional{, plist}}}}
Return a 2-tuple; the first element is a string containing the command
line to be executed
-(which can be passed to \code{os.system()}), and the second element is
+(which can be passed to \function{os.system()}), and the second element is
the mailcap entry for a given MIME type. If no matching MIME
type can be found, \code{(None, None)} is returned.
@@ -44,25 +44,25 @@ usually you'll override it by specifying a filename.
\var{plist} can be a list containing named parameters; the default
value is simply an empty list. Each entry in the list must be a
-string containing the parameter name, an equals sign (\code{=}), and the
-parameter's value. Mailcap entries can contain
+string containing the parameter name, an equals sign (\character{=}),
+and the parameter's value. Mailcap entries can contain
named parameters like \code{\%\{foo\}}, which will be replaced by the
value of the parameter named 'foo'. For example, if the command line
\samp{showpartial \%\{id\}\ \%\{number\}\ \%\{total\}}
was in a mailcap file, and \var{plist} was set to \code{['id=1',
'number=2', 'total=3']}, the resulting command line would be
-\code{"showpartial 1 2 3"}.
+\code{'showpartial 1 2 3'}.
-In a mailcap file, the "test" field can optionally be specified to
-test some external condition (e.g., the machine architecture, or the
+In a mailcap file, the ``test'' field can optionally be specified to
+test some external condition (such as the machine architecture, or the
window system in use) to determine whether or not the mailcap line
-applies. \code{findmatch()} will automatically check such conditions
-and skip the entry if the check fails.
+applies. \function{findmatch()} will automatically check such
+conditions and skip the entry if the check fails.
\end{funcdesc}
\begin{funcdesc}{getcaps}{}
Returns a dictionary mapping MIME types to a list of mailcap file
-entries. This dictionary must be passed to the \code{findmatch()}
+entries. This dictionary must be passed to the \function{findmatch()}
function. An entry is stored as a list of dictionaries, but it
shouldn't be necessary to know the details of this representation.