Commit 674e0fd7 authored by Fred Drake's avatar Fred Drake

Be more specific about where in RFC 1421 to look, since it's not at all

obvious when taking a quick look.

Say "base64" instead of "base-64", since that seems to be how it's referred
to in other RFCs.
parent b789c70d
\section{Standard Module \sectcode{base64}} \section{Standard Module \module{base64}}
\label{module-base64} \label{module-base64}
\stmodindex{base64} \stmodindex{base64}
\indexii{base-64}{encoding} \indexii{base64}{encoding}
\index{MIME!base 64 encoding} \index{MIME!base64 encoding}
This module perform base-64 encoding and decoding of arbitrary binary This module perform base64 encoding and decoding of arbitrary binary
strings into text strings that can be safely emailed or posted. The strings into text strings that can be safely emailed or posted. The
encoding scheme is defined in \rfc{1421} and is used for MIME email and encoding scheme is defined in \rfc{1421} (``Privacy Enhancement for
Internet Electronic Mail: Part I: Message Encryption and
Authentication Procedures'', section 4.3.2.4, ``Step 4: Printable
Encoding'') and is used for MIME email and
various other Internet-related applications; it is not the same as the various other Internet-related applications; it is not the same as the
output produced by the \file{uuencode} program. For example, the output produced by the \program{uuencode} program. For example, the
string \code{'www.python.org'} is encoded as the string string \code{'www.python.org'} is encoded as the string
\code{'d3d3LnB5dGhvbi5vcmc=\e n'}. \code{'d3d3LnB5dGhvbi5vcmc=\e n'}.
...@@ -24,13 +27,13 @@ mimic the file object interface. \var{input} will be read until ...@@ -24,13 +27,13 @@ mimic the file object interface. \var{input} will be read until
\begin{funcdesc}{decodestring}{s} \begin{funcdesc}{decodestring}{s}
Decode the string \var{s}, which must contain one or more lines of Decode the string \var{s}, which must contain one or more lines of
base-64 encoded data, and return a string containing the resulting base64 encoded data, and return a string containing the resulting
binary data. binary data.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{encode}{input, output} \begin{funcdesc}{encode}{input, output}
Encode the contents of the \var{input} file and write the resulting Encode the contents of the \var{input} file and write the resulting
base-64 encoded data to the \var{output} file. base64 encoded data to the \var{output} file.
\var{input} and \var{output} must either be file objects or objects that \var{input} and \var{output} must either be file objects or objects that
mimic the file object interface. \var{input} will be read until mimic the file object interface. \var{input} will be read until
\code{\var{input}.read()} returns an empty string. \code{\var{input}.read()} returns an empty string.
...@@ -39,7 +42,5 @@ mimic the file object interface. \var{input} will be read until ...@@ -39,7 +42,5 @@ mimic the file object interface. \var{input} will be read until
\begin{funcdesc}{encodestring}{s} \begin{funcdesc}{encodestring}{s}
Encode the string \var{s}, which can contain arbitrary binary data, Encode the string \var{s}, which can contain arbitrary binary data,
and return a string containing one or more lines of and return a string containing one or more lines of
base-64 encoded data. base64 encoded data.
\end{funcdesc} \end{funcdesc}
\section{Standard Module \sectcode{base64}} \section{Standard Module \module{base64}}
\label{module-base64} \label{module-base64}
\stmodindex{base64} \stmodindex{base64}
\indexii{base-64}{encoding} \indexii{base64}{encoding}
\index{MIME!base 64 encoding} \index{MIME!base64 encoding}
This module perform base-64 encoding and decoding of arbitrary binary This module perform base64 encoding and decoding of arbitrary binary
strings into text strings that can be safely emailed or posted. The strings into text strings that can be safely emailed or posted. The
encoding scheme is defined in \rfc{1421} and is used for MIME email and encoding scheme is defined in \rfc{1421} (``Privacy Enhancement for
Internet Electronic Mail: Part I: Message Encryption and
Authentication Procedures'', section 4.3.2.4, ``Step 4: Printable
Encoding'') and is used for MIME email and
various other Internet-related applications; it is not the same as the various other Internet-related applications; it is not the same as the
output produced by the \file{uuencode} program. For example, the output produced by the \program{uuencode} program. For example, the
string \code{'www.python.org'} is encoded as the string string \code{'www.python.org'} is encoded as the string
\code{'d3d3LnB5dGhvbi5vcmc=\e n'}. \code{'d3d3LnB5dGhvbi5vcmc=\e n'}.
...@@ -24,13 +27,13 @@ mimic the file object interface. \var{input} will be read until ...@@ -24,13 +27,13 @@ mimic the file object interface. \var{input} will be read until
\begin{funcdesc}{decodestring}{s} \begin{funcdesc}{decodestring}{s}
Decode the string \var{s}, which must contain one or more lines of Decode the string \var{s}, which must contain one or more lines of
base-64 encoded data, and return a string containing the resulting base64 encoded data, and return a string containing the resulting
binary data. binary data.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{encode}{input, output} \begin{funcdesc}{encode}{input, output}
Encode the contents of the \var{input} file and write the resulting Encode the contents of the \var{input} file and write the resulting
base-64 encoded data to the \var{output} file. base64 encoded data to the \var{output} file.
\var{input} and \var{output} must either be file objects or objects that \var{input} and \var{output} must either be file objects or objects that
mimic the file object interface. \var{input} will be read until mimic the file object interface. \var{input} will be read until
\code{\var{input}.read()} returns an empty string. \code{\var{input}.read()} returns an empty string.
...@@ -39,7 +42,5 @@ mimic the file object interface. \var{input} will be read until ...@@ -39,7 +42,5 @@ mimic the file object interface. \var{input} will be read until
\begin{funcdesc}{encodestring}{s} \begin{funcdesc}{encodestring}{s}
Encode the string \var{s}, which can contain arbitrary binary data, Encode the string \var{s}, which can contain arbitrary binary data,
and return a string containing one or more lines of and return a string containing one or more lines of
base-64 encoded data. base64 encoded data.
\end{funcdesc} \end{funcdesc}
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