README

   1 zlib 1.0 is a general purpose data compression library.
   2 All the code is reentrant (thread safe).
   3
   4 The data format used by the zlib library is described in the
   5 files zlib-3.2.doc, deflate-1.2.doc and gzip-4.2.doc, available
   6 in ftp://ftp.uu.net/pub/archiving/zip/doc
   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.
  12
  13 To compile all files and run the test program, just type: make test
  14 (For MSDOS, use one of the special makefiles such as Makefile.msc;
  15 for VMS, use Make_vms.com or descrip.mms.)
  16 To install the zlib library (libz.a) in /usr/local/lib, type: make install
  17 To install in a different directory, use for example:
  18   make install prefix=$HOME
  19 This will install in $HOME/lib instead of /usr/local/lib.
  20
  21 Questions about zlib should be sent to <zlib@quest.jpl.nasa.gov>.
  22
  23 The changes made in version 1.0 are documented in the file ChangeLog.
  24 The main changes since 0.95 are:
  25 - allow compression level 0 (no compression)
  26 - add deflateParams in zlib.h: allow dynamic change of compression level
  27   and compression strategy.
  28 - test large buffers and deflateParams in example.c
  29 - declare Z_DEFLATED in zlib.h (possible parameter for deflateInit2)
  30 - fixes for 64-bit systems (needed for Alpha and Cray)
  31 - always return Z_BUF_ERROR when deflate() has nothing to do
  32 - fix some very unlikely race conditions.
  33 - several minor fixes for better portability
  34 - free in reverse order of allocation to help memory manager
  35
  36 Notes for some targets:
  37
  38 - For MSDOS, the small and medium models have been tested only with
  39   Microsoft C.  (This should work for Borland C also, but I don't have
  40   a Borland compiler to test with.) The small model was tested with
  41   Turbo C but only with reduced performance to avoid any far
  42   allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
  43
  44   MS Visual C++1.5 in far model gives:
  45      warning C4746: 'z_errmsg' : unsized array treated as '__far'
  46      warning C4746: 'inflate_mask' : unsized array treated as  '__far'
  47   Ignore those warnings.
  48
  49 - For 64-bit Iris, deflate.c must be compiled without any optimization.
  50   With -O, one libpng test fails. The test works in 32 bit mode (with the
  51   -32 compiler flag).
  52
  53
  54 Copyright notice:
  55
  56  (C) 1995-1996 Jean-loup Gailly and Mark Adler
  57
  58   This software is provided 'as-is', without any express or implied
  59   warranty.  In no event will the authors be held liable for any damages
  60   arising from the use of this software.
  61
  62   Permission is granted to anyone to use this software for any purpose,
  63   including commercial applications, and to alter it and redistribute it
  64   freely, subject to the following restrictions:
  65
  66   1. The origin of this software must not be misrepresented; you must not
  67      claim that you wrote the original software. If you use this software
  68      in a product, an acknowledgment in the product documentation would be
  69      appreciated but is not required.
  70   2. Altered source versions must be plainly marked as such, and must not be
  71      misrepresented as being the original software.
  72   3. This notice may not be removed or altered from any source distribution.
  73
  74   Jean-loup Gailly        Mark Adler
  75   gzip@prep.ai.mit.edu    madler@alumni.caltech.edu
  76
  77 If you use the zlib library in a product, we would appreciate *not*
  78 receiving lengthy legal documents to sign. The sources are provided
  79 for free but without warranty of any kind.  The library has been
  80 entirely written by Jean-loup Gailly and Mark Adler; it does not
  81 include third-party code.
  82
  83 If you redistribute modified sources, we would appreciate that you include
  84 in the file ChangeLog history information documenting your changes.