diff options
author | steve <steve@FreeBSD.org> | 1998-02-28 06:04:26 +0000 |
---|---|---|
committer | steve <steve@FreeBSD.org> | 1998-02-28 06:04:26 +0000 |
commit | 9f86c0bf8cf1224d46bbefe1d308f2cc8186a79b (patch) | |
tree | f03de58d136ec48f008735e374079754bdfee40f /lib/libz/README | |
parent | 5372e3085661ee9071da924c16a5cfdc12f7590d (diff) | |
download | FreeBSD-src-9f86c0bf8cf1224d46bbefe1d308f2cc8186a79b.zip FreeBSD-src-9f86c0bf8cf1224d46bbefe1d308f2cc8186a79b.tar.gz |
Initial import of zlib-1.1.1
PR: 5869
Reviewed by: jdp
Diffstat (limited to 'lib/libz/README')
-rw-r--r-- | lib/libz/README | 86 |
1 files changed, 57 insertions, 29 deletions
diff --git a/lib/libz/README b/lib/libz/README index 28adc90..acaea4f 100644 --- a/lib/libz/README +++ b/lib/libz/README @@ -1,15 +1,16 @@ -zlib 1.0.4 is a general purpose data compression library. All the code -is reentrant (thread safe). The data format used by the zlib library +zlib 1.1.1 is a general purpose data compression library. All the code +is thread safe. The data format used by the zlib library is described by RFCs (Request for Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format). These documents are also available in other formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html -All functions of the compression library are documented in the file -zlib.h. A usage example of the library is given in the file example.c -which also tests that the library is working correctly. Another -example is given in the file minigzip.c. The compression library itself -is composed of all source files except example.c and minigzip.c. +All functions of the compression library are documented in the file zlib.h +(volunteer to write man pages welcome, contact jloup@gzip.org). A usage +example of the library is given in the file example.c which also tests that +the library is working correctly. Another example is given in the file +minigzip.c. The compression library itself is composed of all source files +except example.c and minigzip.c. To compile all files and run the test program, follow the instructions given at the top of Makefile. In short "make test; make install" @@ -18,45 +19,72 @@ makefiles such as Makefile.msc; for VMS, use Make_vms.com or descrip.mms. Questions about zlib should be sent to <zlib@quest.jpl.nasa.gov> or, if this fails, to the addresses given below in the Copyright section. -The zlib home page is http://quest.jpl.nasa.gov/zlib/ +The zlib home page is http://www.cdrom.com/pub/infozip/zlib/ +The official zlib ftp site is ftp://ftp.cdrom.com/pub/infozip/zlib/ +Mark Nelson wrote an article about zlib for the Jan. 1997 issue of +Dr. Dobb's Journal; a copy of the article is available in +http://web2.airmail.net/markn/articles/zlibtool/zlibtool.htm -The changes made in version 1.0.4 are documented in the file ChangeLog. -The main changes since 1.0.3 are: +The changes made in version 1.1.1 are documented in the file ChangeLog. +The main changes since 1.1.0 are: -- In very rare conditions, deflate(s, Z_FINISH) could fail to produce an EOF - bit, so the decompressor could decompress all the correct data but went - on to attempt decompressing extra garbage data. This affected minigzip too. -- zlibVersion and gzerror return const char* (needed for DLL) -- port to RISCOS (no fdopen, no multiple dots, no unlink, no fileno) +- fix macros _tr_tally_* in deflate.h for debug mode (Glenn Randers-Pehrson) +- remove block truncation heuristic which had very marginal effect for zlib + (smaller lit_bufsize than in gzip 1.2.4) and degraded a little the + compression ratio on some files. This also allows inlining _tr_tally for + matches in deflate_slow. +Unsupported third party contributions are provided in directory "contrib". + +A Java implementation of zlib is available in the Java Development Kit 1.1 +http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html +See the zlib home page http://www.cdrom.com/pub/infozip/zlib/ for details. + A Perl interface to zlib written by Paul Marquess <pmarquess@bfsec.bt.co.uk> is in the CPAN (Comprehensive Perl Archive Network) sites, such as: ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib* +A Python interface to zlib written by A.M. Kuchling <amk@magnet.com> +is available from the Python Software Association sites, such as: +ftp://ftp.python.org/pub/python/contrib/Encoding/zlib*.tar.gz + +An experimental package to read files in .zip format, written on top of +zlib by Gilles Vollant <info@winimage.com>, is available at +http://www.winimage.com/zLibDll/unzip.html + Notes for some targets: -- For Turbo C the small model is supported only with reduced performance to - avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3 +- To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc + and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL + The zlib DLL support was initially done by Alessandro Iacopetti and is + now maintained by Gilles Vollant <info@winimage.com>. Check the zlib DLL + home page at http://www.winimage.com/zLibDll + + From Visual Basic, you can call the DLL functions which do not take + a structure as argument: compress, uncompress and all gz* functions. + See contrib/visual-basic.txt for more information. + I don't know how to handle structures in Visual Basic, sorry. -- For 64-bit Iris, deflate.c must be compiled without any optimization. +- For 64-bit Irix, deflate.c must be compiled without any optimization. With -O, one libpng test fails. The test works in 32 bit mode (with - the -32 compiler flag). The compiler bug has been reported to SGI. + the -n32 compiler flag). The compiler bug has been reported to SGI. - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works when compiled with cc. -- zlib doesn't work on HP-UX 9.05 with one cc compiler (the one not - accepting the -O option). It works with the other cc compiler. +- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works + with other compilers. Use "make test" to check your compiler. -- To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc - and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL - For help on building a zlib DLL, contact Alessandro Iacopetti - <iaco@email.alessandria.alpcom.it> http://lisa.unial.it/iaco , - or contact Brad Clarke <bclarke@cyberus.ca>. +- For shared memory multiprocessors, the decompression code assumes that + writes to pointers are atomic. Also the functions zalloc and zfree passed + to deflateInit must be multi-threaded in this case. -- gzdopen is not supported on RISCOS +- gzdopen is not supported on RISCOS, BEOS and by some Mac compilers. + +- For Turbo C the small model is supported only with reduced performance to + avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3 Acknowledgments: @@ -68,7 +96,7 @@ Acknowledgments: Copyright notice: - (C) 1995-1996 Jean-loup Gailly and Mark Adler + (C) 1995-1998 Jean-loup Gailly and Mark Adler This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages @@ -87,7 +115,7 @@ Copyright notice: 3. This notice may not be removed or altered from any source distribution. Jean-loup Gailly Mark Adler - gzip@prep.ai.mit.edu madler@alumni.caltech.edu + jloup@gzip.org madler@alumni.caltech.edu If you use the zlib library in a product, we would appreciate *not* receiving lengthy legal documents to sign. The sources are provided |