diff options
Diffstat (limited to 'Doc/libbinascii.tex')
| -rw-r--r-- | Doc/libbinascii.tex | 76 |
1 files changed, 2 insertions, 74 deletions
diff --git a/Doc/libbinascii.tex b/Doc/libbinascii.tex index 669d2bb..75e1498 100644 --- a/Doc/libbinascii.tex +++ b/Doc/libbinascii.tex @@ -1,77 +1,5 @@ -\section{Standard Module \sectcode{binhex}} -\label{module-binhex} -\stmodindex{binhex} - -This module encodes and decodes files in binhex4 format, a format -allowing representation of Macintosh files in ASCII. On the macintosh, -both forks of a file and the finder information are encoded (or -decoded), on other platforms only the data fork is handled. - -The \code{binhex} module defines the following functions: - -\setindexsubitem{(in module binhex)} - -\begin{funcdesc}{binhex}{input\, output} -Convert a binary file with filename \var{input} to binhex file -\var{output}. The \var{output} parameter can either be a filename or a -file-like object (any object supporting a \var{write} and \var{close} -method). -\end{funcdesc} - -\begin{funcdesc}{hexbin}{input\optional{\, output}} -Decode a binhex file \var{input}. \var{input} may be a filename or a -file-like object supporting \var{read} and \var{close} methods. -The resulting file is written to a file named \var{output}, unless the -argument is empty in which case the output filename is read from the -binhex file. -\end{funcdesc} - -\subsection{Notes} -There is an alternative, more powerful interface to the coder and -decoder, see the source for details. - -If you code or decode textfiles on non-Macintosh platforms they will -still use the macintosh newline convention (carriage-return as end of -line). - -As of this writing, \var{hexbin} appears to not work in all cases. - -\section{Standard Module \sectcode{uu}} -\stmodindex{uu} - -This module encodes and decodes files in uuencode format, allowing -arbitrary binary data to be transferred over ascii-only connections. -Wherever a file argument is expected, the methods accept a file-like -object. For backwards compatibility, a string containing a pathname -is also accepted, and the corresponding file will be opened for -reading and writing; the pathname \code{'-'} is understood to mean the -standard input or output. However, this interface is deprecated; it's -better for the caller to open the file itself, and be sure that, when -required, the mode is \code{'rb'} or \code{'wb'} on Windows or DOS. - -This code was contributed by Lance Ellinghouse, and modified by Jack -Jansen. - -The \code{uu} module defines the following functions: - -\setindexsubitem{(in module uu)} - -\begin{funcdesc}{encode}{in_file\, out_file\optional{\, name\, mode}} -Uuencode file \var{in_file} into file \var{out_file}. The uuencoded -file will have the header specifying \var{name} and \var{mode} as the -defaults for the results of decoding the file. The default defaults -are taken from \var{in_file}, or \code{'-'} and \code{0666} -respectively. -\end{funcdesc} - -\begin{funcdesc}{decode}{in_file\optional{\, out_file\, mode}} -This call decodes uuencoded file \var{in_file} placing the result on -file \var{out_file}. If \var{out_file} is a pathname the \var{mode} is -also set. Defaults for \var{out_file} and \var{mode} are taken from -the uuencode header. -\end{funcdesc} - -\section{Built-in Module \sectcode{binascii}} % If implemented in C +\section{Built-in Module \sectcode{binascii}} +\label{module-binascii} \bimodindex{binascii} The binascii module contains a number of methods to convert between |