Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
73a3c799
Commit
73a3c799
authored
Jan 22, 1998
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Converted to use new macros. This example demonstrate \method{} and, more
importantly, \url{}.
parent
4176b87a
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
34 additions
and
32 deletions
+34
-32
Doc/lib/libzlib.tex
Doc/lib/libzlib.tex
+17
-16
Doc/libzlib.tex
Doc/libzlib.tex
+17
-16
No files found.
Doc/lib/libzlib.tex
View file @
73a3c799
...
@@ -7,7 +7,7 @@
...
@@ -7,7 +7,7 @@
For applications that require data compression, the functions in this
For applications that require data compression, the functions in this
module allow compression and decompression, using the zlib library,
module allow compression and decompression, using the zlib library,
which is based on GNU zip. The zlib library has its own home page at
which is based on GNU zip. The zlib library has its own home page at
\
code
{
http://www.cdrom.com/pub/infozip/zlib/
}
.
\
url
{
http://www.cdrom.com/pub/infozip/zlib/
}
.
Version 1.0.4 is the most recent version as of December, 1997; use a
Version 1.0.4 is the most recent version as of December, 1997; use a
later version if one is available.
later version if one is available.
...
@@ -27,18 +27,19 @@ The available functions in this module are:
...
@@ -27,18 +27,19 @@ The available functions in this module are:
\begin{funcdesc}
{
compress
}{
string
\optional
{
\,
level
}}
\begin{funcdesc}
{
compress
}{
string
\optional
{
\,
level
}}
Compresses the data in
\var
{
string
}
, returning a string contained
Compresses the data in
\var
{
string
}
, returning a string contained
compressed data.
\var
{
level
}
is an integer from 1 to 9 controlling
compressed data.
\var
{
level
}
is an integer from
\code
{
1
}
to
\code
{
9
}
the level of compression; 1 is fastest and produces the least
controlling the level of compression;
\code
{
1
}
is fastest and produces
compression, 9 is slowest and produces the most. The default value is
the least compression,
\code
{
9
}
is slowest and produces the most. The
6. Raises the
\code
{
zlib.error
}
exception if any error occurs.
default value is
\code
{
6
}
. Raises the
\exception
{
zlib.error
}
exception if any error occurs.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
compressobj
}{
\optional
{
level
}}
\begin{funcdesc}
{
compressobj
}{
\optional
{
level
}}
Returns a compression object, to be used for compressing data streams
Returns a compression object, to be used for compressing data streams
that won't fit into memory at once.
\var
{
level
}
is an integer from
that won't fit into memory at once.
\var
{
level
}
is an integer from
1 to 9 controlling the level of compression; 1 is fastest and
\code
{
1
}
to
\code
{
9
}
controlling the level of compression;
\code
{
1
}
is
produces the least compression, 9 is slowest and produces the most.
fastest and produces the least compression,
\code
{
9
}
is slowest and
The default value is 6
.
produces the most. The default value is
\code
{
6
}
.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
crc32
}{
string
\optional
{
\,
value
}}
\begin{funcdesc}
{
crc32
}{
string
\optional
{
\,
value
}}
...
@@ -52,7 +53,7 @@ Returns a compression object, to be used for compressing data streams
...
@@ -52,7 +53,7 @@ Returns a compression object, to be used for compressing data streams
\begin{funcdesc}
{
decompress
}{
string
}
\begin{funcdesc}
{
decompress
}{
string
}
Decompresses the data in
\var
{
string
}
, returning a string containing
Decompresses the data in
\var
{
string
}
, returning a string containing
the uncompressed data. Raises the
\
code
{
zlib.error
}
exception if any
the uncompressed data. Raises the
\
exception
{
zlib.error
}
exception if any
error occurs.
error occurs.
\end{funcdesc}
\end{funcdesc}
...
@@ -69,14 +70,14 @@ Compression objects support the following methods:
...
@@ -69,14 +70,14 @@ Compression objects support the following methods:
Compress
\var
{
string
}
, returning a string containing compressed data
Compress
\var
{
string
}
, returning a string containing compressed data
for at least part of the data in
\var
{
string
}
. This data should be
for at least part of the data in
\var
{
string
}
. This data should be
concatenated to the output produced by any preceding calls to the
concatenated to the output produced by any preceding calls to the
\
code
{
compress()
}
method. Some input may be kept in internal buffers
\
method
{
compress()
}
method. Some input may be kept in internal buffers
for later processing.
for later processing.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
flush
}{}
\begin{funcdesc}
{
flush
}{}
All pending input is processed, and an string containing the remaining
All pending input is processed, and an string containing the remaining
compressed output is returned. After calling
\
code
{
flush()
}
, the
compressed output is returned. After calling
\
method
{
flush()
}
, the
\
code
{
compress()
}
method cannot be called again; the only realistic
\
method
{
compress()
}
method cannot be called again; the only realistic
action is to delete the object.
action is to delete the object.
\end{funcdesc}
\end{funcdesc}
...
@@ -87,14 +88,14 @@ Decompress \var{string}, returning a string containing the
...
@@ -87,14 +88,14 @@ Decompress \var{string}, returning a string containing the
uncompressed data corresponding to at least part of the data in
uncompressed data corresponding to at least part of the data in
\var
{
string
}
. This data should be concatenated to the output produced
\var
{
string
}
. This data should be concatenated to the output produced
by any preceding calls to the
by any preceding calls to the
\
code
{
decompress()
}
method. Some of the input data may be preserved
\
method
{
decompress()
}
method. Some of the input data may be preserved
in internal buffers for later processing.
in internal buffers for later processing.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
flush
}{}
\begin{funcdesc}
{
flush
}{}
All pending input is processed, and a string containing the remaining
All pending input is processed, and a string containing the remaining
uncompressed output is returned. After calling
\
code
{
flush()
}
, the
uncompressed output is returned. After calling
\
method
{
flush()
}
, the
\
code
{
decompress()
}
method cannot be called again; the only realistic
\
method
{
decompress()
}
method cannot be called again; the only realistic
action is to delete the object.
action is to delete the object.
\end{funcdesc}
\end{funcdesc}
...
...
Doc/libzlib.tex
View file @
73a3c799
...
@@ -7,7 +7,7 @@
...
@@ -7,7 +7,7 @@
For applications that require data compression, the functions in this
For applications that require data compression, the functions in this
module allow compression and decompression, using the zlib library,
module allow compression and decompression, using the zlib library,
which is based on GNU zip. The zlib library has its own home page at
which is based on GNU zip. The zlib library has its own home page at
\
code
{
http://www.cdrom.com/pub/infozip/zlib/
}
.
\
url
{
http://www.cdrom.com/pub/infozip/zlib/
}
.
Version 1.0.4 is the most recent version as of December, 1997; use a
Version 1.0.4 is the most recent version as of December, 1997; use a
later version if one is available.
later version if one is available.
...
@@ -27,18 +27,19 @@ The available functions in this module are:
...
@@ -27,18 +27,19 @@ The available functions in this module are:
\begin{funcdesc}
{
compress
}{
string
\optional
{
\,
level
}}
\begin{funcdesc}
{
compress
}{
string
\optional
{
\,
level
}}
Compresses the data in
\var
{
string
}
, returning a string contained
Compresses the data in
\var
{
string
}
, returning a string contained
compressed data.
\var
{
level
}
is an integer from 1 to 9 controlling
compressed data.
\var
{
level
}
is an integer from
\code
{
1
}
to
\code
{
9
}
the level of compression; 1 is fastest and produces the least
controlling the level of compression;
\code
{
1
}
is fastest and produces
compression, 9 is slowest and produces the most. The default value is
the least compression,
\code
{
9
}
is slowest and produces the most. The
6. Raises the
\code
{
zlib.error
}
exception if any error occurs.
default value is
\code
{
6
}
. Raises the
\exception
{
zlib.error
}
exception if any error occurs.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
compressobj
}{
\optional
{
level
}}
\begin{funcdesc}
{
compressobj
}{
\optional
{
level
}}
Returns a compression object, to be used for compressing data streams
Returns a compression object, to be used for compressing data streams
that won't fit into memory at once.
\var
{
level
}
is an integer from
that won't fit into memory at once.
\var
{
level
}
is an integer from
1 to 9 controlling the level of compression; 1 is fastest and
\code
{
1
}
to
\code
{
9
}
controlling the level of compression;
\code
{
1
}
is
produces the least compression, 9 is slowest and produces the most.
fastest and produces the least compression,
\code
{
9
}
is slowest and
The default value is 6
.
produces the most. The default value is
\code
{
6
}
.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
crc32
}{
string
\optional
{
\,
value
}}
\begin{funcdesc}
{
crc32
}{
string
\optional
{
\,
value
}}
...
@@ -52,7 +53,7 @@ Returns a compression object, to be used for compressing data streams
...
@@ -52,7 +53,7 @@ Returns a compression object, to be used for compressing data streams
\begin{funcdesc}
{
decompress
}{
string
}
\begin{funcdesc}
{
decompress
}{
string
}
Decompresses the data in
\var
{
string
}
, returning a string containing
Decompresses the data in
\var
{
string
}
, returning a string containing
the uncompressed data. Raises the
\
code
{
zlib.error
}
exception if any
the uncompressed data. Raises the
\
exception
{
zlib.error
}
exception if any
error occurs.
error occurs.
\end{funcdesc}
\end{funcdesc}
...
@@ -69,14 +70,14 @@ Compression objects support the following methods:
...
@@ -69,14 +70,14 @@ Compression objects support the following methods:
Compress
\var
{
string
}
, returning a string containing compressed data
Compress
\var
{
string
}
, returning a string containing compressed data
for at least part of the data in
\var
{
string
}
. This data should be
for at least part of the data in
\var
{
string
}
. This data should be
concatenated to the output produced by any preceding calls to the
concatenated to the output produced by any preceding calls to the
\
code
{
compress()
}
method. Some input may be kept in internal buffers
\
method
{
compress()
}
method. Some input may be kept in internal buffers
for later processing.
for later processing.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
flush
}{}
\begin{funcdesc}
{
flush
}{}
All pending input is processed, and an string containing the remaining
All pending input is processed, and an string containing the remaining
compressed output is returned. After calling
\
code
{
flush()
}
, the
compressed output is returned. After calling
\
method
{
flush()
}
, the
\
code
{
compress()
}
method cannot be called again; the only realistic
\
method
{
compress()
}
method cannot be called again; the only realistic
action is to delete the object.
action is to delete the object.
\end{funcdesc}
\end{funcdesc}
...
@@ -87,14 +88,14 @@ Decompress \var{string}, returning a string containing the
...
@@ -87,14 +88,14 @@ Decompress \var{string}, returning a string containing the
uncompressed data corresponding to at least part of the data in
uncompressed data corresponding to at least part of the data in
\var
{
string
}
. This data should be concatenated to the output produced
\var
{
string
}
. This data should be concatenated to the output produced
by any preceding calls to the
by any preceding calls to the
\
code
{
decompress()
}
method. Some of the input data may be preserved
\
method
{
decompress()
}
method. Some of the input data may be preserved
in internal buffers for later processing.
in internal buffers for later processing.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
flush
}{}
\begin{funcdesc}
{
flush
}{}
All pending input is processed, and a string containing the remaining
All pending input is processed, and a string containing the remaining
uncompressed output is returned. After calling
\
code
{
flush()
}
, the
uncompressed output is returned. After calling
\
method
{
flush()
}
, the
\
code
{
decompress()
}
method cannot be called again; the only realistic
\
method
{
decompress()
}
method cannot be called again; the only realistic
action is to delete the object.
action is to delete the object.
\end{funcdesc}
\end{funcdesc}
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment