summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README120
1 files changed, 62 insertions, 58 deletions
diff --git a/README b/README
index 26ab2b6..8ac79a1 100644
--- a/README
+++ b/README
@@ -1,38 +1,40 @@
1zlib 1.2.0 is a general purpose data compression library. All the code 1ZLIB DATA COMPRESSION LIBRARY
2is thread safe. The data format used by the zlib library 2
3is described by RFCs (Request for Comments) 1950 to 1952 in the files 3zlib 1.2.0.1 is a general purpose data compression library. All the code is
4http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate 4thread safe. The data format used by the zlib library is described by RFCs
5format) and rfc1952.txt (gzip format). These documents are also available in 5(Request for Comments) 1950 to 1952 in the files
6other formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html 6http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format)
7and rfc1952.txt (gzip format). These documents are also available in other
8formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
7 9
8All functions of the compression library are documented in the file zlib.h 10All functions of the compression library are documented in the file zlib.h
9(volunteer to write man pages welcome, contact jloup@gzip.org). A usage 11(volunteer to write man pages welcome, contact jloup@gzip.org). A usage example
10example of the library is given in the file example.c which also tests that 12of the library is given in the file example.c which also tests that the library
11the library is working correctly. Another example is given in the file 13is working correctly. Another example is given in the file minigzip.c. The
12minigzip.c. The compression library itself is composed of all source files 14compression library itself is composed of all source files except example.c and
13except example.c and minigzip.c. 15minigzip.c.
14 16
15To compile all files and run the test program, follow the instructions 17To compile all files and run the test program, follow the instructions given at
16given at the top of Makefile. In short "make test; make install" 18the top of Makefile. In short "make test; make install" should work for most
17should work for most machines. For Unix: "./configure; make test; make install" 19machines. For Unix: "./configure; make test; make install" For MSDOS, use one
18For MSDOS, use one of the special makefiles such as Makefile.msc. 20of the special makefiles such as Makefile.msc. For VMS, use Make_vms.com or
19For VMS, use Make_vms.com or descrip.mms. 21descrip.mms.
20 22
21Questions about zlib should be sent to <zlib@gzip.org>, or to 23Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant
22Gilles Vollant <info@winimage.com> for the Windows DLL version. 24<info@winimage.com> for the Windows DLL version. The zlib home page is
23The zlib home page is http://www.zlib.org or http://www.gzip.org/zlib/ 25http://www.zlib.org or http://www.gzip.org/zlib/ Before reporting a problem,
24Before reporting a problem, please check this site to verify that 26please check this site to verify that you have the latest version of zlib;
25you have the latest version of zlib; otherwise get the latest version and 27otherwise get the latest version and check whether the problem still exists or
26check whether the problem still exists or not. 28not.
27 29
28PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html 30PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html before asking
29before asking for help. 31for help.
30 32
31Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 33Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997
32issue of Dr. Dobb's Journal; a copy of the article is available in 34issue of Dr. Dobb's Journal; a copy of the article is available in
33http://dogma.net/markn/articles/zlibtool/zlibtool.htm 35http://dogma.net/markn/articles/zlibtool/zlibtool.htm
34 36
35The changes made in version 1.2.0 are documented in the file ChangeLog. 37The changes made in version 1.2.0.1 are documented in the file ChangeLog.
36 38
37Unsupported third party contributions are provided in directory "contrib". 39Unsupported third party contributions are provided in directory "contrib".
38 40
@@ -40,56 +42,56 @@ A Java implementation of zlib is available in the Java Development Kit
40http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html 42http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
41See the zlib home page http://www.zlib.org for details. 43See the zlib home page http://www.zlib.org for details.
42 44
43A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> 45A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is in the
44is in the CPAN (Comprehensive Perl Archive Network) sites 46CPAN (Comprehensive Perl Archive Network) sites
45http://www.cpan.org/modules/by-module/Compress/ 47http://www.cpan.org/modules/by-module/Compress/
46 48
47A Python interface to zlib written by A.M. Kuchling <amk@magnet.com> 49A Python interface to zlib written by A.M. Kuchling <amk@magnet.com> is
48is available in Python 1.5 and later versions, see 50available in Python 1.5 and later versions, see
49http://www.python.org/doc/lib/module-zlib.html 51http://www.python.org/doc/lib/module-zlib.html
50 52
51A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com> 53A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com> is
52is availlable at http://www.westend.com/~kupries/doc/trf/man/man.html 54availlable at http://www.westend.com/~kupries/doc/trf/man/man.html
53 55
54An experimental package to read and write files in .zip format, 56An experimental package to read and write files in .zip format, written on top
55written on top of zlib by Gilles Vollant <info@winimage.com>, is 57of zlib by Gilles Vollant <info@winimage.com>, is available at
56available at http://www.winimage.com/zLibDll/unzip.html 58http://www.winimage.com/zLibDll/unzip.html and also in the contrib/minizip
57and also in the contrib/minizip directory of zlib. 59directory of zlib.
58 60
59 61
60Notes for some targets: 62Notes for some targets:
61 63
62- To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc 64- To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc
63 and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL 65 and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL The
64 The zlib DLL support was initially done by Alessandro Iacopetti and is 66 zlib DLL support was initially done by Alessandro Iacopetti and is now
65 now maintained by Gilles Vollant <info@winimage.com>. Check the zlib DLL 67 maintained by Gilles Vollant <info@winimage.com>. Check the zlib DLL home
66 home page at http://www.winimage.com/zLibDll 68 page at http://www.winimage.com/zLibDll
67 69
68 From Visual Basic, you can call the DLL functions which do not take 70 From Visual Basic, you can call the DLL functions which do not take a
69 a structure as argument: compress, uncompress and all gz* functions. 71 structure as argument: compress, uncompress and all gz* functions. See
70 See contrib/visual-basic.txt for more information, or get 72 contrib/visual-basic.txt for more information, or get
71 http://www.tcfb.com/dowseware/cmp-z-it.zip 73 http://www.tcfb.com/dowseware/cmp-z-it.zip
72 74
73- For 64-bit Irix, deflate.c must be compiled without any optimization. 75- For 64-bit Irix, deflate.c must be compiled without any optimization. With
74 With -O, one libpng test fails. The test works in 32 bit mode (with 76 -O, one libpng test fails. The test works in 32 bit mode (with the -n32
75 the -n32 compiler flag). The compiler bug has been reported to SGI. 77 compiler flag). The compiler bug has been reported to SGI.
76 78
77- zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 79- zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works
78 it works when compiled with cc. 80 when compiled with cc.
79 81
80- on Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 82- On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is
81 is necessary to get gzprintf working correctly. This is done by configure. 83 necessary to get gzprintf working correctly. This is done by configure.
82 84
83- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works 85- zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with
84 with other compilers. Use "make test" to check your compiler. 86 other compilers. Use "make test" to check your compiler.
85 87
86- gzdopen is not supported on RISCOS, BEOS and by some Mac compilers. 88- gzdopen is not supported on RISCOS, BEOS and by some Mac compilers.
87 89
88- For Turbo C the small model is supported only with reduced performance to 90- For Turbo C the small model is supported only with reduced performance to
89 avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3 91 avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
90 92
91- For PalmOs, see http://www.cs.uit.no/~perm/PASTA/pilot/software.html 93- For PalmOs, see http://www.cs.uit.no/~perm/PASTA/pilot/software.html Per
92 Per Harald Myrvang <perm@stud.cs.uit.no> 94 Harald Myrvang <perm@stud.cs.uit.no>
93 95
94 96
95Acknowledgments: 97Acknowledgments:
@@ -129,4 +131,6 @@ entirely written by Jean-loup Gailly and Mark Adler; it does not
129include third-party code. 131include third-party code.
130 132
131If you redistribute modified sources, we would appreciate that you include 133If you redistribute modified sources, we would appreciate that you include
132in the file ChangeLog history information documenting your changes. 134in the file ChangeLog history information documenting your changes. Please
135read the FAQ for more information on the distribution of modified source
136versions.