1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/modules/zlib/src/README Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,115 @@
1.4 +ZLIB DATA COMPRESSION LIBRARY
1.5 +
1.6 +zlib 1.2.8 is a general purpose data compression library. All the code is
1.7 +thread safe. The data format used by the zlib library is described by RFCs
1.8 +(Request for Comments) 1950 to 1952 in the files
1.9 +http://tools.ietf.org/html/rfc1950 (zlib format), rfc1951 (deflate format) and
1.10 +rfc1952 (gzip format).
1.11 +
1.12 +All functions of the compression library are documented in the file zlib.h
1.13 +(volunteer to write man pages welcome, contact zlib@gzip.org). A usage example
1.14 +of the library is given in the file test/example.c which also tests that
1.15 +the library is working correctly. Another example is given in the file
1.16 +test/minigzip.c. The compression library itself is composed of all source
1.17 +files in the root directory.
1.18 +
1.19 +To compile all files and run the test program, follow the instructions given at
1.20 +the top of Makefile.in. In short "./configure; make test", and if that goes
1.21 +well, "make install" should work for most flavors of Unix. For Windows, use
1.22 +one of the special makefiles in win32/ or contrib/vstudio/ . For VMS, use
1.23 +make_vms.com.
1.24 +
1.25 +Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant
1.26 +<info@winimage.com> for the Windows DLL version. The zlib home page is
1.27 +http://zlib.net/ . Before reporting a problem, please check this site to
1.28 +verify that you have the latest version of zlib; otherwise get the latest
1.29 +version and check whether the problem still exists or not.
1.30 +
1.31 +PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help.
1.32 +
1.33 +Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997
1.34 +issue of Dr. Dobb's Journal; a copy of the article is available at
1.35 +http://marknelson.us/1997/01/01/zlib-engine/ .
1.36 +
1.37 +The changes made in version 1.2.8 are documented in the file ChangeLog.
1.38 +
1.39 +Unsupported third party contributions are provided in directory contrib/ .
1.40 +
1.41 +zlib is available in Java using the java.util.zip package, documented at
1.42 +http://java.sun.com/developer/technicalArticles/Programming/compression/ .
1.43 +
1.44 +A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available
1.45 +at CPAN (Comprehensive Perl Archive Network) sites, including
1.46 +http://search.cpan.org/~pmqs/IO-Compress-Zlib/ .
1.47 +
1.48 +A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is
1.49 +available in Python 1.5 and later versions, see
1.50 +http://docs.python.org/library/zlib.html .
1.51 +
1.52 +zlib is built into tcl: http://wiki.tcl.tk/4610 .
1.53 +
1.54 +An experimental package to read and write files in .zip format, written on top
1.55 +of zlib by Gilles Vollant <info@winimage.com>, is available in the
1.56 +contrib/minizip directory of zlib.
1.57 +
1.58 +
1.59 +Notes for some targets:
1.60 +
1.61 +- For Windows DLL versions, please see win32/DLL_FAQ.txt
1.62 +
1.63 +- For 64-bit Irix, deflate.c must be compiled without any optimization. With
1.64 + -O, one libpng test fails. The test works in 32 bit mode (with the -n32
1.65 + compiler flag). The compiler bug has been reported to SGI.
1.66 +
1.67 +- zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works
1.68 + when compiled with cc.
1.69 +
1.70 +- On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is
1.71 + necessary to get gzprintf working correctly. This is done by configure.
1.72 +
1.73 +- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with
1.74 + other compilers. Use "make test" to check your compiler.
1.75 +
1.76 +- gzdopen is not supported on RISCOS or BEOS.
1.77 +
1.78 +- For PalmOs, see http://palmzlib.sourceforge.net/
1.79 +
1.80 +
1.81 +Acknowledgments:
1.82 +
1.83 + The deflate format used by zlib was defined by Phil Katz. The deflate and
1.84 + zlib specifications were written by L. Peter Deutsch. Thanks to all the
1.85 + people who reported problems and suggested various improvements in zlib; they
1.86 + are too numerous to cite here.
1.87 +
1.88 +Copyright notice:
1.89 +
1.90 + (C) 1995-2013 Jean-loup Gailly and Mark Adler
1.91 +
1.92 + This software is provided 'as-is', without any express or implied
1.93 + warranty. In no event will the authors be held liable for any damages
1.94 + arising from the use of this software.
1.95 +
1.96 + Permission is granted to anyone to use this software for any purpose,
1.97 + including commercial applications, and to alter it and redistribute it
1.98 + freely, subject to the following restrictions:
1.99 +
1.100 + 1. The origin of this software must not be misrepresented; you must not
1.101 + claim that you wrote the original software. If you use this software
1.102 + in a product, an acknowledgment in the product documentation would be
1.103 + appreciated but is not required.
1.104 + 2. Altered source versions must be plainly marked as such, and must not be
1.105 + misrepresented as being the original software.
1.106 + 3. This notice may not be removed or altered from any source distribution.
1.107 +
1.108 + Jean-loup Gailly Mark Adler
1.109 + jloup@gzip.org madler@alumni.caltech.edu
1.110 +
1.111 +If you use the zlib library in a product, we would appreciate *not* receiving
1.112 +lengthy legal documents to sign. The sources are provided for free but without
1.113 +warranty of any kind. The library has been entirely written by Jean-loup
1.114 +Gailly and Mark Adler; it does not include third-party code.
1.115 +
1.116 +If you redistribute modified sources, we would appreciate that you include in
1.117 +the file ChangeLog history information documenting your changes. Please read
1.118 +the FAQ for more information on the distribution of modified source versions.
