Bug 131826: checked in the README file of zlib 1.1.4.

security/nss/cmd/zlib/README

@@ -1,74 +1,122 @@
-zlib 1.0.4 is a general purpose data compression library.  All the code
+zlib 1.1.4 is a general purpose data compression library.  All the code
-is reentrant (thread safe).  The data format used by the zlib library
+is thread safe.  The data format used by the zlib library
 is described by RFCs (Request for Comments) 1950 to 1952 in the files 
-ftp://ds.internic.net/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate
+http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate
 format) and rfc1952.txt (gzip format). These documents are also available in
 other formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
 
-All functions of the compression library are documented in the file
+All functions of the compression library are documented in the file zlib.h
-zlib.h. A usage example of the library is given in the file example.c
+(volunteer to write man pages welcome, contact jloup@gzip.org). A usage
-which also tests that the library is working correctly. Another
+example of the library is given in the file example.c which also tests that
-example is given in the file minigzip.c. The compression library itself
+the library is working correctly. Another example is given in the file
-is composed of all source files except example.c and minigzip.c.
+minigzip.c. The compression library itself is composed of all source files
+except example.c and minigzip.c.
 
 To compile all files and run the test program, follow the instructions
 given at the top of Makefile. In short "make test; make install"
-should work for most machines.  For MSDOS, use one of the special
+should work for most machines. For Unix: "./configure; make test; make install"
-makefiles such as Makefile.msc; for VMS, use Make_vms.com or descrip.mms.
+For MSDOS, use one of the special makefiles such as Makefile.msc.
+For VMS, use Make_vms.com or descrip.mms.
 
-Questions about zlib should be sent to <zlib@quest.jpl.nasa.gov> or,
+Questions about zlib should be sent to <zlib@gzip.org>, or to
-if this fails, to the addresses given below in the Copyright section.
+Gilles Vollant <info@winimage.com> for the Windows DLL version.
-The zlib home page is http://quest.jpl.nasa.gov/zlib/
+The zlib home page is http://www.zlib.org or http://www.gzip.org/zlib/
+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.
 
-The changes made in version 1.0.4 are documented in the file ChangeLog.
+PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html
-The main changes since 1.0.3 are:
+before asking for help.
 
-- In very rare conditions, deflate(s, Z_FINISH) could fail to produce an EOF
+Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997
-  bit, so the decompressor could decompress all the correct data but went
+issue of  Dr. Dobb's Journal; a copy of the article is available in
-  on to attempt decompressing extra garbage data. This affected minigzip too.
+http://dogma.net/markn/articles/zlibtool/zlibtool.htm
-- zlibVersion and gzerror return const char* (needed for DLL)
-- port to RISCOS (no fdopen, no multiple dots, no unlink, no fileno)
 
+The changes made in version 1.1.4 are documented in the file ChangeLog.
+The only changes made since 1.1.3 are bug corrections:
+
+- ZFREE was repeated on same allocation on some error conditions.
+  This creates a security problem described in
+  http://www.zlib.org/advisory-2002-03-11.txt
+- Returned incorrect error (Z_MEM_ERROR) on some invalid data
+- Avoid accesses before window for invalid distances with inflate window
+  less than 32K.
+- force windowBits > 8 to avoid a bug in the encoder for a window size
+  of 256 bytes. (A complete fix will be available in 1.1.5).
+
+The beta version 1.1.5beta includes many more changes. A new official
+version 1.1.5 will be released as soon as extensive testing has been
+completed on it.
+
+
+Unsupported third party contributions are provided in directory "contrib".
+
+A Java implementation of zlib is available in the Java Development Kit
+http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
+See the zlib home page http://www.zlib.org for details.
 
 A Perl interface to zlib written by Paul Marquess <pmarquess@bfsec.bt.co.uk>
-is in the CPAN (Comprehensive Perl Archive Network) sites, such as:
+is in the CPAN (Comprehensive Perl Archive Network) sites
-ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
+http://www.cpan.org/modules/by-module/Compress/
+
+A Python interface to zlib written by A.M. Kuchling <amk@magnet.com>
+is available in Python 1.5 and later versions, see
+http://www.python.org/doc/lib/module-zlib.html
+
+A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com>
+is availlable at http://www.westend.com/~kupries/doc/trf/man/man.html
+
+An experimental package to read and write files in .zip format,
+written on top of zlib by Gilles Vollant <info@winimage.com>, is
+available at http://www.winimage.com/zLibDll/unzip.html
+and also in the contrib/minizip directory of zlib.
 
 
 Notes for some targets:
 
-- For Turbo C the small model is supported only with reduced performance to
+- To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc
-  avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
+  and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL
+  The zlib DLL support was initially done by Alessandro Iacopetti and is
+  now maintained by Gilles Vollant <info@winimage.com>. Check the zlib DLL
+  home page at http://www.winimage.com/zLibDll
 
-- For 64-bit Iris, deflate.c must be compiled without any optimization.
+  From Visual Basic, you can call the DLL functions which do not take
+  a structure as argument: compress, uncompress and all gz* functions.
+  See contrib/visual-basic.txt for more information, or get
+  http://www.tcfb.com/dowseware/cmp-z-it.zip
+
+- 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 -32 compiler flag). The compiler bug has been reported to SGI.
+  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.
 
-- zlib doesn't work on HP-UX 9.05 with one cc compiler (the one not
+- on Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1
-  accepting the -O option). It works with the other cc compiler.
+  is necessary to get gzprintf working correctly. This is done by configure.
 
-- To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc
+- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works
-  and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL
+  with other compilers. Use "make test" to check your compiler.
-  For help on building a zlib DLL, contact Alessandro Iacopetti
-  <iaco@email.alessandria.alpcom.it>  http://lisa.unial.it/iaco ,
-  or contact Brad Clarke <bclarke@cyberus.ca>.
 
-- gzdopen is not supported on RISCOS
+- gzdopen is not supported on RISCOS, BEOS and by some Mac compilers.
+
+- For Turbo C the small model is supported only with reduced performance to
+  avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
+
+- For PalmOs, see http://www.cs.uit.no/~perm/PASTA/pilot/software.html
+  Per Harald Myrvang <perm@stud.cs.uit.no>
 
 
 Acknowledgments:
 
   The deflate format used by zlib was defined by Phil Katz. The deflate
-  and zlib specifications were written by Peter Deutsch. Thanks to all the
+  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-2002 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
@@ -87,7 +135,7 @@ 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
+  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