summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README101
1 files changed, 68 insertions, 33 deletions
diff --git a/README b/README
index 1810978..0d41909 100644
--- a/README
+++ b/README
@@ -1,40 +1,75 @@
1zlib 0.95 is a beta version of a general purpose compression library. 1zlib 1.0 is a general purpose data compression library. All the code
2This should be the last version before the first official 2is reentrant (thread safe). The data format used by the zlib library
3version (1.0), so please test it now. (At least compile and run it with 3is described in the files zlib-3.3.doc, deflate-1.3.doc and
4"make test"). This version has no known bugs. 4gzip-4.3.doc, available in ftp://ftp.uu.net/pub/archiving/zip/doc/
5
6The data format used by the zlib library is described in the
7files zlib-3.1.doc, deflate-1.1.doc and gzip-4.1.doc, available
8in ftp.uu.net:/pub/archiving/zip/doc.
9 5
10All functions of the compression library are documented in the file 6All functions of the compression library are documented in the file
11zlib.h. A usage example of the library is given in the file example.c 7zlib.h. A usage example of the library is given in the file example.c
12which also tests that the library is working correctly. Another 8which also tests that the library is working correctly. Another
13example is given in the file minigzip.c. 9example is given in the file minigzip.c. The compression library itself
14 10is composed of all source files except example.c and minigzip.c.
15To compile all files and run the test program, just type: make test 11
16(For MSDOS, use one of the special makefiles such as Makefile.msc; 12To compile all files and run the test program, follow the instructions
17for VMS, use Make_vms.com or descrip.mms.) 13given at the top of Makefile. In short "make test; make install"
18To install the zlib library (libz.a) in /usr/local/lib, type: make install 14should work for most machines. For MSDOS, use one of the special
19To install in a different directory, use for example: 15makefiles such as Makefile.msc; for VMS, use Make_vms.com or descrip.mms.
20 make install prefix=$HOME 16
21This will install in $HOME/lib instead of /usr/local/lib. 17Questions about zlib should be sent to <zlib@quest.jpl.nasa.gov> or,
22 18if this fails, to the addresses given below in the Copyright section.
23The changes made in version 0.95 are documented in the file ChangeLog. 19
24The main changes since 0.94 are: 20The changes made in version 1.0 are documented in the file ChangeLog.
25- fix MSDOS small and medium model (now easier to adapt to any compiler) 21The main changes since 0.95 are:
26- inlined send_bits 22- allow preset dictionary shared between compressor and decompressor
27- fix the final (:-) bug for deflate with flush (output was correct but 23- allow compression level 0 (no compression)
28 not completely flushed in rare occasions). 24- add deflateParams in zlib.h: allow dynamic change of compression level
29 25 and compression strategy.
30For MSDOS, the small and medium models have been tested only with Microsoft C. 26- test large buffers and deflateParams in example.c
31(This should now work for Borland C also, but I don't have a recent Borland 27- add optional "configure" to build zlib as a shared library
32compiler to test with.) The small model was tested with Turbo C but only with 28- suppress Makefile.qnx, use configure instead
33reduced performance to avoid any far allocation; it was tested with 29- fixes for 64-bit systems (needed for Alpha and Cray)
34 -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3 30- declare Z_DEFLATED in zlib.h (possible parameter for deflateInit2)
35 31- always return Z_BUF_ERROR when deflate() has nothing to do
36 32- deflateInit and inflateInit are now macros to allow version checking
37 (C) 1995 Jean-loup Gailly and Mark Adler 33- prefix all global functions and types with z_ with -DZ_PREFIX
34- fix some very unlikely race conditions in multi-threaded environment
35- several minor fixes for better portability
36- free in reverse order of allocation to help memory manager
37- use zlib-1.0/* instead of zlib/* inside the tar.gz
38- make zlib warning-free with "gcc -O3 -Wall -Wwrite-strings -Wpointer-arith
39 -Wconversion -Wstrict-prototypes -Wmissing-prototypes"
40- allow gzread on concatenated .gz files
41- deflateEnd now returns Z_DATA_ERROR if it was premature
42- deflate is finally (?) fully deterministic
43
44Notes for some targets:
45
46- For Turbo C the small model is supported only with reduced performance to
47 avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
48
49- For 64-bit Iris, deflate.c must be compiled without any optimization.
50 With -O, one libpng test fails. The test works in 32 bit mode (with the
51 -32 compiler flag).
52
53- zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1
54 it works when compiled with cc.
55
56- zlib doesn't work on HP-UX 9.05 with one cc compiler (the one not
57 accepting the -O option). It works with the other cc compiler.
58
59A Perl interface to zlib written by Paul Marquess <pmarquess@bfsec.bt.co.uk>
60is in the CPAN (Comprehensive Perl Archive Network) sites, such as:
61ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
62
63Acknowledgments:
64
65 The deflate format used by zlib was defined by Phil Katz. The deflate
66 and zlib specifications were written by Peter Deutsch. Thanks to all the
67 people who reported problems and suggested various improvements in zlib;
68 they are too numerous to cite here.
69
70Copyright notice:
71
72 (C) 1995-1996 Jean-loup Gailly and Mark Adler
38 73
39 This software is provided 'as-is', without any express or implied 74 This software is provided 'as-is', without any express or implied
40 warranty. In no event will the authors be held liable for any damages 75 warranty. In no event will the authors be held liable for any damages