Back to home page

LXR

 
 

    


Warning, /cpukit/compression/zlib/README.md is written in an unsupported language. File is not indexed.

0001 ZLIB DATA COMPRESSION LIBRARY
0002 =============================
0003 
0004 zlib 1.2.13 is a general purpose data compression library.  All the code is
0005 thread safe.  The data format used by the zlib library is described by RFCs
0006 (Request for Comments) 1950 to 1952 in the files
0007 http://tools.ietf.org/html/rfc1950 (zlib format), rfc1951 (deflate format) and
0008 rfc1952 (gzip format).
0009 
0010 All functions of the compression library are documented in the file zlib.h
0011 (volunteer to write man pages welcome, contact zlib@gzip.org).  A usage example
0012 of the library is given in the file test/example.c which also tests that
0013 the library is working correctly.  Another example is given in the file
0014 test/minigzip.c.  The compression library itself is composed of all source
0015 files in the root directory.
0016 
0017 To compile all files and run the test program, follow the instructions given at
0018 the top of Makefile.in.  In short "./configure; make test", and if that goes
0019 well, "make install" should work for most flavors of Unix.  For Windows, use
0020 one of the special makefiles in win32/ or contrib/vstudio/ .  For VMS, use
0021 make_vms.com.
0022 
0023 Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant
0024 <info@winimage.com> for the Windows DLL version.  The zlib home page is
0025 http://zlib.net/ .  Before reporting a problem, please check this site to
0026 verify that you have the latest version of zlib; otherwise get the latest
0027 version and check whether the problem still exists or not.
0028 
0029 PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help.
0030 
0031 Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan.  1997
0032 issue of Dr.  Dobb's Journal; a copy of the article is available at
0033 http://marknelson.us/1997/01/01/zlib-engine/ .
0034 
0035 The changes made in version 1.2.13 are documented in the file ChangeLog.
0036 
0037 Unsupported third party contributions are provided in directory contrib/ .
0038 
0039 zlib is available in Java using the java.util.zip package, documented at
0040 http://java.sun.com/developer/technicalArticles/Programming/compression/ .
0041 
0042 A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available
0043 at CPAN (Comprehensive Perl Archive Network) sites, including
0044 http://search.cpan.org/~pmqs/IO-Compress-Zlib/ .
0045 
0046 A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is
0047 available in Python 1.5 and later versions, see
0048 http://docs.python.org/library/zlib.html .
0049 
0050 zlib is built into tcl: http://wiki.tcl.tk/4610 .
0051 
0052 An experimental package to read and write files in .zip format, written on top
0053 of zlib by Gilles Vollant <info@winimage.com>, is available in the
0054 contrib/minizip directory of zlib.
0055 
0056 
0057 Notes for some targets:
0058 
0059 - For Windows DLL versions, please see win32/DLL_FAQ.txt
0060 
0061 - For 64-bit Irix, deflate.c must be compiled without any optimization. With
0062   -O, one libpng test fails. The test works in 32 bit mode (with the -n32
0063   compiler flag). The compiler bug has been reported to SGI.
0064 
0065 - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works
0066   when compiled with cc.
0067 
0068 - On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is
0069   necessary to get gzprintf working correctly. This is done by configure.
0070 
0071 - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with
0072   other compilers. Use "make test" to check your compiler.
0073 
0074 - gzdopen is not supported on RISCOS or BEOS.
0075 
0076 - For PalmOs, see http://palmzlib.sourceforge.net/
0077 
0078 
0079 Acknowledgments:
0080 
0081   The deflate format used by zlib was defined by Phil Katz.  The deflate and
0082   zlib specifications were written by L.  Peter Deutsch.  Thanks to all the
0083   people who reported problems and suggested various improvements in zlib; they
0084   are too numerous to cite here.
0085 
0086 Copyright notice:
0087 
0088  (C) 1995-2022 Jean-loup Gailly and Mark Adler
0089 
0090   This software is provided 'as-is', without any express or implied
0091   warranty.  In no event will the authors be held liable for any damages
0092   arising from the use of this software.
0093 
0094   Permission is granted to anyone to use this software for any purpose,
0095   including commercial applications, and to alter it and redistribute it
0096   freely, subject to the following restrictions:
0097 
0098   1. The origin of this software must not be misrepresented; you must not
0099      claim that you wrote the original software. If you use this software
0100      in a product, an acknowledgment in the product documentation would be
0101      appreciated but is not required.
0102   2. Altered source versions must be plainly marked as such, and must not be
0103      misrepresented as being the original software.
0104   3. This notice may not be removed or altered from any source distribution.
0105 
0106   Jean-loup Gailly        Mark Adler
0107   jloup@gzip.org          madler@alumni.caltech.edu
0108 
0109 If you use the zlib library in a product, we would appreciate *not* receiving
0110 lengthy legal documents to sign.  The sources are provided for free but without
0111 warranty of any kind.  The library has been entirely written by Jean-loup
0112 Gailly and Mark Adler; it does not include third-party code.  We make all
0113 contributions to and distributions of this project solely in our personal
0114 capacity, and are not conveying any rights to any intellectual property of
0115 any third parties.
0116 
0117 If you redistribute modified sources, we would appreciate that you include in
0118 the file ChangeLog history information documenting your changes.  Please read
0119 the FAQ for more information on the distribution of modified source versions.