b24e7fce |
1 | ZLIB DATA COMPRESSION LIBRARY |
2 | |
648db22b |
3 | zlib 1.3.1 is a general purpose data compression library. All the code is |
b24e7fce |
4 | thread safe. The data format used by the zlib library is described by RFCs |
5 | (Request for Comments) 1950 to 1952 in the files |
6 | http://tools.ietf.org/html/rfc1950 (zlib format), rfc1951 (deflate format) and |
7 | rfc1952 (gzip format). |
8 | |
9 | All functions of the compression library are documented in the file zlib.h |
10 | (volunteer to write man pages welcome, contact zlib@gzip.org). A usage example |
11 | of the library is given in the file test/example.c which also tests that |
12 | the library is working correctly. Another example is given in the file |
13 | test/minigzip.c. The compression library itself is composed of all source |
14 | files in the root directory. |
15 | |
16 | To compile all files and run the test program, follow the instructions given at |
17 | the top of Makefile.in. In short "./configure; make test", and if that goes |
18 | well, "make install" should work for most flavors of Unix. For Windows, use |
19 | one of the special makefiles in win32/ or contrib/vstudio/ . For VMS, use |
20 | make_vms.com. |
21 | |
22 | Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant |
23 | <info@winimage.com> for the Windows DLL version. The zlib home page is |
24 | http://zlib.net/ . Before reporting a problem, please check this site to |
25 | verify that you have the latest version of zlib; otherwise get the latest |
26 | version and check whether the problem still exists or not. |
27 | |
28 | PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help. |
29 | |
30 | Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 |
31 | issue of Dr. Dobb's Journal; a copy of the article is available at |
648db22b |
32 | https://marknelson.us/posts/1997/01/01/zlib-engine.html . |
b24e7fce |
33 | |
648db22b |
34 | The changes made in version 1.3.1 are documented in the file ChangeLog. |
b24e7fce |
35 | |
36 | Unsupported third party contributions are provided in directory contrib/ . |
37 | |
648db22b |
38 | zlib is available in Java using the java.util.zip package. Follow the API |
39 | Documentation link at: https://docs.oracle.com/search/?q=java.util.zip . |
b24e7fce |
40 | |
648db22b |
41 | A Perl interface to zlib and bzip2 written by Paul Marquess <pmqs@cpan.org> |
42 | can be found at https://github.com/pmqs/IO-Compress . |
b24e7fce |
43 | |
44 | A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is |
45 | available in Python 1.5 and later versions, see |
46 | http://docs.python.org/library/zlib.html . |
47 | |
48 | zlib is built into tcl: http://wiki.tcl.tk/4610 . |
49 | |
50 | An experimental package to read and write files in .zip format, written on top |
51 | of zlib by Gilles Vollant <info@winimage.com>, is available in the |
52 | contrib/minizip directory of zlib. |
53 | |
54 | |
55 | Notes for some targets: |
56 | |
57 | - For Windows DLL versions, please see win32/DLL_FAQ.txt |
58 | |
59 | - For 64-bit Irix, deflate.c must be compiled without any optimization. With |
60 | -O, one libpng test fails. The test works in 32 bit mode (with the -n32 |
61 | compiler flag). The compiler bug has been reported to SGI. |
62 | |
63 | - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works |
64 | when compiled with cc. |
65 | |
648db22b |
66 | - On Digital Unix 4.0D (formerly OSF/1) on AlphaServer, the cc option -std1 is |
b24e7fce |
67 | necessary to get gzprintf working correctly. This is done by configure. |
68 | |
69 | - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with |
70 | other compilers. Use "make test" to check your compiler. |
71 | |
72 | - gzdopen is not supported on RISCOS or BEOS. |
73 | |
74 | - For PalmOs, see http://palmzlib.sourceforge.net/ |
75 | |
76 | |
77 | Acknowledgments: |
78 | |
79 | The deflate format used by zlib was defined by Phil Katz. The deflate and |
80 | zlib specifications were written by L. Peter Deutsch. Thanks to all the |
81 | people who reported problems and suggested various improvements in zlib; they |
82 | are too numerous to cite here. |
83 | |
84 | Copyright notice: |
85 | |
648db22b |
86 | (C) 1995-2024 Jean-loup Gailly and Mark Adler |
b24e7fce |
87 | |
88 | This software is provided 'as-is', without any express or implied |
89 | warranty. In no event will the authors be held liable for any damages |
90 | arising from the use of this software. |
91 | |
92 | Permission is granted to anyone to use this software for any purpose, |
93 | including commercial applications, and to alter it and redistribute it |
94 | freely, subject to the following restrictions: |
95 | |
96 | 1. The origin of this software must not be misrepresented; you must not |
97 | claim that you wrote the original software. If you use this software |
98 | in a product, an acknowledgment in the product documentation would be |
99 | appreciated but is not required. |
100 | 2. Altered source versions must be plainly marked as such, and must not be |
101 | misrepresented as being the original software. |
102 | 3. This notice may not be removed or altered from any source distribution. |
103 | |
104 | Jean-loup Gailly Mark Adler |
105 | jloup@gzip.org madler@alumni.caltech.edu |
106 | |
107 | If you use the zlib library in a product, we would appreciate *not* receiving |
108 | lengthy legal documents to sign. The sources are provided for free but without |
109 | warranty of any kind. The library has been entirely written by Jean-loup |
9e052883 |
110 | Gailly and Mark Adler; it does not include third-party code. We make all |
111 | contributions to and distributions of this project solely in our personal |
112 | capacity, and are not conveying any rights to any intellectual property of |
113 | any third parties. |
b24e7fce |
114 | |
115 | If you redistribute modified sources, we would appreciate that you include in |
116 | the file ChangeLog history information documenting your changes. Please read |
117 | the FAQ for more information on the distribution of modified source versions. |