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