]> git.lizzy.rs Git - zlib.git/blobdiff - README
CMake build fixes
[zlib.git] / README
diff --git a/README b/README
index b4ad14e08cb17493762126621064ff41d37432b3..024b79d3d8c8b84ceaab461e04a9a7d3c6d46bb9 100644 (file)
--- a/README
+++ b/README
@@ -1,59 +1,90 @@
-zlib 1.0 is a general purpose data compression library.
-All the code is reentrant (thread safe).
-
-The data format used by the zlib library is described in the
-files zlib-3.2.doc, deflate-1.2.doc and gzip-4.2.doc, available
-in ftp://ftp.uu.net/pub/archiving/zip/doc
-
-All functions of the compression library are documented in the file
-zlib.h. A usage example of the library is given in the file example.c
-which also tests that the library is working correctly. Another
-example is given in the file minigzip.c.
-
-To compile all files and run the test program, just type: make test
-(For MSDOS, use one of the special makefiles such as Makefile.msc;
-for VMS, use Make_vms.com or descrip.mms.)
-To install the zlib library (libz.a) in /usr/local/lib, type: make install
-To install in a different directory, use for example:
-  make install prefix=$HOME
-This will install in $HOME/lib instead of /usr/local/lib.
-
-Questions about zlib should be sent to <zlib@quest.jpl.nasa.gov>.
-
-The changes made in version 1.0 are documented in the file ChangeLog.
-The main changes since 0.95 are:
-- allow compression level 0 (no compression)
-- add deflateParams in zlib.h: allow dynamic change of compression level
-  and compression strategy.
-- test large buffers and deflateParams in example.c
-- declare Z_DEFLATED in zlib.h (possible parameter for deflateInit2)
-- fixes for 64-bit systems (needed for Alpha and Cray)
-- always return Z_BUF_ERROR when deflate() has nothing to do
-- fix some very unlikely race conditions.
-- several minor fixes for better portability
-- free in reverse order of allocation to help memory manager
+ZLIB DATA COMPRESSION LIBRARY
+
+zlib 1.2.12 is a general purpose data compression library.  All the code is
+thread safe.  The data format used by the zlib library is described by RFCs
+(Request for Comments) 1950 to 1952 in the files
+http://tools.ietf.org/html/rfc1950 (zlib format), rfc1951 (deflate format) and
+rfc1952 (gzip format).
+
+All functions of the compression library are documented in the file zlib.h
+(volunteer to write man pages welcome, contact zlib@gzip.org).  A usage example
+of the library is given in the file test/example.c which also tests that
+the library is working correctly.  Another example is given in the file
+test/minigzip.c.  The compression library itself is composed of all source
+files in the root directory.
+
+To compile all files and run the test program, follow the instructions given at
+the top of Makefile.in.  In short "./configure; make test", and if that goes
+well, "make install" should work for most flavors of Unix.  For Windows, use
+one of the special makefiles in win32/ or contrib/vstudio/ .  For VMS, use
+make_vms.com.
+
+Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant
+<info@winimage.com> for the Windows DLL version.  The zlib home page is
+http://zlib.net/ .  Before reporting a problem, please check this site to
+verify that you have the latest version of zlib; otherwise get the latest
+version and check whether the problem still exists or not.
+
+PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help.
+
+Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan.  1997
+issue of Dr.  Dobb's Journal; a copy of the article is available at
+http://marknelson.us/1997/01/01/zlib-engine/ .
+
+The changes made in version 1.2.12 are documented in the file ChangeLog.
+
+Unsupported third party contributions are provided in directory contrib/ .
+
+zlib is available in Java using the java.util.zip package, documented at
+http://java.sun.com/developer/technicalArticles/Programming/compression/ .
+
+A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available
+at CPAN (Comprehensive Perl Archive Network) sites, including
+http://search.cpan.org/~pmqs/IO-Compress-Zlib/ .
+
+A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is
+available in Python 1.5 and later versions, see
+http://docs.python.org/library/zlib.html .
+
+zlib is built into tcl: http://wiki.tcl.tk/4610 .
+
+An experimental package to read and write files in .zip format, written on top
+of zlib by Gilles Vollant <info@winimage.com>, is available in the
+contrib/minizip directory of zlib.
+
 
 Notes for some targets:
 
-- For MSDOS, the small and medium models have been tested only with
-  Microsoft C.  (This should work for Borland C also, but I don't have
-  a Borland compiler to test with.) The small model was tested with
-  Turbo C but only with reduced performance to avoid any far
-  allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
+- For Windows DLL versions, please see win32/DLL_FAQ.txt
+
+- For 64-bit Irix, deflate.c must be compiled without any optimization. With
+  -O, one libpng test fails. The test works in 32 bit mode (with the -n32
+  compiler flag). The compiler bug has been reported to SGI.
+
+- zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works
+  when compiled with cc.
+
+- On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is
+  necessary to get gzprintf working correctly. This is done by configure.
 
-  MS Visual C++1.5 in far model gives:
-     warning C4746: 'z_errmsg' : unsized array treated as '__far'
-     warning C4746: 'inflate_mask' : unsized array treated as  '__far'
-  Ignore those warnings.
+- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with
+  other compilers. Use "make test" to check your compiler.
 
-- For 64-bit Iris, deflate.c must be compiled without any optimization.
-  With -O, one libpng test fails. The test works in 32 bit mode (with the
-  -32 compiler flag).
+- gzdopen is not supported on RISCOS or BEOS.
 
+- For PalmOs, see http://palmzlib.sourceforge.net/
+
+
+Acknowledgments:
+
+  The deflate format used by zlib was defined by Phil Katz.  The deflate and
+  zlib specifications were written by L.  Peter Deutsch.  Thanks to all the
+  people who reported problems and suggested various improvements in zlib; they
+  are too numerous to cite here.
 
 Copyright notice:
 
- (C) 1995-1996 Jean-loup Gailly and Mark Adler
+ (C) 1995-2022 Jean-loup Gailly and Mark Adler
 
   This software is provided 'as-is', without any express or implied
   warranty.  In no event will the authors be held liable for any damages
@@ -72,13 +103,16 @@ Copyright notice:
   3. This notice may not be removed or altered from any source distribution.
 
   Jean-loup Gailly        Mark Adler
-  gzip@prep.ai.mit.edu    madler@alumni.caltech.edu
-
-If you use the zlib library in a product, we would appreciate *not*
-receiving lengthy legal documents to sign. The sources are provided
-for free but without warranty of any kind.  The library has been
-entirely written by Jean-loup Gailly and Mark Adler; it does not
-include third-party code.
-
-If you redistribute modified sources, we would appreciate that you include
-in the file ChangeLog history information documenting your changes.
+  jloup@gzip.org          madler@alumni.caltech.edu
+
+If you use the zlib library in a product, we would appreciate *not* receiving
+lengthy legal documents to sign.  The sources are provided for free but without
+warranty of any kind.  The library has been entirely written by Jean-loup
+Gailly and Mark Adler; it does not include third-party code.  We make all
+contributions to and distributions of this project solely in our personal
+capacity, and are not conveying any rights to any intellectual property of
+any third parties.
+
+If you redistribute modified sources, we would appreciate that you include in
+the file ChangeLog history information documenting your changes.  Please read
+the FAQ for more information on the distribution of modified source versions.