Mercurial > hg > sv-dependency-builds

annotate src/zlib-1.2.8/zlib.3 @ 65:a69c1527268d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
OSX binaries for Cap'n Proto
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 05 Jul 2017 09:46:34 +0100
parents 5ea0608b923f
children
rev   line source
Chris@43 1 .TH ZLIB 3 "28 Apr 2013"
Chris@43 2 .SH NAME
Chris@43 3 zlib \- compression/decompression library
Chris@43 4 .SH SYNOPSIS
Chris@43 5 [see
Chris@43 6 .I zlib.h
Chris@43 7 for full description]
Chris@43 8 .SH DESCRIPTION
Chris@43 9 The
Chris@43 10 .I zlib
Chris@43 11 library is a general purpose data compression library.
Chris@43 12 The code is thread safe, assuming that the standard library functions
Chris@43 13 used are thread safe, such as memory allocation routines.
Chris@43 14 It provides in-memory compression and decompression functions,
Chris@43 15 including integrity checks of the uncompressed data.
Chris@43 16 This version of the library supports only one compression method (deflation)
Chris@43 17 but other algorithms may be added later
Chris@43 18 with the same stream interface.
Chris@43 19 .LP
Chris@43 20 Compression can be done in a single step if the buffers are large enough
Chris@43 21 or can be done by repeated calls of the compression function.
Chris@43 22 In the latter case,
Chris@43 23 the application must provide more input and/or consume the output
Chris@43 24 (providing more output space) before each call.
Chris@43 25 .LP
Chris@43 26 The library also supports reading and writing files in
Chris@43 27 .IR gzip (1)
Chris@43 28 (.gz) format
Chris@43 29 with an interface similar to that of stdio.
Chris@43 30 .LP
Chris@43 31 The library does not install any signal handler.
Chris@43 32 The decoder checks the consistency of the compressed data,
Chris@43 33 so the library should never crash even in the case of corrupted input.
Chris@43 34 .LP
Chris@43 35 All functions of the compression library are documented in the file
Chris@43 36 .IR zlib.h .
Chris@43 37 The distribution source includes examples of use of the library
Chris@43 38 in the files
Chris@43 39 .I test/example.c
Chris@43 40 and
Chris@43 41 .IR test/minigzip.c,
Chris@43 42 as well as other examples in the
Chris@43 43 .IR examples/
Chris@43 44 directory.
Chris@43 45 .LP
Chris@43 46 Changes to this version are documented in the file
Chris@43 47 .I ChangeLog
Chris@43 48 that accompanies the source.
Chris@43 49 .LP
Chris@43 50 .I zlib
Chris@43 51 is available in Java using the java.util.zip package:
Chris@43 52 .IP
Chris@43 53 http://java.sun.com/developer/technicalArticles/Programming/compression/
Chris@43 54 .LP
Chris@43 55 A Perl interface to
Chris@43 56 .IR zlib ,
Chris@43 57 written by Paul Marquess (pmqs@cpan.org),
Chris@43 58 is available at CPAN (Comprehensive Perl Archive Network) sites,
Chris@43 59 including:
Chris@43 60 .IP
Chris@43 61 http://search.cpan.org/~pmqs/IO-Compress-Zlib/
Chris@43 62 .LP
Chris@43 63 A Python interface to
Chris@43 64 .IR zlib ,
Chris@43 65 written by A.M. Kuchling (amk@magnet.com),
Chris@43 66 is available in Python 1.5 and later versions:
Chris@43 67 .IP
Chris@43 68 http://docs.python.org/library/zlib.html
Chris@43 69 .LP
Chris@43 70 .I zlib
Chris@43 71 is built into
Chris@43 72 .IR tcl:
Chris@43 73 .IP
Chris@43 74 http://wiki.tcl.tk/4610
Chris@43 75 .LP
Chris@43 76 An experimental package to read and write files in .zip format,
Chris@43 77 written on top of
Chris@43 78 .I zlib
Chris@43 79 by Gilles Vollant (info@winimage.com),
Chris@43 80 is available at:
Chris@43 81 .IP
Chris@43 82 http://www.winimage.com/zLibDll/minizip.html
Chris@43 83 and also in the
Chris@43 84 .I contrib/minizip
Chris@43 85 directory of the main
Chris@43 86 .I zlib
Chris@43 87 source distribution.
Chris@43 88 .SH "SEE ALSO"
Chris@43 89 The
Chris@43 90 .I zlib
Chris@43 91 web site can be found at:
Chris@43 92 .IP
Chris@43 93 http://zlib.net/
Chris@43 94 .LP
Chris@43 95 The data format used by the zlib library is described by RFC
Chris@43 96 (Request for Comments) 1950 to 1952 in the files:
Chris@43 97 .IP
Chris@43 98 http://tools.ietf.org/html/rfc1950 (for the zlib header and trailer format)
Chris@43 99 .br
Chris@43 100 http://tools.ietf.org/html/rfc1951 (for the deflate compressed data format)
Chris@43 101 .br
Chris@43 102 http://tools.ietf.org/html/rfc1952 (for the gzip header and trailer format)
Chris@43 103 .LP
Chris@43 104 Mark Nelson wrote an article about
Chris@43 105 .I zlib
Chris@43 106 for the Jan. 1997 issue of Dr. Dobb's Journal;
Chris@43 107 a copy of the article is available at:
Chris@43 108 .IP
Chris@43 109 http://marknelson.us/1997/01/01/zlib-engine/
Chris@43 110 .SH "REPORTING PROBLEMS"
Chris@43 111 Before reporting a problem,
Chris@43 112 please check the
Chris@43 113 .I zlib
Chris@43 114 web site to verify that you have the latest version of
Chris@43 115 .IR zlib ;
Chris@43 116 otherwise,
Chris@43 117 obtain the latest version and see if the problem still exists.
Chris@43 118 Please read the
Chris@43 119 .I zlib
Chris@43 120 FAQ at:
Chris@43 121 .IP
Chris@43 122 http://zlib.net/zlib_faq.html
Chris@43 123 .LP
Chris@43 124 before asking for help.
Chris@43 125 Send questions and/or comments to zlib@gzip.org,
Chris@43 126 or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
Chris@43 127 .SH AUTHORS
Chris@43 128 Version 1.2.8
Chris@43 129 Copyright (C) 1995-2013 Jean-loup Gailly (jloup@gzip.org)
Chris@43 130 and Mark Adler (madler@alumni.caltech.edu).
Chris@43 131 .LP
Chris@43 132 This software is provided "as-is,"
Chris@43 133 without any express or implied warranty.
Chris@43 134 In no event will the authors be held liable for any damages
Chris@43 135 arising from the use of this software.
Chris@43 136 See the distribution directory with respect to requirements
Chris@43 137 governing redistribution.
Chris@43 138 The deflate format used by
Chris@43 139 .I zlib
Chris@43 140 was defined by Phil Katz.
Chris@43 141 The deflate and
Chris@43 142 .I zlib
Chris@43 143 specifications were written by L. Peter Deutsch.
Chris@43 144 Thanks to all the people who reported problems and suggested various
Chris@43 145 improvements in
Chris@43 146 .IR zlib ;
Chris@43 147 who are too numerous to cite here.
Chris@43 148 .LP
Chris@43 149 UNIX manual page by R. P. C. Rodgers,
Chris@43 150 U.S. National Library of Medicine (rodgers@nlm.nih.gov).
Chris@43 151 .\" end of man page