Chris@43: .TH ZLIB 3 "28 Apr 2013"
Chris@43: .SH NAME
Chris@43: zlib \- compression/decompression library
Chris@43: .SH SYNOPSIS
Chris@43: [see
Chris@43: .I zlib.h
Chris@43: for full description]
Chris@43: .SH DESCRIPTION
Chris@43: The
Chris@43: .I zlib
Chris@43: library is a general purpose data compression library.
Chris@43: The code is thread safe, assuming that the standard library functions
Chris@43: used are thread safe, such as memory allocation routines.
Chris@43: It provides in-memory compression and decompression functions,
Chris@43: including integrity checks of the uncompressed data.
Chris@43: This version of the library supports only one compression method (deflation)
Chris@43: but other algorithms may be added later
Chris@43: with the same stream interface.
Chris@43: .LP
Chris@43: Compression can be done in a single step if the buffers are large enough
Chris@43: or can be done by repeated calls of the compression function.
Chris@43: In the latter case,
Chris@43: the application must provide more input and/or consume the output
Chris@43: (providing more output space) before each call.
Chris@43: .LP
Chris@43: The library also supports reading and writing files in
Chris@43: .IR gzip (1)
Chris@43: (.gz) format
Chris@43: with an interface similar to that of stdio.
Chris@43: .LP
Chris@43: The library does not install any signal handler.
Chris@43: The decoder checks the consistency of the compressed data,
Chris@43: so the library should never crash even in the case of corrupted input.
Chris@43: .LP
Chris@43: All functions of the compression library are documented in the file
Chris@43: .IR zlib.h .
Chris@43: The distribution source includes examples of use of the library
Chris@43: in the files
Chris@43: .I test/example.c
Chris@43: and
Chris@43: .IR test/minigzip.c,
Chris@43: as well as other examples in the
Chris@43: .IR examples/
Chris@43: directory.
Chris@43: .LP
Chris@43: Changes to this version are documented in the file
Chris@43: .I ChangeLog
Chris@43: that accompanies the source.
Chris@43: .LP
Chris@43: .I zlib
Chris@43: is available in Java using the java.util.zip package:
Chris@43: .IP
Chris@43: http://java.sun.com/developer/technicalArticles/Programming/compression/
Chris@43: .LP
Chris@43: A Perl interface to
Chris@43: .IR zlib ,
Chris@43: written by Paul Marquess (pmqs@cpan.org),
Chris@43: is available at CPAN (Comprehensive Perl Archive Network) sites,
Chris@43: including:
Chris@43: .IP
Chris@43: http://search.cpan.org/~pmqs/IO-Compress-Zlib/
Chris@43: .LP
Chris@43: A Python interface to
Chris@43: .IR zlib ,
Chris@43: written by A.M. Kuchling (amk@magnet.com),
Chris@43: is available in Python 1.5 and later versions:
Chris@43: .IP
Chris@43: http://docs.python.org/library/zlib.html
Chris@43: .LP
Chris@43: .I zlib
Chris@43: is built into
Chris@43: .IR tcl:
Chris@43: .IP
Chris@43: http://wiki.tcl.tk/4610
Chris@43: .LP
Chris@43: An experimental package to read and write files in .zip format,
Chris@43: written on top of
Chris@43: .I zlib
Chris@43: by Gilles Vollant (info@winimage.com),
Chris@43: is available at:
Chris@43: .IP
Chris@43: http://www.winimage.com/zLibDll/minizip.html
Chris@43: and also in the
Chris@43: .I contrib/minizip
Chris@43: directory of the main
Chris@43: .I zlib
Chris@43: source distribution.
Chris@43: .SH "SEE ALSO"
Chris@43: The
Chris@43: .I zlib
Chris@43: web site can be found at:
Chris@43: .IP
Chris@43: http://zlib.net/
Chris@43: .LP
Chris@43: The data format used by the zlib library is described by RFC
Chris@43: (Request for Comments) 1950 to 1952 in the files:
Chris@43: .IP
Chris@43: http://tools.ietf.org/html/rfc1950 (for the zlib header and trailer format)
Chris@43: .br
Chris@43: http://tools.ietf.org/html/rfc1951 (for the deflate compressed data format)
Chris@43: .br
Chris@43: http://tools.ietf.org/html/rfc1952 (for the gzip header and trailer format)
Chris@43: .LP
Chris@43: Mark Nelson wrote an article about
Chris@43: .I zlib
Chris@43: for the Jan. 1997 issue of  Dr. Dobb's Journal;
Chris@43: a copy of the article is available at:
Chris@43: .IP
Chris@43: http://marknelson.us/1997/01/01/zlib-engine/
Chris@43: .SH "REPORTING PROBLEMS"
Chris@43: Before reporting a problem,
Chris@43: please check the
Chris@43: .I zlib
Chris@43: web site to verify that you have the latest version of
Chris@43: .IR zlib ;
Chris@43: otherwise,
Chris@43: obtain the latest version and see if the problem still exists.
Chris@43: Please read the
Chris@43: .I zlib
Chris@43: FAQ at:
Chris@43: .IP
Chris@43: http://zlib.net/zlib_faq.html
Chris@43: .LP
Chris@43: before asking for help.
Chris@43: Send questions and/or comments to zlib@gzip.org,
Chris@43: or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
Chris@43: .SH AUTHORS
Chris@43: Version 1.2.8
Chris@43: Copyright (C) 1995-2013 Jean-loup Gailly (jloup@gzip.org)
Chris@43: and Mark Adler (madler@alumni.caltech.edu).
Chris@43: .LP
Chris@43: This software is provided "as-is,"
Chris@43: without any express or implied warranty.
Chris@43: In no event will the authors be held liable for any damages
Chris@43: arising from the use of this software.
Chris@43: See the distribution directory with respect to requirements
Chris@43: governing redistribution.
Chris@43: The deflate format used by
Chris@43: .I zlib
Chris@43: was defined by Phil Katz.
Chris@43: The deflate and
Chris@43: .I zlib
Chris@43: specifications were written by L. Peter Deutsch.
Chris@43: Thanks to all the people who reported problems and suggested various
Chris@43: improvements in
Chris@43: .IR zlib ;
Chris@43: who are too numerous to cite here.
Chris@43: .LP
Chris@43: UNIX manual page by R. P. C. Rodgers,
Chris@43: U.S. National Library of Medicine (rodgers@nlm.nih.gov).
Chris@43: .\" end of man page