aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMark Adler <madler@alumni.caltech.edu>2011-09-09 23:32:36 -0700
committerMark Adler <madler@alumni.caltech.edu>2011-09-09 23:32:36 -0700
commit67cc20d0041a32bee12bd9eb20ae218f91b73f77 (patch)
treed7e1b94bd15c30efd57cf9036f5fe89306b6bba0 /README
parent7751bd4c715ea8478113e34b49b5a794a4642e8e (diff)
downloadzlib-67cc20d0041a32bee12bd9eb20ae218f91b73f77.tar.gz
zlib-67cc20d0041a32bee12bd9eb20ae218f91b73f77.tar.bz2
zlib-67cc20d0041a32bee12bd9eb20ae218f91b73f77.zip
zlib 1.2.4-pre1v1.2.4-pre1
Diffstat (limited to 'README')
-rw-r--r--README85
1 files changed, 37 insertions, 48 deletions
diff --git a/README b/README
index e6bea09..f24aeee 100644
--- a/README
+++ b/README
@@ -1,56 +1,51 @@
1ZLIB DATA COMPRESSION LIBRARY 1ZLIB DATA COMPRESSION LIBRARY
2 2
3zlib 1.2.3.9 is a general purpose data compression library. All the code is 3zlib 1.2.4 is a general purpose data compression library. All the code is
4thread safe. The data format used by the zlib library is described by RFCs 4thread safe. The data format used by the zlib library is described by RFCs
5(Request for Comments) 1950 to 1952 in the files 5(Request for Comments) 1950 to 1952 in the files
6http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format) 6http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format)
7and rfc1952.txt (gzip format). These documents are also available in other 7and rfc1952.txt (gzip format).
8formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
9 8
10All functions of the compression library are documented in the file zlib.h 9All functions of the compression library are documented in the file zlib.h
11(volunteer to write man pages welcome, contact zlib@gzip.org). A usage example 10(volunteer to write man pages welcome, contact zlib@gzip.org). A usage example
12of the library is given in the file example.c which also tests that the library 11of the library is given in the file example.c which also tests that the library
13is working correctly. Another example is given in the file minigzip.c. The 12is working correctly. Another example is given in the file minigzip.c. The
14compression library itself is composed of all source files except example.c and 13compression library itself is composed of all source files except example.c and
15minigzip.c. 14minigzip.c.
16 15
17To compile all files and run the test program, follow the instructions given at 16To compile all files and run the test program, follow the instructions given at
18the top of Makefile. In short "make test; make install" should work for most 17the top of Makefile.in. In short "./configure; make test", and if that goes
19machines. For Unix: "./configure; make test; make install". For MSDOS, use one 18well, "make install" should work for most flavors of Unix. For Windows, use one
20of the special makefiles such as Makefile.msc. For VMS, use make_vms.com. 19of the special makefiles in win32/ or projects/ . For VMS, use make_vms.com.
21 20
22Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant 21Questions 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 22<info@winimage.com> for the Windows DLL version. The zlib home page is
24http://www.zlib.org or http://www.gzip.org/zlib/ Before reporting a problem, 23http://zlib.net/ . Before reporting a problem, please check this site to
25please check this site to verify that you have the latest version of zlib; 24verify that you have the latest version of zlib; otherwise get the latest
26otherwise get the latest version and check whether the problem still exists or 25version and check whether the problem still exists or not.
27not.
28 26
29PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html before asking 27PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help.
30for help.
31 28
32Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 29Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997
33issue of Dr. Dobb's Journal; a copy of the article is available in 30issue of Dr. Dobb's Journal; a copy of the article is available at
34http://dogma.net/markn/articles/zlibtool/zlibtool.htm 31http://marknelson.us/1997/01/01/zlib-engine/ .
35 32
36The changes made in version 1.2.3.9 are documented in the file ChangeLog. 33The changes made in version 1.2.4 are documented in the file ChangeLog.
37 34
38Unsupported third party contributions are provided in directory "contrib". 35Unsupported third party contributions are provided in directory contrib/ .
39 36
40A Java implementation of zlib is available in the Java Development Kit 37zlib is available in Java using the java.util.zip package, documented at
41http://java.sun.com/j2se/1.4.2/docs/api/java/util/zip/package-summary.html 38http://java.sun.com/developer/technicalArticles/Programming/compression/ .
42See the zlib home page http://www.zlib.org for details.
43 39
44A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is in the 40A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available
45CPAN (Comprehensive Perl Archive Network) sites 41at CPAN (Comprehensive Perl Archive Network) sites, including
46http://www.cpan.org/modules/by-module/Compress/ 42http://search.cpan.org/~pmqs/IO-Compress-Zlib/ .
47 43
48A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is 44A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is
49available in Python 1.5 and later versions, see 45available in Python 1.5 and later versions, see
50http://www.python.org/doc/lib/module-zlib.html 46http://www.python.org/doc/lib/module-zlib.html .
51 47
52A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com> is 48zlib is built into tcl: http://wiki.tcl.tk/4610 .
53availlable at http://www.oche.de/~akupries/soft/trf/trf_zip.html
54 49
55An experimental package to read and write files in .zip format, written on top 50An experimental package to read and write files in .zip format, written on top
56of zlib by Gilles Vollant <info@winimage.com>, is available in the 51of zlib by Gilles Vollant <info@winimage.com>, is available in the
@@ -74,25 +69,21 @@ Notes for some targets:
74- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with 69- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with
75 other compilers. Use "make test" to check your compiler. 70 other compilers. Use "make test" to check your compiler.
76 71
77- gzdopen is not supported on RISCOS, BEOS and by some Mac compilers. 72- gzdopen is not supported on RISCOS or BEOS.
78 73
79- For PalmOs, see http://palmzlib.sourceforge.net/ 74- For PalmOs, see http://palmzlib.sourceforge.net/
80 75
81- When building a shared, i.e. dynamic library on Mac OS X, the library must be
82 installed before testing (do "make install" before "make test"), since the
83 library location is specified in the library.
84
85 76
86Acknowledgments: 77Acknowledgments:
87 78
88 The deflate format used by zlib was defined by Phil Katz. The deflate 79 The deflate format used by zlib was defined by Phil Katz. The deflate and
89 and zlib specifications were written by L. Peter Deutsch. Thanks to all the 80 zlib specifications were written by L. Peter Deutsch. Thanks to all the
90 people who reported problems and suggested various improvements in zlib; 81 people who reported problems and suggested various improvements in zlib; they
91 they are too numerous to cite here. 82 are too numerous to cite here.
92 83
93Copyright notice: 84Copyright notice:
94 85
95 (C) 1995-2004 Jean-loup Gailly and Mark Adler 86 (C) 1995-2010 Jean-loup Gailly and Mark Adler
96 87
97 This software is provided 'as-is', without any express or implied 88 This software is provided 'as-is', without any express or implied
98 warranty. In no event will the authors be held liable for any damages 89 warranty. In no event will the authors be held liable for any damages
@@ -113,13 +104,11 @@ Copyright notice:
113 Jean-loup Gailly Mark Adler 104 Jean-loup Gailly Mark Adler
114 jloup@gzip.org madler@alumni.caltech.edu 105 jloup@gzip.org madler@alumni.caltech.edu
115 106
116If you use the zlib library in a product, we would appreciate *not* 107If you use the zlib library in a product, we would appreciate *not* receiving
117receiving lengthy legal documents to sign. The sources are provided 108lengthy legal documents to sign. The sources are provided for free but without
118for free but without warranty of any kind. The library has been 109warranty of any kind. The library has been entirely written by Jean-loup
119entirely written by Jean-loup Gailly and Mark Adler; it does not 110Gailly and Mark Adler; it does not include third-party code.
120include third-party code.
121 111
122If you redistribute modified sources, we would appreciate that you include 112If you redistribute modified sources, we would appreciate that you include in
123in the file ChangeLog history information documenting your changes. Please 113the file ChangeLog history information documenting your changes. Please read
124read the FAQ for more information on the distribution of modified source 114the FAQ for more information on the distribution of modified source versions.
125versions.