Mercurial > hg > sv-dependency-builds

annotate src/zlib-1.2.7/zlib.3 @ 169:223a55898ab9 tip default

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