summaryrefslogtreecommitdiff
path: root/zlib.3
diff options
context:
space:
mode:
Diffstat (limited to 'zlib.3')
-rw-r--r--zlib.363
1 files changed, 28 insertions, 35 deletions
diff --git a/zlib.3 b/zlib.3
index 82b9eca..57f0307 100644
--- a/zlib.3
+++ b/zlib.3
@@ -1,4 +1,4 @@
1.TH ZLIB 3 "21 February 2010" 1.TH ZLIB 3 "11 March 2010"
2.SH NAME 2.SH NAME
3zlib \- compression/decompression library 3zlib \- compression/decompression library
4.SH SYNOPSIS 4.SH SYNOPSIS
@@ -9,12 +9,13 @@ for full description]
9The 9The
10.I zlib 10.I zlib
11library is a general purpose data compression library. 11library is a general purpose data compression library.
12The code is thread safe. 12The code is thread safe, assuming that the standard library functions
13used are thread safe, such as memory allocation routines.
13It provides in-memory compression and decompression functions, 14It provides in-memory compression and decompression functions,
14including integrity checks of the uncompressed data. 15including integrity checks of the uncompressed data.
15This version of the library supports only one compression method (deflation) 16This version of the library supports only one compression method (deflation)
16but other algorithms will be added later 17but other algorithms may be added later
17and will have the same stream interface. 18with the same stream interface.
18.LP 19.LP
19Compression can be done in a single step if the buffers are large enough 20Compression can be done in a single step if the buffers are large enough
20or can be done by repeated calls of the compression function. 21or can be done by repeated calls of the compression function.
@@ -29,7 +30,7 @@ with an interface similar to that of stdio.
29.LP 30.LP
30The library does not install any signal handler. 31The library does not install any signal handler.
31The decoder checks the consistency of the compressed data, 32The decoder checks the consistency of the compressed data,
32so the library should never crash even in case of corrupted input. 33so the library should never crash even in the case of corrupted input.
33.LP 34.LP
34All functions of the compression library are documented in the file 35All functions of the compression library are documented in the file
35.IR zlib.h . 36.IR zlib.h .
@@ -37,18 +38,19 @@ The distribution source includes examples of use of the library
37in the files 38in the files
38.I example.c 39.I example.c
39and 40and
40.IR minigzip.c . 41.IR minigzip.c,
42as well as other examples in the
43.IR examples/
44directory.
41.LP 45.LP
42Changes to this version are documented in the file 46Changes to this version are documented in the file
43.I ChangeLog 47.I ChangeLog
44that accompanies the source, 48that accompanies the source.
45and are concerned primarily with bug fixes and portability enhancements.
46.LP 49.LP
47A Java implementation of
48.I zlib 50.I zlib
49is available in the Java Development Kit 1.1: 51is available in Java using the java.util.zip package:
50.IP 52.IP
51http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html 53http://java.sun.com/developer/technicalArticles/Programming/compression/
52.LP 54.LP
53A Perl interface to 55A Perl interface to
54.IR zlib , 56.IR zlib ,
@@ -56,7 +58,7 @@ written by Paul Marquess (pmqs@cpan.org),
56is available at CPAN (Comprehensive Perl Archive Network) sites, 58is available at CPAN (Comprehensive Perl Archive Network) sites,
57including: 59including:
58.IP 60.IP
59http://www.cpan.org/modules/by-module/Compress/ 61http://search.cpan.org/~pmqs/IO-Compress-Zlib/
60.LP 62.LP
61A Python interface to 63A Python interface to
62.IR zlib , 64.IR zlib ,
@@ -65,14 +67,11 @@ is available in Python 1.5 and later versions:
65.IP 67.IP
66http://www.python.org/doc/lib/module-zlib.html 68http://www.python.org/doc/lib/module-zlib.html
67.LP 69.LP
68A
69.I zlib 70.I zlib
70binding for 71is built into
71.IR tcl (1), 72.IR tcl:
72written by Andreas Kupries (a.kupries@westend.com),
73is availlable at:
74.IP 73.IP
75http://www.westend.com/~kupries/doc/trf/man/man.html 74http://wiki.tcl.tk/4610
76.LP 75.LP
77An experimental package to read and write files in .zip format, 76An experimental package to read and write files in .zip format,
78written on top of 77written on top of
@@ -80,40 +79,34 @@ written on top of
80by Gilles Vollant (info@winimage.com), 79by Gilles Vollant (info@winimage.com),
81is available at: 80is available at:
82.IP 81.IP
83http://www.winimage.com/zLibDll/unzip.html 82http://www.winimage.com/zLibDll/minizip.html
84and also in the 83and also in the
85.I contrib/minizip 84.I contrib/minizip
86directory of the main 85directory of the main
87.I zlib 86.I zlib
88web site. 87source distribution.
89.SH "SEE ALSO" 88.SH "SEE ALSO"
90The 89The
91.I zlib 90.I zlib
92web site can be found at either of these locations: 91web site can be found at:
93.IP 92.IP
94http://www.zlib.org 93http://zlib.net/
95.br
96http://www.gzip.org/zlib/
97.LP 94.LP
98The data format used by the zlib library is described by RFC 95The data format used by the zlib library is described by RFC
99(Request for Comments) 1950 to 1952 in the files: 96(Request for Comments) 1950 to 1952 in the files:
100.IP 97.IP
101http://www.ietf.org/rfc/rfc1950.txt (concerning zlib format) 98http://www.ietf.org/rfc/rfc1950.txt (for the zlib header and trailer format)
102.br 99.br
103http://www.ietf.org/rfc/rfc1951.txt (concerning deflate format) 100http://www.ietf.org/rfc/rfc1951.txt (for the deflate compressed data format)
104.br 101.br
105http://www.ietf.org/rfc/rfc1952.txt (concerning gzip format) 102http://www.ietf.org/rfc/rfc1952.txt (for the gzip header and trailer format)
106.LP
107These documents are also available in other formats from:
108.IP
109ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
110.LP 103.LP
111Mark Nelson (markn@ieee.org) wrote an article about 104Mark Nelson wrote an article about
112.I zlib 105.I zlib
113for the Jan. 1997 issue of Dr. Dobb's Journal; 106for the Jan. 1997 issue of Dr. Dobb's Journal;
114a copy of the article is available at: 107a copy of the article is available at:
115.IP 108.IP
116http://dogma.net/markn/articles/zlibtool/zlibtool.htm 109http://marknelson.us/1997/01/01/zlib-engine/
117.SH "REPORTING PROBLEMS" 110.SH "REPORTING PROBLEMS"
118Before reporting a problem, 111Before reporting a problem,
119please check the 112please check the
@@ -126,13 +119,13 @@ Please read the
126.I zlib 119.I zlib
127FAQ at: 120FAQ at:
128.IP 121.IP
129http://www.gzip.org/zlib/zlib_faq.html 122http://zlib.net/zlib_faq.html
130.LP 123.LP
131before asking for help. 124before asking for help.
132Send questions and/or comments to zlib@gzip.org, 125Send questions and/or comments to zlib@gzip.org,
133or (for the Windows DLL version) to Gilles Vollant (info@winimage.com). 126or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
134.SH AUTHORS 127.SH AUTHORS
135Version 1.2.3.9 128Version 1.2.4
136Copyright (C) 1995-2010 Jean-loup Gailly (jloup@gzip.org) 129Copyright (C) 1995-2010 Jean-loup Gailly (jloup@gzip.org)
137and Mark Adler (madler@alumni.caltech.edu). 130and Mark Adler (madler@alumni.caltech.edu).
138.LP 131.LP