summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libbinhex.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/lib/libbinhex.tex')
-rw-r--r--Doc/lib/libbinhex.tex37
1 files changed, 37 insertions, 0 deletions
diff --git a/Doc/lib/libbinhex.tex b/Doc/lib/libbinhex.tex
new file mode 100644
index 0000000..aae5074
--- /dev/null
+++ b/Doc/lib/libbinhex.tex
@@ -0,0 +1,37 @@
+\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.