michael@0: ZLIB DATA COMPRESSION LIBRARY michael@0: michael@0: zlib 1.2.8 is a general purpose data compression library. All the code is michael@0: thread safe. The data format used by the zlib library is described by RFCs michael@0: (Request for Comments) 1950 to 1952 in the files michael@0: http://tools.ietf.org/html/rfc1950 (zlib format), rfc1951 (deflate format) and michael@0: rfc1952 (gzip format). michael@0: michael@0: All functions of the compression library are documented in the file zlib.h michael@0: (volunteer to write man pages welcome, contact zlib@gzip.org). A usage example michael@0: of the library is given in the file test/example.c which also tests that michael@0: the library is working correctly. Another example is given in the file michael@0: test/minigzip.c. The compression library itself is composed of all source michael@0: files in the root directory. michael@0: michael@0: To compile all files and run the test program, follow the instructions given at michael@0: the top of Makefile.in. In short "./configure; make test", and if that goes michael@0: well, "make install" should work for most flavors of Unix. For Windows, use michael@0: one of the special makefiles in win32/ or contrib/vstudio/ . For VMS, use michael@0: make_vms.com. michael@0: michael@0: Questions about zlib should be sent to , or to Gilles Vollant michael@0: for the Windows DLL version. The zlib home page is michael@0: http://zlib.net/ . Before reporting a problem, please check this site to michael@0: verify that you have the latest version of zlib; otherwise get the latest michael@0: version and check whether the problem still exists or not. michael@0: michael@0: PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help. michael@0: michael@0: Mark Nelson wrote an article about zlib for the Jan. 1997 michael@0: issue of Dr. Dobb's Journal; a copy of the article is available at michael@0: http://marknelson.us/1997/01/01/zlib-engine/ . michael@0: michael@0: The changes made in version 1.2.8 are documented in the file ChangeLog. michael@0: michael@0: Unsupported third party contributions are provided in directory contrib/ . michael@0: michael@0: zlib is available in Java using the java.util.zip package, documented at michael@0: http://java.sun.com/developer/technicalArticles/Programming/compression/ . michael@0: michael@0: A Perl interface to zlib written by Paul Marquess is available michael@0: at CPAN (Comprehensive Perl Archive Network) sites, including michael@0: http://search.cpan.org/~pmqs/IO-Compress-Zlib/ . michael@0: michael@0: A Python interface to zlib written by A.M. Kuchling is michael@0: available in Python 1.5 and later versions, see michael@0: http://docs.python.org/library/zlib.html . michael@0: michael@0: zlib is built into tcl: http://wiki.tcl.tk/4610 . michael@0: michael@0: An experimental package to read and write files in .zip format, written on top michael@0: of zlib by Gilles Vollant , is available in the michael@0: contrib/minizip directory of zlib. michael@0: michael@0: michael@0: Notes for some targets: michael@0: michael@0: - For Windows DLL versions, please see win32/DLL_FAQ.txt michael@0: michael@0: - For 64-bit Irix, deflate.c must be compiled without any optimization. With michael@0: -O, one libpng test fails. The test works in 32 bit mode (with the -n32 michael@0: compiler flag). The compiler bug has been reported to SGI. michael@0: michael@0: - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works michael@0: when compiled with cc. michael@0: michael@0: - On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is michael@0: necessary to get gzprintf working correctly. This is done by configure. michael@0: michael@0: - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with michael@0: other compilers. Use "make test" to check your compiler. michael@0: michael@0: - gzdopen is not supported on RISCOS or BEOS. michael@0: michael@0: - For PalmOs, see http://palmzlib.sourceforge.net/ michael@0: michael@0: michael@0: Acknowledgments: michael@0: michael@0: The deflate format used by zlib was defined by Phil Katz. The deflate and michael@0: zlib specifications were written by L. Peter Deutsch. Thanks to all the michael@0: people who reported problems and suggested various improvements in zlib; they michael@0: are too numerous to cite here. michael@0: michael@0: Copyright notice: michael@0: michael@0: (C) 1995-2013 Jean-loup Gailly and Mark Adler michael@0: michael@0: This software is provided 'as-is', without any express or implied michael@0: warranty. In no event will the authors be held liable for any damages michael@0: arising from the use of this software. michael@0: michael@0: Permission is granted to anyone to use this software for any purpose, michael@0: including commercial applications, and to alter it and redistribute it michael@0: freely, subject to the following restrictions: michael@0: michael@0: 1. The origin of this software must not be misrepresented; you must not michael@0: claim that you wrote the original software. If you use this software michael@0: in a product, an acknowledgment in the product documentation would be michael@0: appreciated but is not required. michael@0: 2. Altered source versions must be plainly marked as such, and must not be michael@0: misrepresented as being the original software. michael@0: 3. This notice may not be removed or altered from any source distribution. michael@0: michael@0: Jean-loup Gailly Mark Adler michael@0: jloup@gzip.org madler@alumni.caltech.edu michael@0: michael@0: If you use the zlib library in a product, we would appreciate *not* receiving michael@0: lengthy legal documents to sign. The sources are provided for free but without michael@0: warranty of any kind. The library has been entirely written by Jean-loup michael@0: Gailly and Mark Adler; it does not include third-party code. michael@0: michael@0: If you redistribute modified sources, we would appreciate that you include in michael@0: the file ChangeLog history information documenting your changes. Please read michael@0: the FAQ for more information on the distribution of modified source versions.