Documentation tweaks.
[official-gcc.git] / zlib / win32 / README-WIN32.txt
blobdf7ab7f4b34f901e69b756b7ef915a0753246eb1
1 ZLIB DATA COMPRESSION LIBRARY
3 zlib 1.2.11 is a general purpose data compression library.  All the code is
4 thread safe.  The data format used by the zlib library is described by RFCs
5 (Request for Comments) 1950 to 1952 in the files
6 http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format)
7 and rfc1952.txt (gzip format).
9 All functions of the compression library are documented in the file zlib.h
10 (volunteer to write man pages welcome, contact zlib@gzip.org).  Two compiled
11 examples are distributed in this package, example and minigzip.  The example_d
12 and minigzip_d flavors validate that the zlib1.dll file is working correctly.
14 Questions about zlib should be sent to <zlib@gzip.org>.  The zlib home page
15 is http://zlib.net/ .  Before reporting a problem, please check this site to
16 verify that you have the latest version of zlib; otherwise get the latest
17 version and check whether the problem still exists or not.
19 PLEASE read DLL_FAQ.txt, and the the zlib FAQ http://zlib.net/zlib_faq.html
20 before asking for help.
23 Manifest:
25 The package zlib-1.2.11-win32-x86.zip will contain the following files:
27   README-WIN32.txt This document
28   ChangeLog        Changes since previous zlib packages
29   DLL_FAQ.txt      Frequently asked questions about zlib1.dll
30   zlib.3.pdf       Documentation of this library in Adobe Acrobat format
32   example.exe      A statically-bound example (using zlib.lib, not the dll)
33   example.pdb      Symbolic information for debugging example.exe
35   example_d.exe    A zlib1.dll bound example (using zdll.lib)
36   example_d.pdb    Symbolic information for debugging example_d.exe
38   minigzip.exe     A statically-bound test program (using zlib.lib, not the dll)
39   minigzip.pdb     Symbolic information for debugging minigzip.exe
41   minigzip_d.exe   A zlib1.dll bound test program (using zdll.lib)
42   minigzip_d.pdb   Symbolic information for debugging minigzip_d.exe
44   zlib.h           Install these files into the compilers' INCLUDE path to
45   zconf.h          compile programs which use zlib.lib or zdll.lib
47   zdll.lib         Install these files into the compilers' LIB path if linking
48   zdll.exp         a compiled program to the zlib1.dll binary
50   zlib.lib         Install these files into the compilers' LIB path to link zlib
51   zlib.pdb         into compiled programs, without zlib1.dll runtime dependency
52                    (zlib.pdb provides debugging info to the compile time linker)
54   zlib1.dll        Install this binary shared library into the system PATH, or
55                    the program's runtime directory (where the .exe resides)
56   zlib1.pdb        Install in the same directory as zlib1.dll, in order to debug
57                    an application crash using WinDbg or similar tools.
59 All .pdb files above are entirely optional, but are very useful to a developer
60 attempting to diagnose program misbehavior or a crash.  Many additional
61 important files for developers can be found in the zlib127.zip source package
62 available from http://zlib.net/ - review that package's README file for details.
65 Acknowledgments:
67 The deflate format used by zlib was defined by Phil Katz.  The deflate and
68 zlib specifications were written by L.  Peter Deutsch.  Thanks to all the
69 people who reported problems and suggested various improvements in zlib; they
70 are too numerous to cite here.
73 Copyright notice:
75   (C) 1995-2017 Jean-loup Gailly and Mark Adler
77   This software is provided 'as-is', without any express or implied
78   warranty.  In no event will the authors be held liable for any damages
79   arising from the use of this software.
81   Permission is granted to anyone to use this software for any purpose,
82   including commercial applications, and to alter it and redistribute it
83   freely, subject to the following restrictions:
85   1. The origin of this software must not be misrepresented; you must not
86      claim that you wrote the original software. If you use this software
87      in a product, an acknowledgment in the product documentation would be
88      appreciated but is not required.
89   2. Altered source versions must be plainly marked as such, and must not be
90      misrepresented as being the original software.
91   3. This notice may not be removed or altered from any source distribution.
93   Jean-loup Gailly        Mark Adler
94   jloup@gzip.org          madler@alumni.caltech.edu
96 If you use the zlib library in a product, we would appreciate *not* receiving
97 lengthy legal documents to sign.  The sources are provided for free but without
98 warranty of any kind.  The library has been entirely written by Jean-loup
99 Gailly and Mark Adler; it does not include third-party code.
101 If you redistribute modified sources, we would appreciate that you include in
102 the file ChangeLog history information documenting your changes.  Please read
103 the FAQ for more information on the distribution of modified source versions.