Limit hash table inserts after switch from stored deflate.

[zlib.git] / zlib.3

diff --git a/zlib.3 b/zlib.3
index 764ecd7758aa23fd66a80c96e4d780755dc85490..fac206b526f0b068bf9a7ee9c7e2c4fadedfa90b 100644 (file)
--- a/zlib.3
+++ b/zlib.3
@@ -1,102 +1,144 @@
-.TH ZLIB 3 "20 January 1998"
+.TH ZLIB 3 "xx Jan 2017"

 .SH NAME
 zlib \- compression/decompression library
 .SH SYNOPSIS
 [see
 .I zlib.h
 .SH NAME
 zlib \- compression/decompression library
 .SH SYNOPSIS
 [see
 .I zlib.h

-for full descripton]
+for full description]

 .SH DESCRIPTION
 The
 .I zlib
 library is a general purpose data compression library.
 .SH DESCRIPTION
 The
 .I zlib
 library is a general purpose data compression library.

-The code is reentrant (thread safe).
+The code is thread safe, assuming that the standard library functions
+used are thread safe, such as memory allocation routines.

 It provides in-memory compression and decompression functions,
 including integrity checks of the uncompressed data.
 This version of the library supports only one compression method (deflation)
 It provides in-memory compression and decompression functions,
 including integrity checks of the uncompressed data.
 This version of the library supports only one compression method (deflation)

-but other algorithms will be added later and will have the same stream interface.
+but other algorithms may be added later
+with the same stream interface.

 .LP
 Compression can be done in a single step if the buffers are large enough
 .LP
 Compression can be done in a single step if the buffers are large enough

-(for example if an input file is mmap'ed),

 or can be done by repeated calls of the compression function.
 In the latter case,
 the application must provide more input and/or consume the output
 (providing more output space) before each call.
 .LP
 The library also supports reading and writing files in
 or can be done by repeated calls of the compression function.
 In the latter case,
 the application must provide more input and/or consume the output
 (providing more output space) before each call.
 .LP
 The library also supports reading and writing files in

-.I gzip
+.IR gzip (1)

 (.gz) format
 with an interface similar to that of stdio.
 .LP
 (.gz) format
 with an interface similar to that of stdio.
 .LP

-The library does not install any signal handler. The decoder checks
-the consistency of the compressed data, so the library should never
-crash even in case of corrupted input.
+The library does not install any signal handler.
+The decoder checks the consistency of the compressed data,
+so the library should never crash even in the case of corrupted input.

 .LP
 All functions of the compression library are documented in the file
 .LP
 All functions of the compression library are documented in the file

-.IR zlib.h.
+.IR zlib.h .

 The distribution source includes examples of use of the library
 The distribution source includes examples of use of the library

-the files
-.I example.c
+in the files
+.I test/example.c

 and
 and

-.IR minigzip.c .
+.IR test/minigzip.c,
+as well as other examples in the
+.IR examples/
+directory.

 .LP
 .LP

-A Java implementation of
-.IR zlib
-is available in the Java Development Kit 1.1
-.IP
-http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
+Changes to this version are documented in the file
+.I ChangeLog
+that accompanies the source.

 .LP
 .LP

-A Perl interface to
-.IR zlib ,
-written by Paul Marquess (pmarquess@bfsec.bt.co.uk)
-is available at CPAN (Comprehensive Perl Archive Network) sites,
-such as:
-.IP
-ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
+.I zlib
+is built in to many languages and operating systems, including but not limited to
+Java, Python, .NET, PHP, Perl, Ruby, Swift, and Go.

 .LP
 .LP

-A Python interface to
-.IR zlib
-written by A.M. Kuchling <amk@magnet.com>
-is available from the Python Software Association sites, such as:
+An experimental package to read and write files in the .zip format,
+written on top of
+.I zlib
+by Gilles Vollant (info@winimage.com),
+is available at:

 .IP
 .IP

-ftp://ftp.python.org/pub/python/contrib/Encoding/zlib*.tar.gz
+http://www.winimage.com/zLibDll/minizip.html
+and also in the
+.I contrib/minizip
+directory of the main
+.I zlib
+source distribution.

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-Questions about zlib should be sent to:
-.IP
-zlib@quest.jpl.nasa.gov
-or, if this fails, to the author addresses given below.
-The zlib home page is:
+The
+.I zlib
+web site can be found at:

 .IP
 .IP

-http://www.cdrom.com/infozip/zlib/
+http://zlib.net/

 .LP
 .LP

-The data format used by the zlib library is described by RFC
-(Request for Comments) 1950 to 1952 in the files: 
+The data format used by the
+.I zlib
+library is described by RFC
+(Request for Comments) 1950 to 1952 in the files:

 .IP
 .IP

-ftp://ds.internic.net/rfc/rfc1950.txt (zlib format)
+http://tools.ietf.org/html/rfc1950 (for the zlib header and trailer format)

 .br
 .br

-rfc1951.txt (deflate format)
+http://tools.ietf.org/html/rfc1951 (for the deflate compressed data format)

 .br
 .br

-rfc1952.txt (gzip format)
+http://tools.ietf.org/html/rfc1952 (for the gzip header and trailer format)

 .LP
 .LP

-These documents are also available in other formats from:
+Mark Nelson wrote an article about
+.I zlib
+for the Jan. 1997 issue of  Dr. Dobb's Journal;
+a copy of the article is available at:
+.IP
+http://marknelson.us/1997/01/01/zlib-engine/
+.SH "REPORTING PROBLEMS"
+Before reporting a problem,
+please check the
+.I zlib
+web site to verify that you have the latest version of
+.IR zlib ;
+otherwise,
+obtain the latest version and see if the problem still exists.
+Please read the
+.I zlib
+FAQ at:

 .IP
 .IP

-ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
-.SH AUTHORS
-Version 1.0.7.
-Copyright (C) 1995-1998 Jean-loup Gailly (jloup@gzip.org)
-and Mark Adler (madler@alumni.caltech.edu).
-.LP
-This software is provided "as-is,"
-without any express or implied warranty.
-In no event will the authors be held liable for any damages
+http://zlib.net/zlib_faq.html
+.LP
+before asking for help.
+Send questions and/or comments to zlib@gzip.org,
+or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
+.SH AUTHORS AND LICENSE
+Version 1.2.11.1
+.LP
+Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
+.LP
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages

 arising from the use of this software.
 arising from the use of this software.

-See the distribution directory with respect to requirements
-governing redistribution.
+.LP
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+.LP
+.nr step 1 1
+.IP \n[step]. 3
+The origin of this software must not be misrepresented; you must not
+claim that you wrote the original software. If you use this software
+in a product, an acknowledgment in the product documentation would be
+appreciated but is not required.
+.IP \n+[step].
+Altered source versions must be plainly marked as such, and must not be
+misrepresented as being the original software.
+.IP \n+[step].
+This notice may not be removed or altered from any source distribution.
+.LP
+Jean-loup Gailly        Mark Adler
+.br
+jloup@gzip.org          madler@alumni.caltech.edu
+.LP

 The deflate format used by
 .I zlib
 was defined by Phil Katz.
 The deflate and
 .I zlib
 The deflate format used by
 .I zlib
 was defined by Phil Katz.
 The deflate and
 .I zlib

-specifications were written by Peter Deutsch.
+specifications were written by L. Peter Deutsch.

 Thanks to all the people who reported problems and suggested various
 improvements in
 .IR zlib ;
 Thanks to all the people who reported problems and suggested various
 improvements in
 .IR zlib ;