Don't bother computing check value after successful inflateSync().

[zlib.git] / zlib.3

diff --git a/zlib.3 b/zlib.3
index db44e9d3cd9bc42571ae26bf13d56d826c7dfb71..fac206b526f0b068bf9a7ee9c7e2c4fadedfa90b 100644 (file)
--- a/zlib.3
+++ b/zlib.3
@@ -1,4 +1,4 @@
-.TH ZLIB 3 "8 January 2010"
+.TH ZLIB 3 "xx Jan 2017"

 .SH NAME
 zlib \- compression/decompression library
 .SH SYNOPSIS
 .SH NAME
 zlib \- compression/decompression library
 .SH SYNOPSIS


@@ -9,15 +9,15 @@ for full description]
 The
 .I zlib
 library is a general purpose data compression library.
 The
 .I zlib
 library is a general purpose data compression library.

-The code is 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
 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


@@ -30,91 +30,63 @@ 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,
 .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.
+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
 .IR zlib.h .
 The distribution source includes examples of use of the library
 in the files
 .LP
 All functions of the compression library are documented in the file
 .IR zlib.h .
 The distribution source includes examples of use of the library
 in the files

-.I example.c
+.I test/example.c

 and
 and

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

 .LP
 Changes to this version are documented in the file
 .I ChangeLog
 .LP
 Changes to this version are documented in the file
 .I ChangeLog

-that accompanies the source,
-and are concerned primarily with bug fixes and portability enhancements.
+that accompanies the source.

 .LP
 .LP

-A Java implementation of

 .I zlib
 .I 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
-.LP
-A Perl interface to
-.IR zlib ,
-written by Paul Marquess (pmqs@cpan.org),
-is available at CPAN (Comprehensive Perl Archive Network) sites,
-including:
-.IP
-http://www.cpan.org/modules/by-module/Compress/
-.LP
-A Python interface to
-.IR zlib ,
-written by A.M. Kuchling (amk@magnet.com),
-is available in Python 1.5 and later versions:
-.IP
-http://www.python.org/doc/lib/module-zlib.html
+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
-.I zlib
-binding for
-.IR tcl (1),
-written by Andreas Kupries (a.kupries@westend.com),
-is availlable at:
-.IP
-http://www.westend.com/~kupries/doc/trf/man/man.html
-.LP
-An experimental package to read and write files in .zip format,
+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
 written on top of
 .I zlib
 by Gilles Vollant (info@winimage.com),
 is available at:
 .IP

-http://www.winimage.com/zLibDll/unzip.html
+http://www.winimage.com/zLibDll/minizip.html

 and also in the
 .I contrib/minizip
 directory of the main
 .I zlib
 and also in the
 .I contrib/minizip
 directory of the main
 .I zlib

-web site.
+source distribution.

 .SH "SEE ALSO"
 The
 .I zlib
 .SH "SEE ALSO"
 The
 .I zlib

-web site can be found at either of these locations:
+web site can be found at:

 .IP
 .IP

-http://www.zlib.org
-.br
-http://www.gzip.org/zlib/
+http://zlib.net/

 .LP
 .LP

-The data format used by the zlib library is described by RFC
+The data format used by the
+.I zlib
+library is described by RFC

 (Request for Comments) 1950 to 1952 in the files:
 .IP
 (Request for Comments) 1950 to 1952 in the files:
 .IP

-http://www.ietf.org/rfc/rfc1950.txt (concerning zlib format)
+http://tools.ietf.org/html/rfc1950 (for the zlib header and trailer format)

 .br
 .br

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

 .br
 .br

-http://www.ietf.org/rfc/rfc1952.txt (concerning gzip format)
-.LP
-These documents are also available in other formats from:
-.IP
-ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
+http://tools.ietf.org/html/rfc1952 (for the gzip header and trailer format)

 .LP
 .LP

-Mark Nelson (markn@ieee.org) wrote an article about
+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
 .I zlib
 for the Jan. 1997 issue of  Dr. Dobb's Journal;
 a copy of the article is available at:
 .IP

-http://dogma.net/markn/articles/zlibtool/zlibtool.htm
+http://marknelson.us/1997/01/01/zlib-engine/

 .SH "REPORTING PROBLEMS"
 Before reporting a problem,
 please check the
 .SH "REPORTING PROBLEMS"
 Before reporting a problem,
 please check the


@@ -127,22 +99,40 @@ Please read the
 .I zlib
 FAQ at:
 .IP
 .I zlib
 FAQ at:
 .IP

-http://www.gzip.org/zlib/zlib_faq.html
+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).
 .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
-Version 1.2.3.5
-Copyright (C) 1995-2009 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
+.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 format used by
 .I zlib
 was defined by Phil Katz.