Mercurial > hg > sv-dependency-builds

annotate src/zlib-1.2.8/zlib.3 @ 140:59a8758c56b1

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