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