added revcation stuff and fixed a couple of bugs
[gnupg.git] / zlib / README
1 zlib 1.0.4 is a general purpose data compression library.  All the code
2 is reentrant (thread safe).  The data format used by the zlib library
3 is described by RFCs (Request for Comments) 1950 to 1952 in the files 
4 ftp://ds.internic.net/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate
5 format) and rfc1952.txt (gzip format). These documents are also available in
6 other formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
7
8 All functions of the compression library are documented in the file
9 zlib.h. A usage example of the library is given in the file example.c
10 which also tests that the library is working correctly. Another
11 example is given in the file minigzip.c. The compression library itself
12 is composed of all source files except example.c and minigzip.c.
13
14 To compile all files and run the test program, follow the instructions
15 given at the top of Makefile. In short "make test; make install"
16 should work for most machines.  For MSDOS, use one of the special
17 makefiles such as Makefile.msc; for VMS, use Make_vms.com or descrip.mms.
18
19 Questions about zlib should be sent to <zlib@quest.jpl.nasa.gov> or,
20 if this fails, to the addresses given below in the Copyright section.
21 The zlib home page is http://quest.jpl.nasa.gov/zlib/
22
23 The changes made in version 1.0.4 are documented in the file ChangeLog.
24 The main changes since 1.0.3 are:
25
26 - In very rare conditions, deflate(s, Z_FINISH) could fail to produce an EOF
27   bit, so the decompressor could decompress all the correct data but went
28   on to attempt decompressing extra garbage data. This affected minigzip too.
29 - zlibVersion and gzerror return const char* (needed for DLL)
30 - port to RISCOS (no fdopen, no multiple dots, no unlink, no fileno)
31
32
33 A Perl interface to zlib written by Paul Marquess <pmarquess@bfsec.bt.co.uk>
34 is in the CPAN (Comprehensive Perl Archive Network) sites, such as:
35 ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
36
37
38 Notes for some targets:
39
40 - For Turbo C the small model is supported only with reduced performance to
41   avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
42
43 - For 64-bit Iris, deflate.c must be compiled without any optimization.
44   With -O, one libpng test fails. The test works in 32 bit mode (with
45   the -32 compiler flag). The compiler bug has been reported to SGI.
46
47 - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1   
48   it works when compiled with cc.
49
50 - zlib doesn't work on HP-UX 9.05 with one cc compiler (the one not
51   accepting the -O option). It works with the other cc compiler.
52
53 - To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc
54   and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL
55   For help on building a zlib DLL, contact Alessandro Iacopetti
56   <iaco@email.alessandria.alpcom.it>  http://lisa.unial.it/iaco ,
57   or contact Brad Clarke <bclarke@cyberus.ca>.
58
59 - gzdopen is not supported on RISCOS
60
61
62 Acknowledgments:
63
64   The deflate format used by zlib was defined by Phil Katz. The deflate
65   and zlib specifications were written by Peter Deutsch. Thanks to all the
66   people who reported problems and suggested various improvements in zlib;
67   they are too numerous to cite here.
68
69 Copyright notice:
70
71  (C) 1995-1996 Jean-loup Gailly and Mark Adler
72
73   This software is provided 'as-is', without any express or implied
74   warranty.  In no event will the authors be held liable for any damages
75   arising from the use of this software.
76
77   Permission is granted to anyone to use this software for any purpose,
78   including commercial applications, and to alter it and redistribute it
79   freely, subject to the following restrictions:
80
81   1. The origin of this software must not be misrepresented; you must not
82      claim that you wrote the original software. If you use this software
83      in a product, an acknowledgment in the product documentation would be
84      appreciated but is not required.
85   2. Altered source versions must be plainly marked as such, and must not be
86      misrepresented as being the original software.
87   3. This notice may not be removed or altered from any source distribution.
88
89   Jean-loup Gailly        Mark Adler
90   gzip@prep.ai.mit.edu    madler@alumni.caltech.edu
91
92 If you use the zlib library in a product, we would appreciate *not*
93 receiving lengthy legal documents to sign. The sources are provided
94 for free but without warranty of any kind.  The library has been
95 entirely written by Jean-loup Gailly and Mark Adler; it does not
96 include third-party code.
97
98 If you redistribute modified sources, we would appreciate that you include
99 in the file ChangeLog history information documenting your changes.