]> git.proxmox.com Git - mirror_edk2.git/blame - AppPkg/Applications/Python/Python-2.7.2/Modules/zlib/zlib.3
EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS
[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Modules / zlib / zlib.3
CommitLineData
4710c53d 1.TH ZLIB 3 "18 July 2005"\r
2.SH NAME\r
3zlib \- compression/decompression library\r
4.SH SYNOPSIS\r
5[see\r
6.I zlib.h\r
7for full description]\r
8.SH DESCRIPTION\r
9The\r
10.I zlib\r
11library is a general purpose data compression library.\r
12The code is thread safe.\r
13It provides in-memory compression and decompression functions,\r
14including integrity checks of the uncompressed data.\r
15This version of the library supports only one compression method (deflation)\r
16but other algorithms will be added later\r
17and will have the same stream interface.\r
18.LP\r
19Compression can be done in a single step if the buffers are large enough\r
20(for example if an input file is mmap'ed),\r
21or can be done by repeated calls of the compression function.\r
22In the latter case,\r
23the application must provide more input and/or consume the output\r
24(providing more output space) before each call.\r
25.LP\r
26The library also supports reading and writing files in\r
27.IR gzip (1)\r
28(.gz) format\r
29with an interface similar to that of stdio.\r
30.LP\r
31The library does not install any signal handler.\r
32The decoder checks the consistency of the compressed data,\r
33so the library should never crash even in case of corrupted input.\r
34.LP\r
35All functions of the compression library are documented in the file\r
36.IR zlib.h .\r
37The distribution source includes examples of use of the library\r
38in the files\r
39.I example.c\r
40and\r
41.IR minigzip.c .\r
42.LP\r
43Changes to this version are documented in the file\r
44.I ChangeLog\r
45that accompanies the source,\r
46and are concerned primarily with bug fixes and portability enhancements.\r
47.LP\r
48A Java implementation of\r
49.I zlib\r
50is available in the Java Development Kit 1.1:\r
51.IP\r
52http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html\r
53.LP\r
54A Perl interface to\r
55.IR zlib ,\r
56written by Paul Marquess (pmqs@cpan.org),\r
57is available at CPAN (Comprehensive Perl Archive Network) sites,\r
58including:\r
59.IP\r
60http://www.cpan.org/modules/by-module/Compress/\r
61.LP\r
62A Python interface to\r
63.IR zlib ,\r
64written by A.M. Kuchling (amk@magnet.com),\r
65is available in Python 1.5 and later versions:\r
66.IP\r
67http://www.python.org/doc/lib/module-zlib.html\r
68.LP\r
69A\r
70.I zlib\r
71binding for\r
72.IR tcl (1),\r
73written by Andreas Kupries (a.kupries@westend.com),\r
74is availlable at:\r
75.IP\r
76http://www.westend.com/~kupries/doc/trf/man/man.html\r
77.LP\r
78An experimental package to read and write files in .zip format,\r
79written on top of\r
80.I zlib\r
81by Gilles Vollant (info@winimage.com),\r
82is available at:\r
83.IP\r
84http://www.winimage.com/zLibDll/unzip.html\r
85and also in the\r
86.I contrib/minizip\r
87directory of the main\r
88.I zlib\r
89web site.\r
90.SH "SEE ALSO"\r
91The\r
92.I zlib\r
93web site can be found at either of these locations:\r
94.IP\r
95http://www.zlib.org\r
96.br\r
97http://www.gzip.org/zlib/\r
98.LP\r
99The data format used by the zlib library is described by RFC\r
100(Request for Comments) 1950 to 1952 in the files:\r
101.IP\r
102http://www.ietf.org/rfc/rfc1950.txt (concerning zlib format)\r
103.br\r
104http://www.ietf.org/rfc/rfc1951.txt (concerning deflate format)\r
105.br\r
106http://www.ietf.org/rfc/rfc1952.txt (concerning gzip format)\r
107.LP\r
108These documents are also available in other formats from:\r
109.IP\r
110ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html\r
111.LP\r
112Mark Nelson (markn@ieee.org) wrote an article about\r
113.I zlib\r
114for the Jan. 1997 issue of Dr. Dobb's Journal;\r
115a copy of the article is available at:\r
116.IP\r
117http://dogma.net/markn/articles/zlibtool/zlibtool.htm\r
118.SH "REPORTING PROBLEMS"\r
119Before reporting a problem,\r
120please check the\r
121.I zlib\r
122web site to verify that you have the latest version of\r
123.IR zlib ;\r
124otherwise,\r
125obtain the latest version and see if the problem still exists.\r
126Please read the\r
127.I zlib\r
128FAQ at:\r
129.IP\r
130http://www.gzip.org/zlib/zlib_faq.html\r
131.LP\r
132before asking for help.\r
133Send questions and/or comments to zlib@gzip.org,\r
134or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).\r
135.SH AUTHORS\r
136Version 1.2.3\r
137Copyright (C) 1995-2005 Jean-loup Gailly (jloup@gzip.org)\r
138and Mark Adler (madler@alumni.caltech.edu).\r
139.LP\r
140This software is provided "as-is,"\r
141without any express or implied warranty.\r
142In no event will the authors be held liable for any damages\r
143arising from the use of this software.\r
144See the distribution directory with respect to requirements\r
145governing redistribution.\r
146The deflate format used by\r
147.I zlib\r
148was defined by Phil Katz.\r
149The deflate and\r
150.I zlib\r
151specifications were written by L. Peter Deutsch.\r
152Thanks to all the people who reported problems and suggested various\r
153improvements in\r
154.IR zlib ;\r
155who are too numerous to cite here.\r
156.LP\r
157UNIX manual page by R. P. C. Rodgers,\r
158U.S. National Library of Medicine (rodgers@nlm.nih.gov).\r
159.\" end of man page\r