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