cpython-lru_cache-weakref: Modules/zlib/zlib.3 annotate

annotate Modules/zlib/zlib.3 @ 78069:a8aa77458e12 3.2

Add c_size_t and c_ssize_t to the ctypes summary table.

author	Antoine Pitrou <solipsis@pitrou.net>
date	Thu, 12 Jul 2012 20:31:50 +0200
parents	467019588fcc
children	224aa49f22f1

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

Mercurial > cpython-lru_cache-weakref

annotate Modules/zlib/zlib.3 @ 78069:a8aa77458e12 3.2