diff options
| author | Mark Adler <madler@alumni.caltech.edu> | 2011-09-09 23:32:36 -0700 |
|---|---|---|
| committer | Mark Adler <madler@alumni.caltech.edu> | 2011-09-09 23:32:36 -0700 |
| commit | 67cc20d0041a32bee12bd9eb20ae218f91b73f77 (patch) | |
| tree | d7e1b94bd15c30efd57cf9036f5fe89306b6bba0 /README | |
| parent | 7751bd4c715ea8478113e34b49b5a794a4642e8e (diff) | |
| download | zlib-1.2.4-pre1.tar.gz zlib-1.2.4-pre1.tar.bz2 zlib-1.2.4-pre1.zip | |
zlib 1.2.4-pre1v1.2.4-pre1
Diffstat (limited to 'README')
| -rw-r--r-- | README | 85 |
1 files changed, 37 insertions, 48 deletions
| @@ -1,56 +1,51 @@ | |||
| 1 | ZLIB DATA COMPRESSION LIBRARY | 1 | ZLIB DATA COMPRESSION LIBRARY |
| 2 | 2 | ||
| 3 | zlib 1.2.3.9 is a general purpose data compression library. All the code is | 3 | zlib 1.2.4 is a general purpose data compression library. All the code is |
| 4 | thread safe. The data format used by the zlib library is described by RFCs | 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 | 5 | (Request for Comments) 1950 to 1952 in the files |
| 6 | http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format) | 6 | http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format) |
| 7 | and rfc1952.txt (gzip format). These documents are also available in other | 7 | and rfc1952.txt (gzip format). |
| 8 | formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html | ||
| 9 | 8 | ||
| 10 | All functions of the compression library are documented in the file zlib.h | 9 | All 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 |
| 12 | of the library is given in the file example.c which also tests that the library | 11 | of the library is given in the file example.c which also tests that the library |
| 13 | is working correctly. Another example is given in the file minigzip.c. The | 12 | is working correctly. Another example is given in the file minigzip.c. The |
| 14 | compression library itself is composed of all source files except example.c and | 13 | compression library itself is composed of all source files except example.c and |
| 15 | minigzip.c. | 14 | minigzip.c. |
| 16 | 15 | ||
| 17 | To compile all files and run the test program, follow the instructions given at | 16 | To compile all files and run the test program, follow the instructions given at |
| 18 | the top of Makefile. In short "make test; make install" should work for most | 17 | the top of Makefile.in. In short "./configure; make test", and if that goes |
| 19 | machines. For Unix: "./configure; make test; make install". For MSDOS, use one | 18 | well, "make install" should work for most flavors of Unix. For Windows, use one |
| 20 | of the special makefiles such as Makefile.msc. For VMS, use make_vms.com. | 19 | of the special makefiles in win32/ or projects/ . For VMS, use make_vms.com. |
| 21 | 20 | ||
| 22 | Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant | 21 | 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 | 22 | <info@winimage.com> for the Windows DLL version. The zlib home page is |
| 24 | http://www.zlib.org or http://www.gzip.org/zlib/ Before reporting a problem, | 23 | http://zlib.net/ . Before reporting a problem, please check this site to |
| 25 | please check this site to verify that you have the latest version of zlib; | 24 | verify that you have the latest version of zlib; otherwise get the latest |
| 26 | otherwise get the latest version and check whether the problem still exists or | 25 | version and check whether the problem still exists or not. |
| 27 | not. | ||
| 28 | 26 | ||
| 29 | PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html before asking | 27 | PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help. |
| 30 | for help. | ||
| 31 | 28 | ||
| 32 | Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 | 29 | Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 |
| 33 | issue of Dr. Dobb's Journal; a copy of the article is available in | 30 | issue of Dr. Dobb's Journal; a copy of the article is available at |
| 34 | http://dogma.net/markn/articles/zlibtool/zlibtool.htm | 31 | http://marknelson.us/1997/01/01/zlib-engine/ . |
| 35 | 32 | ||
| 36 | The changes made in version 1.2.3.9 are documented in the file ChangeLog. | 33 | The changes made in version 1.2.4 are documented in the file ChangeLog. |
| 37 | 34 | ||
| 38 | Unsupported third party contributions are provided in directory "contrib". | 35 | Unsupported third party contributions are provided in directory contrib/ . |
| 39 | 36 | ||
| 40 | A Java implementation of zlib is available in the Java Development Kit | 37 | zlib is available in Java using the java.util.zip package, documented at |
| 41 | http://java.sun.com/j2se/1.4.2/docs/api/java/util/zip/package-summary.html | 38 | http://java.sun.com/developer/technicalArticles/Programming/compression/ . |
| 42 | See the zlib home page http://www.zlib.org for details. | ||
| 43 | 39 | ||
| 44 | A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is in the | 40 | A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available |
| 45 | CPAN (Comprehensive Perl Archive Network) sites | 41 | at CPAN (Comprehensive Perl Archive Network) sites, including |
| 46 | http://www.cpan.org/modules/by-module/Compress/ | 42 | http://search.cpan.org/~pmqs/IO-Compress-Zlib/ . |
| 47 | 43 | ||
| 48 | A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is | 44 | A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is |
| 49 | available in Python 1.5 and later versions, see | 45 | available in Python 1.5 and later versions, see |
| 50 | http://www.python.org/doc/lib/module-zlib.html | 46 | http://www.python.org/doc/lib/module-zlib.html . |
| 51 | 47 | ||
| 52 | A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com> is | 48 | zlib is built into tcl: http://wiki.tcl.tk/4610 . |
| 53 | availlable at http://www.oche.de/~akupries/soft/trf/trf_zip.html | ||
| 54 | 49 | ||
| 55 | An experimental package to read and write files in .zip format, written on top | 50 | An experimental package to read and write files in .zip format, written on top |
| 56 | of zlib by Gilles Vollant <info@winimage.com>, is available in the | 51 | of 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 | ||
| 86 | Acknowledgments: | 77 | Acknowledgments: |
| 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 | ||
| 93 | Copyright notice: | 84 | Copyright 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 | ||
| 116 | If you use the zlib library in a product, we would appreciate *not* | 107 | If you use the zlib library in a product, we would appreciate *not* receiving |
| 117 | receiving lengthy legal documents to sign. The sources are provided | 108 | lengthy legal documents to sign. The sources are provided for free but without |
| 118 | for free but without warranty of any kind. The library has been | 109 | warranty of any kind. The library has been entirely written by Jean-loup |
| 119 | entirely written by Jean-loup Gailly and Mark Adler; it does not | 110 | Gailly and Mark Adler; it does not include third-party code. |
| 120 | include third-party code. | ||
| 121 | 111 | ||
| 122 | If you redistribute modified sources, we would appreciate that you include | 112 | If you redistribute modified sources, we would appreciate that you include in |
| 123 | in the file ChangeLog history information documenting your changes. Please | 113 | the file ChangeLog history information documenting your changes. Please read |
| 124 | read the FAQ for more information on the distribution of modified source | 114 | the FAQ for more information on the distribution of modified source versions. |
| 125 | versions. | ||
