README 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. ZLIB DATA COMPRESSION LIBRARY
  2. zlib 1.2.3 is a general purpose data compression library. All the code is
  3. thread safe. The data format used by the zlib library is described by RFCs
  4. (Request for Comments) 1950 to 1952 in the files
  5. http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format)
  6. and rfc1952.txt (gzip format). These documents are also available in other
  7. formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
  8. All functions of the compression library are documented in the file zlib.h
  9. (volunteer to write man pages welcome, contact zlib@gzip.org). A usage example
  10. of the library is given in the file example.c which also tests that the library
  11. is working correctly. Another example is given in the file minigzip.c. The
  12. compression library itself is composed of all source files except example.c and
  13. minigzip.c.
  14. To compile all files and run the test program, follow the instructions given at
  15. the top of Makefile. In short "make test; make install" should work for most
  16. machines. For Unix: "./configure; make test; make install". For MSDOS, use one
  17. of the special makefiles such as Makefile.msc. For VMS, use make_vms.com.
  18. Questions about zlib should be sent to <zlib@gzip.org>, or to Gilles Vollant
  19. <info@winimage.com> for the Windows DLL version. The zlib home page is
  20. http://www.zlib.org or http://www.gzip.org/zlib/ Before reporting a problem,
  21. please check this site to verify that you have the latest version of zlib;
  22. otherwise get the latest version and check whether the problem still exists or
  23. not.
  24. PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html before asking
  25. for help.
  26. Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997
  27. issue of Dr. Dobb's Journal; a copy of the article is available in
  28. http://dogma.net/markn/articles/zlibtool/zlibtool.htm
  29. The changes made in version 1.2.3 are documented in the file ChangeLog.
  30. Unsupported third party contributions are provided in directory "contrib".
  31. A Java implementation of zlib is available in the Java Development Kit
  32. http://java.sun.com/j2se/1.4.2/docs/api/java/util/zip/package-summary.html
  33. See the zlib home page http://www.zlib.org for details.
  34. A Perl interface to zlib written by Paul Marquess <pmqs@cpan.org> is in the
  35. CPAN (Comprehensive Perl Archive Network) sites
  36. http://www.cpan.org/modules/by-module/Compress/
  37. A Python interface to zlib written by A.M. Kuchling <amk@amk.ca> is
  38. available in Python 1.5 and later versions, see
  39. http://www.python.org/doc/lib/module-zlib.html
  40. A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com> is
  41. availlable at http://www.oche.de/~akupries/soft/trf/trf_zip.html
  42. An experimental package to read and write files in .zip format, written on top
  43. of zlib by Gilles Vollant <info@winimage.com>, is available in the
  44. contrib/minizip directory of zlib.
  45. Notes for some targets:
  46. - For Windows DLL versions, please see win32/DLL_FAQ.txt
  47. - For 64-bit Irix, deflate.c must be compiled without any optimization. With
  48. -O, one libpng test fails. The test works in 32 bit mode (with the -n32
  49. compiler flag). The compiler bug has been reported to SGI.
  50. - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works
  51. when compiled with cc.
  52. - On Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is
  53. necessary to get gzprintf working correctly. This is done by configure.
  54. - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with
  55. other compilers. Use "make test" to check your compiler.
  56. - gzdopen is not supported on RISCOS, BEOS and by some Mac compilers.
  57. - For PalmOs, see http://palmzlib.sourceforge.net/
  58. - When building a shared, i.e. dynamic library on Mac OS X, the library must be
  59. installed before testing (do "make install" before "make test"), since the
  60. library location is specified in the library.
  61. Acknowledgments:
  62. The deflate format used by zlib was defined by Phil Katz. The deflate
  63. and zlib specifications were written by L. Peter Deutsch. Thanks to all the
  64. people who reported problems and suggested various improvements in zlib;
  65. they are too numerous to cite here.
  66. Copyright notice:
  67. (C) 1995-2004 Jean-loup Gailly and Mark Adler
  68. This software is provided 'as-is', without any express or implied
  69. warranty. In no event will the authors be held liable for any damages
  70. arising from the use of this software.
  71. Permission is granted to anyone to use this software for any purpose,
  72. including commercial applications, and to alter it and redistribute it
  73. freely, subject to the following restrictions:
  74. 1. The origin of this software must not be misrepresented; you must not
  75. claim that you wrote the original software. If you use this software
  76. in a product, an acknowledgment in the product documentation would be
  77. appreciated but is not required.
  78. 2. Altered source versions must be plainly marked as such, and must not be
  79. misrepresented as being the original software.
  80. 3. This notice may not be removed or altered from any source distribution.
  81. Jean-loup Gailly Mark Adler
  82. jloup@gzip.org madler@alumni.caltech.edu
  83. If you use the zlib library in a product, we would appreciate *not*
  84. receiving lengthy legal documents to sign. The sources are provided
  85. for free but without warranty of any kind. The library has been
  86. entirely written by Jean-loup Gailly and Mark Adler; it does not
  87. include third-party code.
  88. If you redistribute modified sources, we would appreciate that you include
  89. in the file ChangeLog history information documenting your changes. Please
  90. read the FAQ for more information on the distribution of modified source
  91. versions.