README revision 131377
1256052SgrehanZLIB DATA COMPRESSION LIBRARY 2256052Sgrehan 3256052Sgrehanzlib 1.2.1 is a general purpose data compression library. All the code is 4256052Sgrehanthread safe. The data format used by the zlib library is described by RFCs 5256052Sgrehan(Request for Comments) 1950 to 1952 in the files 6256052Sgrehanhttp://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format) 7256052Sgrehanand rfc1952.txt (gzip format). These documents are also available in other 8256052Sgrehanformats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html 9256052Sgrehan 10256052SgrehanAll functions of the compression library are documented in the file zlib.h 11256052Sgrehan(volunteer to write man pages welcome, contact zlib@gzip.org). A usage example 12256052Sgrehanof the library is given in the file example.c which also tests that the library 13256052Sgrehanis working correctly. Another example is given in the file minigzip.c. The 14256052Sgrehancompression library itself is composed of all source files except example.c and 15256052Sgrehanminigzip.c. 16256052Sgrehan 17256052SgrehanTo compile all files and run the test program, follow the instructions given at 18256052Sgrehanthe top of Makefile. In short "make test; make install" should work for most 19256052Sgrehanmachines. For Unix: "./configure; make test; make install" For MSDOS, use one 20256052Sgrehanof the special makefiles such as Makefile.msc. For VMS, use Make_vms.com or 21256052Sgrehandescrip.mms. 22256052Sgrehan 23256052SgrehanQuestions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant 24256052Sgrehan<info@winimage.com> for the Windows DLL version. The zlib home page is 25256052Sgrehanhttp://www.zlib.org or http://www.gzip.org/zlib/ Before reporting a problem, 26256052Sgrehanplease check this site to verify that you have the latest version of zlib; 27256052Sgrehanotherwise get the latest version and check whether the problem still exists or 28256052Sgrehannot. 29256052Sgrehan 30256052SgrehanPLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html before asking 31256052Sgrehanfor help. 32256052Sgrehan 33256052SgrehanMark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 34256052Sgrehanissue of Dr. Dobb's Journal; a copy of the article is available in 35256052Sgrehanhttp://dogma.net/markn/articles/zlibtool/zlibtool.htm 36256052Sgrehan 37256052SgrehanThe changes made in version 1.2.1 are documented in the file ChangeLog. 38256052Sgrehan 39256052SgrehanUnsupported third party contributions are provided in directory "contrib". 40256052Sgrehan 41256052SgrehanA Java implementation of zlib is available in the Java Development Kit 42256052Sgrehanhttp://java.sun.com/j2se/1.4.2/docs/api/java/util/zip/package-summary.html 43256052SgrehanSee the zlib home page http://www.zlib.org for details. 44256052Sgrehan 45256052SgrehanA Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is in the 46256052SgrehanCPAN (Comprehensive Perl Archive Network) sites 47256052Sgrehanhttp://www.cpan.org/modules/by-module/Compress/ 48256052Sgrehan 49256052SgrehanA Python interface to zlib written by A.M. Kuchling <amk@magnet.com> is 50256052Sgrehanavailable in Python 1.5 and later versions, see 51256052Sgrehanhttp://www.python.org/doc/lib/module-zlib.html 52256052Sgrehan 53267071SjhbA zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com> is 54256052Sgrehanavaillable at http://www.oche.de/~akupries/soft/trf/trf_zip.html 55256052Sgrehan 56256052SgrehanAn experimental package to read and write files in .zip format, written on top 57256052Sgrehanof zlib by Gilles Vollant <info@winimage.com>, is available in the 58256052Sgrehancontrib/minizip directory of zlib. 59256052Sgrehan 60256052Sgrehan 61256052SgrehanNotes for some targets: 62256052Sgrehan 63256052Sgrehan- For Windows DLL versions, please see win32/DLL_FAQ.txt 64256052Sgrehan 65256052Sgrehan- For 64-bit Irix, deflate.c must be compiled without any optimization. With 66256052Sgrehan -O, one libpng test fails. The test works in 32 bit mode (with the -n32 67256052Sgrehan compiler flag). The compiler bug has been reported to SGI. 68256052Sgrehan 69256052Sgrehan- zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works 70256052Sgrehan when compiled with cc. 71256052Sgrehan 72256052Sgrehan- On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is 73256052Sgrehan necessary to get gzprintf working correctly. This is done by configure. 74256052Sgrehan 75256052Sgrehan- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with 76256052Sgrehan other compilers. Use "make test" to check your compiler. 77256052Sgrehan 78256052Sgrehan- gzdopen is not supported on RISCOS, BEOS and by some Mac compilers. 79256052Sgrehan 80256052Sgrehan- For PalmOs, see http://palmzlib.sourceforge.net/ 81256052Sgrehan 82256052Sgrehan- When building a shared, i.e. dynamic library on Mac OS X, the library must be 83256052Sgrehan installed before testing (do "make install" before "make test"), since the 84256052Sgrehan library location is specified in the library. 85256052Sgrehan 86256052Sgrehan 87256052SgrehanAcknowledgments: 88256052Sgrehan 89256052Sgrehan The deflate format used by zlib was defined by Phil Katz. The deflate 90256052Sgrehan and zlib specifications were written by L. Peter Deutsch. Thanks to all the 91256052Sgrehan people who reported problems and suggested various improvements in zlib; 92256052Sgrehan they are too numerous to cite here. 93256052Sgrehan 94256052SgrehanCopyright notice: 95256052Sgrehan 96256052Sgrehan (C) 1995-2003 Jean-loup Gailly and Mark Adler 97256052Sgrehan 98256052Sgrehan This software is provided 'as-is', without any express or implied 99256052Sgrehan warranty. In no event will the authors be held liable for any damages 100256052Sgrehan arising from the use of this software. 101256052Sgrehan 102256052Sgrehan Permission is granted to anyone to use this software for any purpose, 103256052Sgrehan including commercial applications, and to alter it and redistribute it 104256052Sgrehan freely, subject to the following restrictions: 105256052Sgrehan 106256052Sgrehan 1. The origin of this software must not be misrepresented; you must not 107256052Sgrehan claim that you wrote the original software. If you use this software 108256052Sgrehan in a product, an acknowledgment in the product documentation would be 109256052Sgrehan appreciated but is not required. 110256052Sgrehan 2. Altered source versions must be plainly marked as such, and must not be 111256052Sgrehan misrepresented as being the original software. 112256052Sgrehan 3. This notice may not be removed or altered from any source distribution. 113256052Sgrehan 114256052Sgrehan Jean-loup Gailly Mark Adler 115256052Sgrehan jloup@gzip.org madler@alumni.caltech.edu 116256052Sgrehan 117256052SgrehanIf you use the zlib library in a product, we would appreciate *not* 118256052Sgrehanreceiving lengthy legal documents to sign. The sources are provided 119256052Sgrehanfor free but without warranty of any kind. The library has been 120256052Sgrehanentirely written by Jean-loup Gailly and Mark Adler; it does not 121256052Sgrehaninclude third-party code. 122256052Sgrehan 123256052SgrehanIf you redistribute modified sources, we would appreciate that you include 124256052Sgrehanin the file ChangeLog history information documenting your changes. Please 125256052Sgrehanread the FAQ for more information on the distribution of modified source 126256052Sgrehanversions. 127256052Sgrehan