diff options
author | Fred Drake <fdrake@acm.org> | 1998-06-19 21:18:28 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 1998-06-19 21:18:28 (GMT) |
commit | 59160706b327445cf88b72a66ba7ebc57abb1b29 (patch) | |
tree | ecff65fe85d30cffd10eeb45906381a2b91f35cc | |
parent | 251c9fc60a7dafb7992410db53aa181cabbb34c9 (diff) | |
download | cpython-59160706b327445cf88b72a66ba7ebc57abb1b29.zip cpython-59160706b327445cf88b72a66ba7ebc57abb1b29.tar.gz cpython-59160706b327445cf88b72a66ba7ebc57abb1b29.tar.bz2 |
Somewhat updated, but not checked for everything (just the stuff I was using).
-rw-r--r-- | Doc/lib/libzlib.tex | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/Doc/lib/libzlib.tex b/Doc/lib/libzlib.tex index f38a21c..3838c86 100644 --- a/Doc/lib/libzlib.tex +++ b/Doc/lib/libzlib.tex @@ -31,12 +31,12 @@ The available exception and functions in this module are: \end{funcdesc} \begin{funcdesc}{compress}{string\optional{, level}} -Compresses the data in \var{string}, returning a string contained -compressed data. \var{level} is an integer from \code{1} to \code{9} -controlling the level of compression; \code{1} is fastest and produces -the least compression, \code{9} is slowest and produces the most. The -default value is \code{6}. Raises the \exception{error} -exception if any error occurs. + Compresses the data in \var{string}, returning a string contained + compressed data. \var{level} is an integer from \code{1} to + \code{9} controlling the level of compression; \code{1} is fastest + and produces the least compression, \code{9} is slowest and produces + the most. The default value is \code{6}. Raises the + \exception{error} exception if any error occurs. \end{funcdesc} \begin{funcdesc}{compressobj}{\optional{level}} @@ -59,17 +59,18 @@ exception if any error occurs. should not be used for authentication or digital signatures. \end{funcdesc} -\begin{funcdesc}{decompress}{string} -Decompresses the data in \var{string}, returning a string containing -the uncompressed data. Raises the \exception{error} exception if any -error occurs. +\begin{funcdesc}{decompress}{string\optional{, wbits\optional{, buffsize}}} + Decompresses the data in \var{string}, returning a string containing + the uncompressed data. The \var{wbits} parameter controls the size of + the window buffer. If \var{buffsize} is given, it is used as the + initial size of the output buffer. Raises the \exception{error} + exception if any error occurs. \end{funcdesc} \begin{funcdesc}{decompressobj}{\optional{wbits}} -Returns a compression object, to be used for decompressing data streams -that won't fit into memory at once. The \var{wbits} parameter -controls the size of the window buffer; usually this can be left -alone. + Returns a compression object, to be used for decompressing data + streams that won't fit into memory at once. The \var{wbits} + parameter controls the size of the window buffer. \end{funcdesc} Compression objects support the following methods: |