README

   1 zlib 1.0.7 is a general purpose data compression library.  All the code
   2 is reentrant (thread safe).  The data format used by the zlib library
   3 is described by RFCs (Request for Comments) 1950 to 1952 in the files
   4 ftp://ds.internic.net/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate
   5 format) and rfc1952.txt (gzip format). These documents are also available in
   6 other formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
   7
   8 All functions of the compression library are documented in the file
   9 zlib.h. A usage example of the library is given in the file example.c
  10 which also tests that the library is working correctly. Another
  11 example is given in the file minigzip.c. The compression library itself
  12 is composed of all source files except example.c and minigzip.c.
  13
  14 To compile all files and run the test program, follow the instructions
  15 given at the top of Makefile. In short "make test; make install"
  16 should work for most machines.  For MSDOS, use one of the special
  17 makefiles such as Makefile.msc; for VMS, use Make_vms.com or descrip.mms.
  18
  19 Questions about zlib should be sent to <zlib@quest.jpl.nasa.gov> or,
  20 if this fails, to the addresses given below in the Copyright section.
  21 The zlib home page is http://www.cdrom.com/pub/infozip/zlib/
  22 The official zlib ftp site is ftp://ftp.cdrom.com/pub/infozip/zlib/
  23 Mark Nelson wrote an article about zlib for the Jan. 1997 issue of
  24 Dr. Dobb's Journal; a copy of the article is available in
  25 http://web2.airmail.net/markn/articles/zlibtool/zlibtool.htm
  26
  27 The changes made in version 1.0.7 are documented in the file ChangeLog.
  28 The main changes since 1.0.6 are:
  29
  30 - fix gzseek which was broken in write mode
  31 - return error for gzseek to negative absolute position
  32 - fix configure for Linux (Chun-Chung Chen)
  33 - increase stack space for MSC (Tim Wegner)
  34 - get_crc_table and inflateSyncPoint are EXPORTed (Gilles Vollant)
  35 - define EXPORTVA for gzprintf (Gilles Vollant)
  36 - added mini man page zlib.3 (Rick Rodgers) [volunteers to write full
  37   man pages from zlib.h most welcome. write to jloup@gzip.org]
  38 - for contrib/untgz, fix makedir() and improve Makefile
  39
  40 Unsupported third party contributions are provided in directory "contrib".
  41
  42 A Java implementation of zlib is available in the Java Development Kit 1.1
  43 http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
  44 See the zlib home page http://www.cdrom.com/pub/infozip/zlib/ for details.
  45
  46 A Perl interface to zlib written by Paul Marquess <pmarquess@bfsec.bt.co.uk>
  47 is in the CPAN (Comprehensive Perl Archive Network) sites, such as:
  48 ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
  49
  50 A Python interface to zlib written by A.M. Kuchling <amk@magnet.com>
  51 is available from the Python Software Association sites, such as:
  52 ftp://ftp.python.org/pub/python/contrib/Encoding/zlib*.tar.gz
  53
  54 Notes for some targets:
  55
  56 - To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc
  57   and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL
  58   The zlib DLL support was initially done by Alessandro Iacopetti and is
  59   now maintained by Gilles Vollant <info@winimage.com>. Check the zlib DLL
  60   home page at http://www.winimage.com/zLibDll
  61
  62   From Visual Basic, you can call the DLL functions which do not take
  63   a structure as argument: compress, uncompress and all gz* functions.
  64   See contrib/visual-basic.txt for more information.
  65   I don't know how to handle structures in Visual Basic, sorry.
  66
  67 - For 64-bit Irix, deflate.c must be compiled without any optimization.
  68   With -O, one libpng test fails. The test works in 32 bit mode (with
  69   the -n32 compiler flag). The compiler bug has been reported to SGI.
  70
  71 - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1
  72   it works when compiled with cc.
  73
  74 - zlib doesn't work on HP-UX 9.05 with one cc compiler (the one not
  75   accepting the -O option). It works with the other cc compiler.
  76
  77 - gzdopen is not supported on RISCOS
  78
  79 - For Turbo C the small model is supported only with reduced performance to
  80   avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
  81
  82
  83 Acknowledgments:
  84
  85   The deflate format used by zlib was defined by Phil Katz. The deflate
  86   and zlib specifications were written by Peter Deutsch. Thanks to all the
  87   people who reported problems and suggested various improvements in zlib;
  88   they are too numerous to cite here.
  89
  90 Copyright notice:
  91
  92  (C) 1995-1998 Jean-loup Gailly and Mark Adler
  93
  94   This software is provided 'as-is', without any express or implied
  95   warranty.  In no event will the authors be held liable for any damages
  96   arising from the use of this software.
  97
  98   Permission is granted to anyone to use this software for any purpose,
  99   including commercial applications, and to alter it and redistribute it
 100   freely, subject to the following restrictions:
 101
 102   1. The origin of this software must not be misrepresented; you must not
 103      claim that you wrote the original software. If you use this software
 104      in a product, an acknowledgment in the product documentation would be
 105      appreciated but is not required.
 106   2. Altered source versions must be plainly marked as such, and must not be
 107      misrepresented as being the original software.
 108   3. This notice may not be removed or altered from any source distribution.
 109
 110   Jean-loup Gailly        Mark Adler
 111   jloup@gzip.org          madler@alumni.caltech.edu
 112
 113 If you use the zlib library in a product, we would appreciate *not*
 114 receiving lengthy legal documents to sign. The sources are provided
 115 for free but without warranty of any kind.  The library has been
 116 entirely written by Jean-loup Gailly and Mark Adler; it does not
 117 include third-party code.
 118
 119 If you redistribute modified sources, we would appreciate that you include
 120 in the file ChangeLog history information documenting your changes.