Fossil SCM

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

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button