]>
Commit | Line | Data |
---|---|---|
7eb75bcc DM |
1 | .TH ZLIB 3 "28 Apr 2013"\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, assuming that the standard library functions\r | |
13 | used are thread safe, such as memory allocation routines.\r | |
14 | It provides in-memory compression and decompression functions,\r | |
15 | including integrity checks of the uncompressed data.\r | |
16 | This version of the library supports only one compression method (deflation)\r | |
17 | but other algorithms may be added later\r | |
18 | with the same stream interface.\r | |
19 | .LP\r | |
20 | Compression can be done in a single step if the buffers are large enough\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 the 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 test/example.c\r | |
40 | and\r | |
41 | .IR test/minigzip.c,\r | |
42 | as well as other examples in the\r | |
43 | .IR examples/\r | |
44 | directory.\r | |
45 | .LP\r | |
46 | Changes to this version are documented in the file\r | |
47 | .I ChangeLog\r | |
48 | that accompanies the source.\r | |
49 | .LP\r | |
50 | .I zlib\r | |
51 | is available in Java using the java.util.zip package:\r | |
52 | .IP\r | |
53 | http://java.sun.com/developer/technicalArticles/Programming/compression/\r | |
54 | .LP\r | |
55 | A Perl interface to\r | |
56 | .IR zlib ,\r | |
57 | written by Paul Marquess (pmqs@cpan.org),\r | |
58 | is available at CPAN (Comprehensive Perl Archive Network) sites,\r | |
59 | including:\r | |
60 | .IP\r | |
61 | http://search.cpan.org/~pmqs/IO-Compress-Zlib/\r | |
62 | .LP\r | |
63 | A Python interface to\r | |
64 | .IR zlib ,\r | |
65 | written by A.M. Kuchling (amk@magnet.com),\r | |
66 | is available in Python 1.5 and later versions:\r | |
67 | .IP\r | |
68 | http://docs.python.org/library/zlib.html\r | |
69 | .LP\r | |
70 | .I zlib\r | |
71 | is built into\r | |
72 | .IR tcl:\r | |
73 | .IP\r | |
74 | http://wiki.tcl.tk/4610\r | |
75 | .LP\r | |
76 | An experimental package to read and write files in .zip format,\r | |
77 | written on top of\r | |
78 | .I zlib\r | |
79 | by Gilles Vollant (info@winimage.com),\r | |
80 | is available at:\r | |
81 | .IP\r | |
82 | http://www.winimage.com/zLibDll/minizip.html\r | |
83 | and also in the\r | |
84 | .I contrib/minizip\r | |
85 | directory of the main\r | |
86 | .I zlib\r | |
87 | source distribution.\r | |
88 | .SH "SEE ALSO"\r | |
89 | The\r | |
90 | .I zlib\r | |
91 | web site can be found at:\r | |
92 | .IP\r | |
93 | http://zlib.net/\r | |
94 | .LP\r | |
95 | The data format used by the zlib library is described by RFC\r | |
96 | (Request for Comments) 1950 to 1952 in the files:\r | |
97 | .IP\r | |
98 | http://tools.ietf.org/html/rfc1950 (for the zlib header and trailer format)\r | |
99 | .br\r | |
100 | http://tools.ietf.org/html/rfc1951 (for the deflate compressed data format)\r | |
101 | .br\r | |
102 | http://tools.ietf.org/html/rfc1952 (for the gzip header and trailer format)\r | |
103 | .LP\r | |
104 | Mark Nelson wrote an article about\r | |
105 | .I zlib\r | |
106 | for the Jan. 1997 issue of Dr. Dobb's Journal;\r | |
107 | a copy of the article is available at:\r | |
108 | .IP\r | |
109 | http://marknelson.us/1997/01/01/zlib-engine/\r | |
110 | .SH "REPORTING PROBLEMS"\r | |
111 | Before reporting a problem,\r | |
112 | please check the\r | |
113 | .I zlib\r | |
114 | web site to verify that you have the latest version of\r | |
115 | .IR zlib ;\r | |
116 | otherwise,\r | |
117 | obtain the latest version and see if the problem still exists.\r | |
118 | Please read the\r | |
119 | .I zlib\r | |
120 | FAQ at:\r | |
121 | .IP\r | |
122 | http://zlib.net/zlib_faq.html\r | |
123 | .LP\r | |
124 | before asking for help.\r | |
125 | Send questions and/or comments to zlib@gzip.org,\r | |
126 | or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).\r | |
127 | .SH AUTHORS\r | |
128 | Version 1.2.8\r | |
129 | Copyright (C) 1995-2013 Jean-loup Gailly (jloup@gzip.org)\r | |
130 | and Mark Adler (madler@alumni.caltech.edu).\r | |
131 | .LP\r | |
132 | This software is provided "as-is,"\r | |
133 | without any express or implied warranty.\r | |
134 | In no event will the authors be held liable for any damages\r | |
135 | arising from the use of this software.\r | |
136 | See the distribution directory with respect to requirements\r | |
137 | governing redistribution.\r | |
138 | The deflate format used by\r | |
139 | .I zlib\r | |
140 | was defined by Phil Katz.\r | |
141 | The deflate and\r | |
142 | .I zlib\r | |
143 | specifications were written by L. Peter Deutsch.\r | |
144 | Thanks to all the people who reported problems and suggested various\r | |
145 | improvements in\r | |
146 | .IR zlib ;\r | |
147 | who are too numerous to cite here.\r | |
148 | .LP\r | |
149 | UNIX manual page by R. P. C. Rodgers,\r | |
150 | U.S. National Library of Medicine (rodgers@nlm.nih.gov).\r | |
151 | .\" end of man page\r |