README revision 313796
1228753SmmZLIB DATA COMPRESSION LIBRARY 2228753Smm 3228753Smmzlib 1.2.11 is a general purpose data compression library. All the code is 4228753Smmthread safe. The data format used by the zlib library is described by RFCs 5228753Smm(Request for Comments) 1950 to 1952 in the files 6228753Smmhttp://tools.ietf.org/html/rfc1950 (zlib format), rfc1951 (deflate format) and 7228753Smmrfc1952 (gzip format). 8228753Smm 9228753SmmAll functions of the compression library are documented in the file zlib.h 10228753Smm(volunteer to write man pages welcome, contact zlib@gzip.org). A usage example 11228753Smmof the library is given in the file test/example.c which also tests that 12228753Smmthe library is working correctly. Another example is given in the file 13228753Smmtest/minigzip.c. The compression library itself is composed of all source 14228753Smmfiles in the root directory. 15228753Smm 16228753SmmTo compile all files and run the test program, follow the instructions given at 17228753Smmthe top of Makefile.in. In short "./configure; make test", and if that goes 18228753Smmwell, "make install" should work for most flavors of Unix. For Windows, use 19228753Smmone of the special makefiles in win32/ or contrib/vstudio/ . For VMS, use 20228753Smmmake_vms.com. 21228753Smm 22228753SmmQuestions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant 23228753Smm<info@winimage.com> for the Windows DLL version. The zlib home page is 24228753Smmhttp://zlib.net/ . Before reporting a problem, please check this site to 25228763Smmverify that you have the latest version of zlib; otherwise get the latest 26228753Smmversion and check whether the problem still exists or not. 27238856Smm 28228773SmmPLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help. 29228753Smm 30228753SmmMark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 31228753Smmissue of Dr. Dobb's Journal; a copy of the article is available at 32228753Smmhttp://marknelson.us/1997/01/01/zlib-engine/ . 33228753Smm 34228753SmmThe changes made in version 1.2.11 are documented in the file ChangeLog. 35228753Smm 36228753SmmUnsupported third party contributions are provided in directory contrib/ . 37228753Smm 38232153Smmzlib is available in Java using the java.util.zip package, documented at 39232153Smmhttp://java.sun.com/developer/technicalArticles/Programming/compression/ . 40232153Smm 41228753SmmA Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available 42228753Smmat CPAN (Comprehensive Perl Archive Network) sites, including 43232153Smmhttp://search.cpan.org/~pmqs/IO-Compress-Zlib/ . 44228753Smm 45228753SmmA Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is 46238856Smmavailable in Python 1.5 and later versions, see 47238856Smmhttp://docs.python.org/library/zlib.html . 48228753Smm 49228753Smmzlib is built into tcl: http://wiki.tcl.tk/4610 . 50228753Smm 51228753SmmAn experimental package to read and write files in .zip format, written on top 52228753Smmof zlib by Gilles Vollant <info@winimage.com>, is available in the 53228753Smmcontrib/minizip directory of zlib. 54228753Smm 55228753Smm 56228753SmmNotes for some targets: 57228753Smm 58228753Smm- For Windows DLL versions, please see win32/DLL_FAQ.txt 59228753Smm 60228753Smm- For 64-bit Irix, deflate.c must be compiled without any optimization. With 61228753Smm -O, one libpng test fails. The test works in 32 bit mode (with the -n32 62228753Smm compiler flag). The compiler bug has been reported to SGI. 63228753Smm 64228753Smm- zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works 65232153Smm when compiled with cc. 66232153Smm 67232153Smm- On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is 68232153Smm necessary to get gzprintf working correctly. This is done by configure. 69232153Smm 70232153Smm- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with 71228753Smm other compilers. Use "make test" to check your compiler. 72228753Smm 73228753Smm- gzdopen is not supported on RISCOS or BEOS. 74232153Smm 75232153Smm- For PalmOs, see http://palmzlib.sourceforge.net/ 76228753Smm 77228753Smm 78228753SmmAcknowledgments: 79228753Smm 80228753Smm The deflate format used by zlib was defined by Phil Katz. The deflate and 81228753Smm zlib specifications were written by L. Peter Deutsch. Thanks to all the 82228753Smm people who reported problems and suggested various improvements in zlib; they 83228753Smm are too numerous to cite here. 84228753Smm 85228753SmmCopyright notice: 86228753Smm 87228753Smm (C) 1995-2017 Jean-loup Gailly and Mark Adler 88228753Smm 89228753Smm This software is provided 'as-is', without any express or implied 90228753Smm warranty. In no event will the authors be held liable for any damages 91228753Smm arising from the use of this software. 92228753Smm 93228753Smm Permission is granted to anyone to use this software for any purpose, 94232153Smm including commercial applications, and to alter it and redistribute it 95353377Smm freely, subject to the following restrictions: 96228753Smm 97232153Smm 1. The origin of this software must not be misrepresented; you must not 98353377Smm claim that you wrote the original software. If you use this software 99228753Smm in a product, an acknowledgment in the product documentation would be 100228753Smm appreciated but is not required. 101228753Smm 2. Altered source versions must be plainly marked as such, and must not be 102228753Smm misrepresented as being the original software. 103228753Smm 3. This notice may not be removed or altered from any source distribution. 104228753Smm 105232153Smm Jean-loup Gailly Mark Adler 106232153Smm jloup@gzip.org madler@alumni.caltech.edu 107232153Smm 108232153SmmIf you use the zlib library in a product, we would appreciate *not* receiving 109228753Smmlengthy legal documents to sign. The sources are provided for free but without 110228753Smmwarranty of any kind. The library has been entirely written by Jean-loup 111228753SmmGailly and Mark Adler; it does not include third-party code. 112228753Smm 113228753SmmIf you redistribute modified sources, we would appreciate that you include in 114228753Smmthe file ChangeLog history information documenting your changes. Please read 115228753Smmthe FAQ for more information on the distribution of modified source versions. 116228753Smm