]> git.saurik.com Git - wxWidgets.git/blame - src/zlib/zlib.3
fix should have been mac only
[wxWidgets.git] / src / zlib / zlib.3
CommitLineData
41faf807 1.TH ZLIB 3 "18 July 2005"
c801d85f
KB
2.SH NAME
3zlib \- compression/decompression library
4.SH SYNOPSIS
5[see
6.I zlib.h
7for full description]
8.SH DESCRIPTION
9The
10.I zlib
11library is a general purpose data compression library.
12The code is thread safe.
13It provides in-memory compression and decompression functions,
14including integrity checks of the uncompressed data.
15This version of the library supports only one compression method (deflation)
51dbdf87
VS
16but other algorithms will be added later
17and will have the same stream interface.
c801d85f
KB
18.LP
19Compression can be done in a single step if the buffers are large enough
20(for example if an input file is mmap'ed),
21or can be done by repeated calls of the compression function.
22In the latter case,
23the application must provide more input and/or consume the output
24(providing more output space) before each call.
25.LP
26The library also supports reading and writing files in
51dbdf87 27.IR gzip (1)
c801d85f
KB
28(.gz) format
29with an interface similar to that of stdio.
30.LP
51dbdf87
VS
31The library does not install any signal handler.
32The decoder checks the consistency of the compressed data,
33so the library should never crash even in case of corrupted input.
c801d85f
KB
34.LP
35All functions of the compression library are documented in the file
51dbdf87 36.IR zlib.h .
c801d85f 37The distribution source includes examples of use of the library
51dbdf87 38in the files
c801d85f
KB
39.I example.c
40and
41.IR minigzip.c .
42.LP
51dbdf87
VS
43Changes to this version are documented in the file
44.I ChangeLog
45that accompanies the source,
46and are concerned primarily with bug fixes and portability enhancements.
47.LP
c801d85f 48A Java implementation of
51dbdf87
VS
49.I zlib
50is available in the Java Development Kit 1.1:
c801d85f
KB
51.IP
52http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
53.LP
54A Perl interface to
55.IR zlib ,
51dbdf87 56written by Paul Marquess (pmqs@cpan.org),
c801d85f 57is available at CPAN (Comprehensive Perl Archive Network) sites,
51dbdf87 58including:
c801d85f 59.IP
51dbdf87 60http://www.cpan.org/modules/by-module/Compress/
c801d85f
KB
61.LP
62A Python interface to
51dbdf87
VS
63.IR zlib ,
64written by A.M. Kuchling (amk@magnet.com),
65is available in Python 1.5 and later versions:
c801d85f 66.IP
51dbdf87
VS
67http://www.python.org/doc/lib/module-zlib.html
68.LP
69A
70.I zlib
71binding for
72.IR tcl (1),
73written by Andreas Kupries (a.kupries@westend.com),
74is availlable at:
c801d85f 75.IP
51dbdf87
VS
76http://www.westend.com/~kupries/doc/trf/man/man.html
77.LP
78An experimental package to read and write files in .zip format,
79written on top of
80.I zlib
81by Gilles Vollant (info@winimage.com),
82is available at:
83.IP
84http://www.winimage.com/zLibDll/unzip.html
85and also in the
86.I contrib/minizip
87directory of the main
88.I zlib
89web site.
90.SH "SEE ALSO"
91The
92.I zlib
93web site can be found at either of these locations:
c801d85f 94.IP
51dbdf87
VS
95http://www.zlib.org
96.br
97http://www.gzip.org/zlib/
c801d85f
KB
98.LP
99The data format used by the zlib library is described by RFC
51dbdf87 100(Request for Comments) 1950 to 1952 in the files:
c801d85f 101.IP
51dbdf87 102http://www.ietf.org/rfc/rfc1950.txt (concerning zlib format)
c801d85f 103.br
51dbdf87 104http://www.ietf.org/rfc/rfc1951.txt (concerning deflate format)
c801d85f 105.br
51dbdf87 106http://www.ietf.org/rfc/rfc1952.txt (concerning gzip format)
c801d85f
KB
107.LP
108These documents are also available in other formats from:
109.IP
110ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
51dbdf87
VS
111.LP
112Mark Nelson (markn@ieee.org) wrote an article about
113.I zlib
114for the Jan. 1997 issue of Dr. Dobb's Journal;
115a copy of the article is available at:
116.IP
117http://dogma.net/markn/articles/zlibtool/zlibtool.htm
118.SH "REPORTING PROBLEMS"
119Before reporting a problem,
120please check the
121.I zlib
122web site to verify that you have the latest version of
123.IR zlib ;
124otherwise,
125obtain the latest version and see if the problem still exists.
126Please read the
127.I zlib
128FAQ at:
129.IP
130http://www.gzip.org/zlib/zlib_faq.html
131.LP
132before asking for help.
133Send questions and/or comments to zlib@gzip.org,
134or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
c801d85f 135.SH AUTHORS
41faf807
MW
136Version 1.2.3
137Copyright (C) 1995-2005 Jean-loup Gailly (jloup@gzip.org)
c801d85f
KB
138and Mark Adler (madler@alumni.caltech.edu).
139.LP
140This software is provided "as-is,"
141without any express or implied warranty.
142In no event will the authors be held liable for any damages
143arising from the use of this software.
144See the distribution directory with respect to requirements
145governing redistribution.
146The deflate format used by
147.I zlib
148was defined by Phil Katz.
149The deflate and
150.I zlib
151specifications were written by L. Peter Deutsch.
152Thanks to all the people who reported problems and suggested various
153improvements in
154.IR zlib ;
155who are too numerous to cite here.
156.LP
157UNIX manual page by R. P. C. Rodgers,
158U.S. National Library of Medicine (rodgers@nlm.nih.gov).
159.\" end of man page