summaryrefslogtreecommitdiff
path: root/sys/src/cmd/python/Doc/lib/libuu.tex
diff options
context:
space:
mode:
authorcinap_lenrek <cinap_lenrek@localhost>2011-05-03 11:25:13 +0000
committercinap_lenrek <cinap_lenrek@localhost>2011-05-03 11:25:13 +0000
commit458120dd40db6b4df55a4e96b650e16798ef06a0 (patch)
tree8f82685be24fef97e715c6f5ca4c68d34d5074ee /sys/src/cmd/python/Doc/lib/libuu.tex
parent3a742c699f6806c1145aea5149bf15de15a0afd7 (diff)
add hg and python
Diffstat (limited to 'sys/src/cmd/python/Doc/lib/libuu.tex')
-rw-r--r--sys/src/cmd/python/Doc/lib/libuu.tex58
1 files changed, 58 insertions, 0 deletions
diff --git a/sys/src/cmd/python/Doc/lib/libuu.tex b/sys/src/cmd/python/Doc/lib/libuu.tex
new file mode 100644
index 000000000..7e546a0d4
--- /dev/null
+++ b/sys/src/cmd/python/Doc/lib/libuu.tex
@@ -0,0 +1,58 @@
+\section{\module{uu} ---
+ Encode and decode uuencode files}
+
+\declaremodule{standard}{uu}
+\modulesynopsis{Encode and decode files in uuencode format.}
+\moduleauthor{Lance Ellinghouse}{}
+
+
+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.
+
+This code was contributed by Lance Ellinghouse, and modified by Jack
+Jansen.
+\index{Jansen, Jack}
+\index{Ellinghouse, Lance}
+
+The \module{uu} module defines the following functions:
+
+\begin{funcdesc}{encode}{in_file, out_file\optional{, name\optional{, 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\optional{, mode\optional{, quiet}}}}
+ This call decodes uuencoded file \var{in_file} placing the result on
+ file \var{out_file}. If \var{out_file} is a pathname, \var{mode} is
+ used to set the permission bits if the file must be
+ created. Defaults for \var{out_file} and \var{mode} are taken from
+ the uuencode header. However, if the file specified in the header
+ already exists, a \exception{uu.Error} is raised.
+
+ \function{decode()} may print a warning to standard error if the
+ input was produced by an incorrect uuencoder and Python could
+ recover from that error. Setting \var{quiet} to a true value
+ silences this warning.
+\end{funcdesc}
+
+\begin{excclassdesc}{Error}{}
+ Subclass of \exception{Exception}, this can be raised by
+ \function{uu.decode()} under various situations, such as described
+ above, but also including a badly formatted header, or truncated
+ input file.
+\end{excclassdesc}
+
+\begin{seealso}
+ \seemodule{binascii}{Support module containing \ASCII-to-binary
+ and binary-to-\ASCII{} conversions.}
+\end{seealso}