zlib 1.2.5.2

[zlib.git] / zlib.3

diff --git a/zlib.3 b/zlib.3
index a969834d25251189cbd3f02eccd895154f58ee05..69e28551ca721c35e164a5c8fac570cb2836ba41 100644 (file)
--- a/zlib.3
+++ b/zlib.3
@@ -1,4 +1,4 @@
-.TH ZLIB 3 "16 February 1998"
+.TH ZLIB 3 "17 Dec 2011"

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


@@ -9,80 +9,124 @@ 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
 (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
+Changes to this version are documented in the file
+.I ChangeLog
+that accompanies the source.
+.LP
+.I zlib
+is available in Java using the java.util.zip package:

 .IP
 .IP

-http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
+http://java.sun.com/developer/technicalArticles/Programming/compression/

 .LP
 A Perl interface to
 .IR zlib ,
 .LP
 A Perl interface to
 .IR zlib ,

-written by Paul Marquess (pmarquess@bfsec.bt.co.uk)
+written by Paul Marquess (pmqs@cpan.org),

 is available at CPAN (Comprehensive Perl Archive Network) sites,
 is available at CPAN (Comprehensive Perl Archive Network) sites,

-such as:
+including:

 .IP
 .IP

-ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
+http://search.cpan.org/~pmqs/IO-Compress-Zlib/

 .LP
 A Python interface to
 .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:
+.IR zlib ,
+written by A.M. Kuchling (amk@magnet.com),
+is available in Python 1.5 and later versions:

 .IP
 .IP

-ftp://ftp.python.org/pub/python/contrib/Encoding/zlib*.tar.gz
-.SH "SEE ALSO"
-Questions about zlib should be sent to:
+http://docs.python.org/library/zlib.html
+.LP
+.I zlib
+is built into
+.IR tcl:

 .IP
 .IP

-zlib@quest.jpl.nasa.gov
-or, if this fails, to the author addresses given below.
-The zlib home page is:
+http://wiki.tcl.tk/4610
+.LP
+An experimental package to read and write files in .zip format,
+written on top of
+.I zlib
+by Gilles Vollant (info@winimage.com),
+is available at:

 .IP
 .IP

-http://www.cdrom.com/pub/infozip/zlib/
+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"
+The
+.I zlib
+web site can be found at:
+.IP
+http://zlib.net/

 .LP
 The data format used by the zlib library is described by RFC
 .LP
 The data format used by the zlib library is described by RFC

-(Request for Comments) 1950 to 1952 in the files: 
+(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
 .IP

-ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
+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
+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
 .SH AUTHORS

-Version 1.0.9.
-Copyright (C) 1995-1998 Jean-loup Gailly (jloup@gzip.org)
+Version 1.2.5.2
+Copyright (C) 1995-2011 Jean-loup Gailly (jloup@gzip.org)

 and Mark Adler (madler@alumni.caltech.edu).
 .LP
 This software is provided "as-is,"
 and Mark Adler (madler@alumni.caltech.edu).
 .LP
 This software is provided "as-is,"


@@ -96,7 +140,7 @@ The deflate format used by
 was defined by Phil Katz.
 The deflate and
 .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 ;