README revision 206708
11195SrgrimesZLIB DATA COMPRESSION LIBRARY 211840Sjulian 337Srgrimeszlib 1.2.4.3 is a general purpose data compression library. All the code is 437Srgrimesthread safe. The data format used by the zlib library is described by RFCs 537Srgrimes(Request for Comments) 1950 to 1952 in the files 6147Srgrimeshttp://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format) 7147Srgrimesand rfc1952.txt (gzip format). 85356Sache 93017SrgrimesAll functions of the compression library are documented in the file zlib.h 107526Sjkh(volunteer to write man pages welcome, contact zlib@gzip.org). A usage example 1111408Sphkof the library is given in the file example.c which also tests that the library 127487Srgrimesis working correctly. Another example is given in the file minigzip.c. The 137487Srgrimescompression library itself is composed of all source files except example.c and 145356Sacheminigzip.c. 151734Sjkh 161734SjkhTo compile all files and run the test program, follow the instructions given at 1737Srgrimesthe top of Makefile.in. In short "./configure; make test", and if that goes 1837Srgrimeswell, "make install" should work for most flavors of Unix. For Windows, use one 1937Srgrimesof the special makefiles in win32/ or contrib/vstudio/ . For VMS, use 2037Srgrimesmake_vms.com. 211773Sjkh 22147SrgrimesQuestions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant 23147Srgrimes<info@winimage.com> for the Windows DLL version. The zlib home page is 242779Srgrimeshttp://zlib.net/ . Before reporting a problem, please check this site to 252779Srgrimesverify that you have the latest version of zlib; otherwise get the latest 262779Srgrimesversion and check whether the problem still exists or not. 271767Sjkh 282570SrgrimesPLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help. 292570Srgrimes 302570SrgrimesMark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 312570Srgrimesissue of Dr. Dobb's Journal; a copy of the article is available at 322570Srgrimeshttp://marknelson.us/1997/01/01/zlib-engine/ . 332570Srgrimes 342570SrgrimesThe changes made in version 1.2.4.3 are documented in the file ChangeLog. 352570Srgrimes 366982SrgrimesUnsupported third party contributions are provided in directory contrib/ . 371782Sjkh 381782Sjkhzlib is available in Java using the java.util.zip package, documented at 39491Srgrimeshttp://java.sun.com/developer/technicalArticles/Programming/compression/ . 407273Srgrimes 416177SamuraiA Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available 426177Samuraiat CPAN (Comprehensive Perl Archive Network) sites, including 4337Srgrimeshttp://search.cpan.org/~pmqs/IO-Compress-Zlib/ . 4437Srgrimes 4537SrgrimesA Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is 4637Srgrimesavailable in Python 1.5 and later versions, see 47263Srgrimeshttp://www.python.org/doc/lib/module-zlib.html . 482779Srgrimes 498857Srgrimeszlib is built into tcl: http://wiki.tcl.tk/4610 . 50993Srgrimes 51277SrgrimesAn experimental package to read and write files in .zip format, written on top 522779Srgrimesof zlib by Gilles Vollant <info@winimage.com>, is available in the 53284Srgrimescontrib/minizip directory of zlib. 54463Srgrimes 553607Sphk 563607SphkNotes for some targets: 572779Srgrimes 58284Srgrimes- For Windows DLL versions, please see win32/DLL_FAQ.txt 59284Srgrimes 60284Srgrimes- For 64-bit Irix, deflate.c must be compiled without any optimization. With 61284Srgrimes -O, one libpng test fails. The test works in 32 bit mode (with the -n32 62284Srgrimes compiler flag). The compiler bug has been reported to SGI. 633647Sphk 64284Srgrimes- zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works 651767Sjkh when compiled with cc. 661285Srgrimes 672499Sgpalmer- On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is 681285Srgrimes necessary to get gzprintf working correctly. This is done by configure. 69284Srgrimes 701371Srgrimes- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with 711371Srgrimes other compilers. Use "make test" to check your compiler. 721194Srgrimes 73358Srgrimes- gzdopen is not supported on RISCOS or BEOS. 74358Srgrimes 75412Salm- For PalmOs, see http://palmzlib.sourceforge.net/ 76358Srgrimes 77452Srgrimes 78358SrgrimesAcknowledgments: 791194Srgrimes 801767Sjkh The deflate format used by zlib was defined by Phil Katz. The deflate and 811194Srgrimes zlib specifications were written by L. Peter Deutsch. Thanks to all the 822779Srgrimes people who reported problems and suggested various improvements in zlib; they 831194Srgrimes are too numerous to cite here. 841194Srgrimes 851194SrgrimesCopyright notice: 861194Srgrimes 871194Srgrimes (C) 1995-2010 Jean-loup Gailly and Mark Adler 881194Srgrimes 891194Srgrimes This software is provided 'as-is', without any express or implied 901194Srgrimes warranty. In no event will the authors be held liable for any damages 911194Srgrimes arising from the use of this software. 921194Srgrimes 931194Srgrimes Permission is granted to anyone to use this software for any purpose, 941194Srgrimes including commercial applications, and to alter it and redistribute it 951194Srgrimes freely, subject to the following restrictions: 962779Srgrimes 971194Srgrimes 1. The origin of this software must not be misrepresented; you must not 981194Srgrimes claim that you wrote the original software. If you use this software 991243Srgrimes in a product, an acknowledgment in the product documentation would be 100263Srgrimes appreciated but is not required. 101358Srgrimes 2. Altered source versions must be plainly marked as such, and must not be 1021194Srgrimes misrepresented as being the original software. 1031194Srgrimes 3. This notice may not be removed or altered from any source distribution. 1041194Srgrimes 1051773Sjkh Jean-loup Gailly Mark Adler 1062499Sgpalmer jloup@gzip.org madler@alumni.caltech.edu 1071194Srgrimes 108452SrgrimesIf you use the zlib library in a product, we would appreciate *not* receiving 1091194Srgrimeslengthy legal documents to sign. The sources are provided for free but without 1101194Srgrimeswarranty of any kind. The library has been entirely written by Jean-loup 111358SrgrimesGailly and Mark Adler; it does not include third-party code. 1121194Srgrimes 1132779SrgrimesIf you redistribute modified sources, we would appreciate that you include in 1142779Srgrimesthe file ChangeLog history information documenting your changes. Please read 1152779Srgrimesthe FAQ for more information on the distribution of modified source versions. 1162779Srgrimes