]>
Commit | Line | Data |
---|---|---|
21e7cbd2 GP |
1 | This directory contains the zlib package, which is not part of GCC but |
2 | shipped with GCC as convenience. | |
3 | ||
17210dff TT |
4 | ZLIB DATA COMPRESSION LIBRARY |
5 | ||
ef338166 | 6 | zlib 1.2.3 is a general purpose data compression library. All the code is |
17210dff TT |
7 | thread safe. The data format used by the zlib library is described by RFCs |
8 | (Request for Comments) 1950 to 1952 in the files | |
9 | http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format) | |
10 | and rfc1952.txt (gzip format). These documents are also available in other | |
11 | formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html | |
c45f211e TT |
12 | |
13 | All functions of the compression library are documented in the file zlib.h | |
17210dff TT |
14 | (volunteer to write man pages welcome, contact zlib@gzip.org). A usage example |
15 | of the library is given in the file example.c which also tests that the library | |
16 | is working correctly. Another example is given in the file minigzip.c. The | |
17 | compression library itself is composed of all source files except example.c and | |
18 | minigzip.c. | |
19 | ||
20 | To compile all files and run the test program, follow the instructions given at | |
21 | the top of Makefile. In short "make test; make install" should work for most | |
ef338166 TT |
22 | machines. For Unix: "./configure; make test; make install". For MSDOS, use one |
23 | of the special makefiles such as Makefile.msc. For VMS, use make_vms.com. | |
17210dff TT |
24 | |
25 | Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant | |
26 | <info@winimage.com> for the Windows DLL version. The zlib home page is | |
27 | http://www.zlib.org or http://www.gzip.org/zlib/ Before reporting a problem, | |
28 | please check this site to verify that you have the latest version of zlib; | |
29 | otherwise get the latest version and check whether the problem still exists or | |
30 | not. | |
31 | ||
32 | PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html before asking | |
33 | for help. | |
e1b56469 TT |
34 | |
35 | Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 | |
c45f211e | 36 | issue of Dr. Dobb's Journal; a copy of the article is available in |
e1b56469 TT |
37 | http://dogma.net/markn/articles/zlibtool/zlibtool.htm |
38 | ||
ef338166 | 39 | The changes made in version 1.2.3 are documented in the file ChangeLog. |
c45f211e TT |
40 | |
41 | Unsupported third party contributions are provided in directory "contrib". | |
42 | ||
e1b56469 | 43 | A Java implementation of zlib is available in the Java Development Kit |
17210dff | 44 | http://java.sun.com/j2se/1.4.2/docs/api/java/util/zip/package-summary.html |
e1b56469 | 45 | See the zlib home page http://www.zlib.org for details. |
c45f211e | 46 | |
17210dff TT |
47 | A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is in the |
48 | CPAN (Comprehensive Perl Archive Network) sites | |
e1b56469 | 49 | http://www.cpan.org/modules/by-module/Compress/ |
c45f211e | 50 | |
ef338166 | 51 | A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is |
17210dff | 52 | available in Python 1.5 and later versions, see |
c45f211e TT |
53 | http://www.python.org/doc/lib/module-zlib.html |
54 | ||
17210dff TT |
55 | A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com> is |
56 | availlable at http://www.oche.de/~akupries/soft/trf/trf_zip.html | |
c45f211e | 57 | |
17210dff TT |
58 | An experimental package to read and write files in .zip format, written on top |
59 | of zlib by Gilles Vollant <info@winimage.com>, is available in the | |
60 | contrib/minizip directory of zlib. | |
c45f211e TT |
61 | |
62 | ||
63 | Notes for some targets: | |
64 | ||
17210dff | 65 | - For Windows DLL versions, please see win32/DLL_FAQ.txt |
c45f211e | 66 | |
17210dff TT |
67 | - For 64-bit Irix, deflate.c must be compiled without any optimization. With |
68 | -O, one libpng test fails. The test works in 32 bit mode (with the -n32 | |
69 | compiler flag). The compiler bug has been reported to SGI. | |
c45f211e | 70 | |
17210dff TT |
71 | - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works |
72 | when compiled with cc. | |
c45f211e | 73 | |
17210dff TT |
74 | - On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is |
75 | necessary to get gzprintf working correctly. This is done by configure. | |
c45f211e | 76 | |
17210dff TT |
77 | - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with |
78 | other compilers. Use "make test" to check your compiler. | |
c45f211e TT |
79 | |
80 | - gzdopen is not supported on RISCOS, BEOS and by some Mac compilers. | |
81 | ||
17210dff | 82 | - For PalmOs, see http://palmzlib.sourceforge.net/ |
c45f211e | 83 | |
17210dff TT |
84 | - When building a shared, i.e. dynamic library on Mac OS X, the library must be |
85 | installed before testing (do "make install" before "make test"), since the | |
86 | library location is specified in the library. | |
c45f211e TT |
87 | |
88 | ||
89 | Acknowledgments: | |
90 | ||
91 | The deflate format used by zlib was defined by Phil Katz. The deflate | |
92 | and zlib specifications were written by L. Peter Deutsch. Thanks to all the | |
93 | people who reported problems and suggested various improvements in zlib; | |
94 | they are too numerous to cite here. | |
95 | ||
96 | Copyright notice: | |
97 | ||
ef338166 | 98 | (C) 1995-2004 Jean-loup Gailly and Mark Adler |
c45f211e TT |
99 | |
100 | This software is provided 'as-is', without any express or implied | |
101 | warranty. In no event will the authors be held liable for any damages | |
102 | arising from the use of this software. | |
103 | ||
104 | Permission is granted to anyone to use this software for any purpose, | |
105 | including commercial applications, and to alter it and redistribute it | |
106 | freely, subject to the following restrictions: | |
107 | ||
108 | 1. The origin of this software must not be misrepresented; you must not | |
109 | claim that you wrote the original software. If you use this software | |
110 | in a product, an acknowledgment in the product documentation would be | |
111 | appreciated but is not required. | |
112 | 2. Altered source versions must be plainly marked as such, and must not be | |
113 | misrepresented as being the original software. | |
114 | 3. This notice may not be removed or altered from any source distribution. | |
115 | ||
116 | Jean-loup Gailly Mark Adler | |
117 | jloup@gzip.org madler@alumni.caltech.edu | |
118 | ||
119 | If you use the zlib library in a product, we would appreciate *not* | |
120 | receiving lengthy legal documents to sign. The sources are provided | |
121 | for free but without warranty of any kind. The library has been | |
122 | entirely written by Jean-loup Gailly and Mark Adler; it does not | |
123 | include third-party code. | |
124 | ||
125 | If you redistribute modified sources, we would appreciate that you include | |
17210dff TT |
126 | in the file ChangeLog history information documenting your changes. Please |
127 | read the FAQ for more information on the distribution of modified source | |
128 | versions. |