8e074056 |
1 | //----------------------------------------------------------------------------- |
2 | // This version of zlib is modified for use within the Proxmark3 project. |
3 | // Files from the original distribution which are not required for this |
4 | // purpose are not included. All modifications can easily be found |
5 | // by searching for #ifdef ZLIB_PM3_TUNED and #ifndef ZLIB_PM3_TUNED. |
6 | // |
7 | // The rest of this file consists of the original README content |
8 | //----------------------------------------------------------------------------- |
9 | |
10 | ZLIB DATA COMPRESSION LIBRARY |
11 | |
12 | zlib 1.2.8 is a general purpose data compression library. All the code is |
13 | thread safe. The data format used by the zlib library is described by RFCs |
14 | (Request for Comments) 1950 to 1952 in the files |
15 | http://tools.ietf.org/html/rfc1950 (zlib format), rfc1951 (deflate format) and |
16 | rfc1952 (gzip format). |
17 | |
18 | All functions of the compression library are documented in the file zlib.h |
19 | (volunteer to write man pages welcome, contact zlib@gzip.org). A usage example |
20 | of the library is given in the file test/example.c which also tests that |
21 | the library is working correctly. Another example is given in the file |
22 | test/minigzip.c. The compression library itself is composed of all source |
23 | files in the root directory. |
24 | |
25 | To compile all files and run the test program, follow the instructions given at |
26 | the top of Makefile.in. In short "./configure; make test", and if that goes |
27 | well, "make install" should work for most flavors of Unix. For Windows, use |
28 | one of the special makefiles in win32/ or contrib/vstudio/ . For VMS, use |
29 | make_vms.com. |
30 | |
31 | Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant |
32 | <info@winimage.com> for the Windows DLL version. The zlib home page is |
33 | http://zlib.net/ . Before reporting a problem, please check this site to |
34 | verify that you have the latest version of zlib; otherwise get the latest |
35 | version and check whether the problem still exists or not. |
36 | |
37 | PLEASE read the zlib FAQ http://zlib.net/zlib_faq.html before asking for help. |
38 | |
39 | Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997 |
40 | issue of Dr. Dobb's Journal; a copy of the article is available at |
41 | http://marknelson.us/1997/01/01/zlib-engine/ . |
42 | |
43 | The changes made in version 1.2.8 are documented in the file ChangeLog. |
44 | |
45 | Unsupported third party contributions are provided in directory contrib/ . |
46 | |
47 | zlib is available in Java using the java.util.zip package, documented at |
48 | http://java.sun.com/developer/technicalArticles/Programming/compression/ . |
49 | |
50 | A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is available |
51 | at CPAN (Comprehensive Perl Archive Network) sites, including |
52 | http://search.cpan.org/~pmqs/IO-Compress-Zlib/ . |
53 | |
54 | A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is |
55 | available in Python 1.5 and later versions, see |
56 | http://docs.python.org/library/zlib.html . |
57 | |
58 | zlib is built into tcl: http://wiki.tcl.tk/4610 . |
59 | |
60 | An experimental package to read and write files in .zip format, written on top |
61 | of zlib by Gilles Vollant <info@winimage.com>, is available in the |
62 | contrib/minizip directory of zlib. |
63 | |
64 | |
65 | Notes for some targets: |
66 | |
67 | - For Windows DLL versions, please see win32/DLL_FAQ.txt |
68 | |
69 | - For 64-bit Irix, deflate.c must be compiled without any optimization. With |
70 | -O, one libpng test fails. The test works in 32 bit mode (with the -n32 |
71 | compiler flag). The compiler bug has been reported to SGI. |
72 | |
73 | - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works |
74 | when compiled with cc. |
75 | |
76 | - On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is |
77 | necessary to get gzprintf working correctly. This is done by configure. |
78 | |
79 | - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with |
80 | other compilers. Use "make test" to check your compiler. |
81 | |
82 | - gzdopen is not supported on RISCOS or BEOS. |
83 | |
84 | - For PalmOs, see http://palmzlib.sourceforge.net/ |
85 | |
86 | |
87 | Acknowledgments: |
88 | |
89 | The deflate format used by zlib was defined by Phil Katz. The deflate and |
90 | zlib specifications were written by L. Peter Deutsch. Thanks to all the |
91 | people who reported problems and suggested various improvements in zlib; they |
92 | are too numerous to cite here. |
93 | |
94 | Copyright notice: |
95 | |
96 | (C) 1995-2013 Jean-loup Gailly and Mark Adler |
97 | |
98 | This software is provided 'as-is', without any express or implied |
99 | warranty. In no event will the authors be held liable for any damages |
100 | arising from the use of this software. |
101 | |
102 | Permission is granted to anyone to use this software for any purpose, |
103 | including commercial applications, and to alter it and redistribute it |
104 | freely, subject to the following restrictions: |
105 | |
106 | 1. The origin of this software must not be misrepresented; you must not |
107 | claim that you wrote the original software. If you use this software |
108 | in a product, an acknowledgment in the product documentation would be |
109 | appreciated but is not required. |
110 | 2. Altered source versions must be plainly marked as such, and must not be |
111 | misrepresented as being the original software. |
112 | 3. This notice may not be removed or altered from any source distribution. |
113 | |
114 | Jean-loup Gailly Mark Adler |
115 | jloup@gzip.org madler@alumni.caltech.edu |
116 | |
117 | If you use the zlib library in a product, we would appreciate *not* receiving |
118 | lengthy legal documents to sign. The sources are provided for free but without |
119 | warranty of any kind. The library has been entirely written by Jean-loup |
120 | Gailly and Mark Adler; it does not include third-party code. |
121 | |
122 | If you redistribute modified sources, we would appreciate that you include in |
123 | the file ChangeLog history information documenting your changes. Please read |
124 | the FAQ for more information on the distribution of modified source versions. |