| 1 | .TH ZLIB 3 "18 July 2005"
|
|---|
| 2 | .SH NAME
|
|---|
| 3 | zlib \- compression/decompression library
|
|---|
| 4 | .SH SYNOPSIS
|
|---|
| 5 | [see
|
|---|
| 6 | .I zlib.h
|
|---|
| 7 | for full description]
|
|---|
| 8 | .SH DESCRIPTION
|
|---|
| 9 | The
|
|---|
| 10 | .I zlib
|
|---|
| 11 | library is a general purpose data compression library.
|
|---|
| 12 | The code is thread safe.
|
|---|
| 13 | It provides in-memory compression and decompression functions,
|
|---|
| 14 | including integrity checks of the uncompressed data.
|
|---|
| 15 | This version of the library supports only one compression method (deflation)
|
|---|
| 16 | but other algorithms will be added later
|
|---|
| 17 | and will have the same stream interface.
|
|---|
| 18 | .LP
|
|---|
| 19 | Compression can be done in a single step if the buffers are large enough
|
|---|
| 20 | (for example if an input file is mmap'ed),
|
|---|
| 21 | or can be done by repeated calls of the compression function.
|
|---|
| 22 | In the latter case,
|
|---|
| 23 | the application must provide more input and/or consume the output
|
|---|
| 24 | (providing more output space) before each call.
|
|---|
| 25 | .LP
|
|---|
| 26 | The library also supports reading and writing files in
|
|---|
| 27 | .IR gzip (1)
|
|---|
| 28 | (.gz) format
|
|---|
| 29 | with an interface similar to that of stdio.
|
|---|
| 30 | .LP
|
|---|
| 31 | The library does not install any signal handler.
|
|---|
| 32 | The decoder checks the consistency of the compressed data,
|
|---|
|
|---|
