runtime/zlib/README

   1 LLVM CHANGES TO ZLIB
   2
   3 Changes made by the LLVM Team (llvmdev@cs.uiuc.edu, 2/6/2004):
   4  1) Makefile was modified for building with the LLVM build system and tools.
   5  2) Version numbers were updated as described in the FAQ.
   6  3) LLVM LICENSE.TXT file was added describing licensing information.
   7
   8 ZLIB DATA COMPRESSION LIBRARY
   9
  10 zlib 1.2.1 is a general purpose data compression library.  All the code is
  11 thread safe.  The data format used by the zlib library is described by RFCs
  12 (Request for Comments) 1950 to 1952 in the files
  13 http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format)
  14 and rfc1952.txt (gzip format). These documents are also available in other
  15 formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
  16
  17 All functions of the compression library are documented in the file zlib.h
  18 (volunteer to write man pages welcome, contact zlib@gzip.org). A usage example
  19 of the library is given in the file example.c which also tests that the library
  20 is working correctly. Another example is given in the file minigzip.c. The
  21 compression library itself is composed of all source files except example.c and
  22 minigzip.c.
  23
  24 To compile all files and run the test program, follow the instructions given at
  25 the top of Makefile. In short "make test; make install" should work for most
  26 machines. For Unix: "./configure; make test; make install" For MSDOS, use one
  27 of the special makefiles such as Makefile.msc. For VMS, use Make_vms.com or
  28 descrip.mms.
  29
  30 Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant
  31 <info@winimage.com> for the Windows DLL version. The zlib home page is
  32 http://www.zlib.org or http://www.gzip.org/zlib/ Before reporting a problem,
  33 please check this site to verify that you have the latest version of zlib;
  34 otherwise get the latest version and check whether the problem still exists or
  35 not.
  36
  37 PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html before asking
  38 for help.
  39
  40 Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997
  41 issue of  Dr. Dobb's Journal; a copy of the article is available in
  42 http://dogma.net/markn/articles/zlibtool/zlibtool.htm
  43
  44 The changes made in version 1.2.1 are documented in the file ChangeLog.
  45
  46 Unsupported third party contributions are provided in directory "contrib".
  47
  48 A Java implementation of zlib is available in the Java Development Kit
  49 http://java.sun.com/j2se/1.4.2/docs/api/java/util/zip/package-summary.html
  50 See the zlib home page http://www.zlib.org for details.
  51
  52 A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is in the
  53 CPAN (Comprehensive Perl Archive Network) sites
  54 http://www.cpan.org/modules/by-module/Compress/
  55
  56 A Python interface to zlib written by A.M. Kuchling <amk@magnet.com> is
  57 available in Python 1.5 and later versions, see
  58 http://www.python.org/doc/lib/module-zlib.html
  59
  60 A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com> is
  61 availlable at http://www.oche.de/~akupries/soft/trf/trf_zip.html
  62
  63 An experimental package to read and write files in .zip format, written on top
  64 of zlib by Gilles Vollant <info@winimage.com>, is available in the
  65 contrib/minizip directory of zlib.
  66
  67
  68 Notes for some targets:
  69
  70 - For Windows DLL versions, please see win32/DLL_FAQ.txt
  71
  72 - For 64-bit Irix, deflate.c must be compiled without any optimization. With
  73   -O, one libpng test fails. The test works in 32 bit mode (with the -n32
  74   compiler flag). The compiler bug has been reported to SGI.
  75
  76 - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works
  77   when compiled with cc.
  78
  79 - On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is
  80   necessary to get gzprintf working correctly. This is done by configure.
  81
  82 - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with
  83   other compilers. Use "make test" to check your compiler.
  84
  85 - gzdopen is not supported on RISCOS, BEOS and by some Mac compilers.
  86
  87 - For PalmOs, see http://palmzlib.sourceforge.net/
  88
  89 - When building a shared, i.e. dynamic library on Mac OS X, the library must be
  90   installed before testing (do "make install" before "make test"), since the
  91   library location is specified in the library.
  92
  93
  94 Acknowledgments:
  95
  96   The deflate format used by zlib was defined by Phil Katz. The deflate
  97   and zlib specifications were written by L. Peter Deutsch. Thanks to all the
  98   people who reported problems and suggested various improvements in zlib;
  99   they are too numerous to cite here.
 100
 101 Copyright notice:
 102
 103  (C) 1995-2003 Jean-loup Gailly and Mark Adler
 104
 105   This software is provided 'as-is', without any express or implied
 106   warranty.  In no event will the authors be held liable for any damages
 107   arising from the use of this software.
 108
 109   Permission is granted to anyone to use this software for any purpose,
 110   including commercial applications, and to alter it and redistribute it
 111   freely, subject to the following restrictions:
 112
 113   1. The origin of this software must not be misrepresented; you must not
 114      claim that you wrote the original software. If you use this software
 115      in a product, an acknowledgment in the product documentation would be
 116      appreciated but is not required.
 117   2. Altered source versions must be plainly marked as such, and must not be
 118      misrepresented as being the original software.
 119   3. This notice may not be removed or altered from any source distribution.
 120
 121   Jean-loup Gailly        Mark Adler
 122   jloup@gzip.org          madler@alumni.caltech.edu
 123
 124 If you use the zlib library in a product, we would appreciate *not*
 125 receiving lengthy legal documents to sign. The sources are provided
 126 for free but without warranty of any kind.  The library has been
 127 entirely written by Jean-loup Gailly and Mark Adler; it does not
 128 include third-party code.
 129
 130 If you redistribute modified sources, we would appreciate that you include
 131 in the file ChangeLog history information documenting your changes. Please
 132 read the FAQ for more information on the distribution of modified source
 133 versions.