README.zlib

   1 For your convenience and allowed by zlib's license terms:
   2 http://www.gzip.org/zlib/zlib_license.html a copy of the zlib source
   3 is bundled with SimGear in $(top_srcdir)/src-libs/.  You must have
   4 zlib installed before you can build SimGear.
   5
   6 - Most linux distributions have a zlib package.  For linux
   7   developers, we recommend ysou install your distributions package
   8   rather than building from source.
   9
  10 - Cygwin installs zlib automatically.
  11
  12 - For developers on most other platforms, you will have to build
  13   zlib from source and install it yourself.  For your convenience a
  14   tar ball of the zlib source is included with the simgear source
  15   distribution.  Untar the zlib source, and follow the included
  16   build and installation instructions.
  17
  18 Once zlib is installed you can return to configuring and building
  19 Simgear.
  20
  21 We now send you to the official zlib README ...
  22
  23
  24 =============================================================================
  25
  26
  27 zlib 1.1.4 is a general purpose data compression library.  All the code
  28 is thread safe.  The data format used by the zlib library
  29 is described by RFCs (Request for Comments) 1950 to 1952 in the files
  30 http://www.ietf.org/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate
  31 format) and rfc1952.txt (gzip format). These documents are also available in
  32 other formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
  33
  34 All functions of the compression library are documented in the file zlib.h
  35 (volunteer to write man pages welcome, contact jloup@gzip.org). A usage
  36 example of the library is given in the file example.c which also tests that
  37 the library is working correctly. Another example is given in the file
  38 minigzip.c. The compression library itself is composed of all source files
  39 except example.c and minigzip.c.
  40
  41 To compile all files and run the test program, follow the instructions
  42 given at the top of Makefile. In short "make test; make install"
  43 should work for most machines. For Unix: "./configure; make test; make install"
  44 For MSDOS, use one of the special makefiles such as Makefile.msc.
  45 For VMS, use Make_vms.com or descrip.mms.
  46
  47 Questions about zlib should be sent to <zlib@gzip.org>, or to
  48 Gilles Vollant <info@winimage.com> for the Windows DLL version.
  49 The zlib home page is http://www.zlib.org or http://www.gzip.org/zlib/
  50 Before reporting a problem, please check this site to verify that
  51 you have the latest version of zlib; otherwise get the latest version and
  52 check whether the problem still exists or not.
  53
  54 PLEASE read the zlib FAQ http://www.gzip.org/zlib/zlib_faq.html
  55 before asking for help.
  56
  57 Mark Nelson <markn@ieee.org> wrote an article about zlib for the Jan. 1997
  58 issue of  Dr. Dobb's Journal; a copy of the article is available in
  59 http://dogma.net/markn/articles/zlibtool/zlibtool.htm
  60
  61 The changes made in version 1.1.4 are documented in the file ChangeLog.
  62 The only changes made since 1.1.3 are bug corrections:
  63
  64 - ZFREE was repeated on same allocation on some error conditions.
  65   This creates a security problem described in
  66   http://www.zlib.org/advisory-2002-03-11.txt
  67 - Returned incorrect error (Z_MEM_ERROR) on some invalid data
  68 - Avoid accesses before window for invalid distances with inflate window
  69   less than 32K.
  70 - force windowBits > 8 to avoid a bug in the encoder for a window size
  71   of 256 bytes. (A complete fix will be available in 1.1.5).
  72
  73 The beta version 1.1.5beta includes many more changes. A new official
  74 version 1.1.5 will be released as soon as extensive testing has been
  75 completed on it.
  76
  77
  78 Unsupported third party contributions are provided in directory "contrib".
  79
  80 A Java implementation of zlib is available in the Java Development Kit
  81 http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
  82 See the zlib home page http://www.zlib.org for details.
  83
  84 A Perl interface to zlib written by Paul Marquess <pmarquess@bfsec.bt.co.uk>
  85 is in the CPAN (Comprehensive Perl Archive Network) sites
  86 http://www.cpan.org/modules/by-module/Compress/
  87
  88 A Python interface to zlib written by A.M. Kuchling <amk@magnet.com>
  89 is available in Python 1.5 and later versions, see
  90 http://www.python.org/doc/lib/module-zlib.html
  91
  92 A zlib binding for TCL written by Andreas Kupries <a.kupries@westend.com>
  93 is availlable at http://www.westend.com/~kupries/doc/trf/man/man.html
  94
  95 An experimental package to read and write files in .zip format,
  96 written on top of zlib by Gilles Vollant <info@winimage.com>, is
  97 available at http://www.winimage.com/zLibDll/unzip.html
  98 and also in the contrib/minizip directory of zlib.
  99
 100
 101 Notes for some targets:
 102
 103 - To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc
 104   and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL
 105   The zlib DLL support was initially done by Alessandro Iacopetti and is
 106   now maintained by Gilles Vollant <info@winimage.com>. Check the zlib DLL
 107   home page at http://www.winimage.com/zLibDll
 108
 109   From Visual Basic, you can call the DLL functions which do not take
 110   a structure as argument: compress, uncompress and all gz* functions.
 111   See contrib/visual-basic.txt for more information, or get
 112   http://www.tcfb.com/dowseware/cmp-z-it.zip
 113
 114 - For 64-bit Irix, deflate.c must be compiled without any optimization.
 115   With -O, one libpng test fails. The test works in 32 bit mode (with
 116   the -n32 compiler flag). The compiler bug has been reported to SGI.
 117
 118 - zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1
 119   it works when compiled with cc.
 120
 121 - on Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1
 122   is necessary to get gzprintf working correctly. This is done by configure.
 123
 124 - zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works
 125   with other compilers. Use "make test" to check your compiler.
 126
 127 - gzdopen is not supported on RISCOS, BEOS and by some Mac compilers.
 128
 129 - For Turbo C the small model is supported only with reduced performance to
 130   avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3
 131
 132 - For PalmOs, see http://www.cs.uit.no/~perm/PASTA/pilot/software.html
 133   Per Harald Myrvang <perm@stud.cs.uit.no>
 134
 135
 136 Acknowledgments:
 137
 138   The deflate format used by zlib was defined by Phil Katz. The deflate
 139   and zlib specifications were written by L. Peter Deutsch. Thanks to all the
 140   people who reported problems and suggested various improvements in zlib;
 141   they are too numerous to cite here.
 142
 143 Copyright notice:
 144
 145  (C) 1995-2002 Jean-loup Gailly and Mark Adler
 146
 147   This software is provided 'as-is', without any express or implied
 148   warranty.  In no event will the authors be held liable for any damages
 149   arising from the use of this software.
 150
 151   Permission is granted to anyone to use this software for any purpose,
 152   including commercial applications, and to alter it and redistribute it
 153   freely, subject to the following restrictions:
 154
 155   1. The origin of this software must not be misrepresented; you must not
 156      claim that you wrote the original software. If you use this software
 157      in a product, an acknowledgment in the product documentation would be
 158      appreciated but is not required.
 159   2. Altered source versions must be plainly marked as such, and must not be
 160      misrepresented as being the original software.
 161   3. This notice may not be removed or altered from any source distribution.
 162
 163   Jean-loup Gailly        Mark Adler
 164   jloup@gzip.org          madler@alumni.caltech.edu
 165
 166 If you use the zlib library in a product, we would appreciate *not*
 167 receiving lengthy legal documents to sign. The sources are provided
 168 for free but without warranty of any kind.  The library has been
 169 entirely written by Jean-loup Gailly and Mark Adler; it does not
 170 include third-party code.
 171
 172 If you redistribute modified sources, we would appreciate that you include
 173 in the file ChangeLog history information documenting your changes.