annotate src/zlib-1.2.8/README @ 83:ae30d91d2ffe

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