annotate src/zlib-1.2.7/README @ 6:35e00f62c407

Further builds
author Chris Cannam
date Wed, 20 Mar 2013 14:58:12 +0000
parents e13257ea84a4
children
rev   line source
Chris@4 1 ZLIB DATA COMPRESSION LIBRARY
Chris@4 2
Chris@4 3 zlib 1.2.7 is a general purpose data compression library. All the code is
Chris@4 4 thread safe. The data format used by the zlib library is described by RFCs
Chris@4 5 (Request for Comments) 1950 to 1952 in the files
Chris@4 6 http://tools.ietf.org/html/rfc1950 (zlib format), rfc1951 (deflate format) and
Chris@4 7 rfc1952 (gzip format).
Chris@4 8
Chris@4 9 All functions of the compression library are documented in the file zlib.h
Chris@4 10 (volunteer to write man pages welcome, contact zlib@gzip.org). A usage example
Chris@4 11 of the library is given in the file test/example.c which also tests that
Chris@4 12 the library is working correctly. Another example is given in the file
Chris@4 13 test/minigzip.c. The compression library itself is composed of all source
Chris@4 14 files in the root directory.
Chris@4 15
Chris@4 16 To compile all files and run the test program, follow the instructions given at
Chris@4 17 the top of Makefile.in. In short "./configure; make test", and if that goes
Chris@4 18 well, "make install" should work for most flavors of Unix. For Windows, use
Chris@4 19 one of the special makefiles in win32/ or contrib/vstudio/ . For VMS, use
Chris@4 20 make_vms.com.
Chris@4 21
Chris@4 22 Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant
Chris@4 23 <info@winimage.com> for the Windows DLL version. The zlib home page is
Chris@4 24 http://zlib.net/ . Before reporting a problem, please check this site to
Chris@4 25 verify that you have the latest version of zlib; otherwise get the latest
Chris@4 26 version and check whether the problem still exists or not.
Chris@4 27
Chris@4 28 PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help.
Chris@4 29
Chris@4 30 Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997
Chris@4 31 issue of Dr. Dobb's Journal; a copy of the article is available at
Chris@4 32 http://marknelson.us/1997/01/01/zlib-engine/ .
Chris@4 33
Chris@4 34 The changes made in version 1.2.7 are documented in the file ChangeLog.
Chris@4 35
Chris@4 36 Unsupported third party contributions are provided in directory contrib/ .
Chris@4 37
Chris@4 38 zlib is available in Java using the java.util.zip package, documented at
Chris@4 39 http://java.sun.com/developer/technicalArticles/Programming/compression/ .
Chris@4 40
Chris@4 41 A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available
Chris@4 42 at CPAN (Comprehensive Perl Archive Network) sites, including
Chris@4 43 http://search.cpan.org/~pmqs/IO-Compress-Zlib/ .
Chris@4 44
Chris@4 45 A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is
Chris@4 46 available in Python 1.5 and later versions, see
Chris@4 47 http://docs.python.org/library/zlib.html .
Chris@4 48
Chris@4 49 zlib is built into tcl: http://wiki.tcl.tk/4610 .
Chris@4 50
Chris@4 51 An experimental package to read and write files in .zip format, written on top
Chris@4 52 of zlib by Gilles Vollant <info@winimage.com>, is available in the
Chris@4 53 contrib/minizip directory of zlib.
Chris@4 54
Chris@4 55
Chris@4 56 Notes for some targets:
Chris@4 57
Chris@4 58 - For Windows DLL versions, please see win32/DLL_FAQ.txt
Chris@4 59
Chris@4 60 - For 64-bit Irix, deflate.c must be compiled without any optimization. With
Chris@4 61 -O, one libpng test fails. The test works in 32 bit mode (with the -n32
Chris@4 62 compiler flag). The compiler bug has been reported to SGI.
Chris@4 63
Chris@4 64 - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works
Chris@4 65 when compiled with cc.
Chris@4 66
Chris@4 67 - On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is
Chris@4 68 necessary to get gzprintf working correctly. This is done by configure.
Chris@4 69
Chris@4 70 - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with
Chris@4 71 other compilers. Use "make test" to check your compiler.
Chris@4 72
Chris@4 73 - gzdopen is not supported on RISCOS or BEOS.
Chris@4 74
Chris@4 75 - For PalmOs, see http://palmzlib.sourceforge.net/
Chris@4 76
Chris@4 77
Chris@4 78 Acknowledgments:
Chris@4 79
Chris@4 80 The deflate format used by zlib was defined by Phil Katz. The deflate and
Chris@4 81 zlib specifications were written by L. Peter Deutsch. Thanks to all the
Chris@4 82 people who reported problems and suggested various improvements in zlib; they
Chris@4 83 are too numerous to cite here.
Chris@4 84
Chris@4 85 Copyright notice:
Chris@4 86
Chris@4 87 (C) 1995-2012 Jean-loup Gailly and Mark Adler
Chris@4 88
Chris@4 89 This software is provided 'as-is', without any express or implied
Chris@4 90 warranty. In no event will the authors be held liable for any damages
Chris@4 91 arising from the use of this software.
Chris@4 92
Chris@4 93 Permission is granted to anyone to use this software for any purpose,
Chris@4 94 including commercial applications, and to alter it and redistribute it
Chris@4 95 freely, subject to the following restrictions:
Chris@4 96
Chris@4 97 1. The origin of this software must not be misrepresented; you must not
Chris@4 98 claim that you wrote the original software. If you use this software
Chris@4 99 in a product, an acknowledgment in the product documentation would be
Chris@4 100 appreciated but is not required.
Chris@4 101 2. Altered source versions must be plainly marked as such, and must not be
Chris@4 102 misrepresented as being the original software.
Chris@4 103 3. This notice may not be removed or altered from any source distribution.
Chris@4 104
Chris@4 105 Jean-loup Gailly Mark Adler
Chris@4 106 jloup@gzip.org madler@alumni.caltech.edu
Chris@4 107
Chris@4 108 If you use the zlib library in a product, we would appreciate *not* receiving
Chris@4 109 lengthy legal documents to sign. The sources are provided for free but without
Chris@4 110 warranty of any kind. The library has been entirely written by Jean-loup
Chris@4 111 Gailly and Mark Adler; it does not include third-party code.
Chris@4 112
Chris@4 113 If you redistribute modified sources, we would appreciate that you include in
Chris@4 114 the file ChangeLog history information documenting your changes. Please read
Chris@4 115 the FAQ for more information on the distribution of modified source versions.