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