common/dist/zlib/zlib.3

   1 .\"     $NetBSD: zlib.3,v 1.1.1.1 2006/01/14 20:10:34 christos Exp $
   2 .\"
   3 .TH ZLIB 3 "18 July 2005"
   4 .SH NAME
   5 zlib \- compression/decompression library
   6 .SH SYNOPSIS
   7 [see
   8 .I zlib.h
   9 for full description]
  10 .SH DESCRIPTION
  11 The
  12 .I zlib
  13 library is a general purpose data compression library.
  14 The code is thread safe.
  15 It provides in-memory compression and decompression functions,
  16 including integrity checks of the uncompressed data.
  17 This version of the library supports only one compression method (deflation)
  18 but other algorithms will be added later
  19 and will have the same stream interface.
  20 .LP
  21 Compression can be done in a single step if the buffers are large enough
  22 (for example if an input file is mmap'ed),
  23 or can be done by repeated calls of the compression function.
  24 In the latter case,
  25 the application must provide more input and/or consume the output
  26 (providing more output space) before each call.
  27 .LP
  28 The library also supports reading and writing files in
  29 .IR gzip (1)
  30 (.gz) format
  31 with an interface similar to that of stdio.
  32 .LP
  33 The library does not install any signal handler.
  34 The decoder checks the consistency of the compressed data,
  35 so the library should never crash even in case of corrupted input.
  36 .LP
  37 All functions of the compression library are documented in the file
  38 .IR zlib.h .
  39 The distribution source includes examples of use of the library
  40 in the files
  41 .I example.c
  42 and
  43 .IR minigzip.c .
  44 .LP
  45 Changes to this version are documented in the file
  46 .I ChangeLog
  47 that accompanies the source,
  48 and are concerned primarily with bug fixes and portability enhancements.
  49 .LP
  50 A Java implementation of
  51 .I zlib
  52 is available in the Java Development Kit 1.1:
  53 .IP
  54 http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
  55 .LP
  56 A Perl interface to
  57 .IR zlib ,
  58 written by Paul Marquess (pmqs@cpan.org),
  59 is available at CPAN (Comprehensive Perl Archive Network) sites,
  60 including:
  61 .IP
  62 http://www.cpan.org/modules/by-module/Compress/
  63 .LP
  64 A Python interface to
  65 .IR zlib ,
  66 written by A.M. Kuchling (amk@magnet.com),
  67 is available in Python 1.5 and later versions:
  68 .IP
  69 http://www.python.org/doc/lib/module-zlib.html
  70 .LP
  71 A
  72 .I zlib
  73 binding for
  74 .IR tcl (1),
  75 written by Andreas Kupries (a.kupries@westend.com),
  76 is availlable at:
  77 .IP
  78 http://www.westend.com/~kupries/doc/trf/man/man.html
  79 .LP
  80 An experimental package to read and write files in .zip format,
  81 written on top of
  82 .I zlib
  83 by Gilles Vollant (info@winimage.com),
  84 is available at:
  85 .IP
  86 http://www.winimage.com/zLibDll/unzip.html
  87 and also in the
  88 .I contrib/minizip
  89 directory of the main
  90 .I zlib
  91 web site.
  92 .SH "SEE ALSO"
  93 The
  94 .I zlib
  95 web site can be found at either of these locations:
  96 .IP
  97 http://www.zlib.org
  98 .br
  99 http://www.gzip.org/zlib/
 100 .LP
 101 The data format used by the zlib library is described by RFC
 102 (Request for Comments) 1950 to 1952 in the files:
 103 .IP
 104 http://www.ietf.org/rfc/rfc1950.txt (concerning zlib format)
 105 .br
 106 http://www.ietf.org/rfc/rfc1951.txt (concerning deflate format)
 107 .br
 108 http://www.ietf.org/rfc/rfc1952.txt (concerning gzip format)
 109 .LP
 110 These documents are also available in other formats from:
 111 .IP
 112 ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
 113 .LP
 114 Mark Nelson (markn@ieee.org) wrote an article about
 115 .I zlib
 116 for the Jan. 1997 issue of  Dr. Dobb's Journal;
 117 a copy of the article is available at:
 118 .IP
 119 http://dogma.net/markn/articles/zlibtool/zlibtool.htm
 120 .SH "REPORTING PROBLEMS"
 121 Before reporting a problem,
 122 please check the
 123 .I zlib
 124 web site to verify that you have the latest version of
 125 .IR zlib ;
 126 otherwise,
 127 obtain the latest version and see if the problem still exists.
 128 Please read the
 129 .I zlib
 130 FAQ at:
 131 .IP
 132 http://www.gzip.org/zlib/zlib_faq.html
 133 .LP
 134 before asking for help.
 135 Send questions and/or comments to zlib@gzip.org,
 136 or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
 137 .SH AUTHORS
 138 Version 1.2.3
 139 Copyright (C) 1995-2005 Jean-loup Gailly (jloup@gzip.org)
 140 and Mark Adler (madler@alumni.caltech.edu).
 141 .LP
 142 This software is provided "as-is,"
 143 without any express or implied warranty.
 144 In no event will the authors be held liable for any damages
 145 arising from the use of this software.
 146 See the distribution directory with respect to requirements
 147 governing redistribution.
 148 The deflate format used by
 149 .I zlib
 150 was defined by Phil Katz.
 151 The deflate and
 152 .I zlib
 153 specifications were written by L. Peter Deutsch.
 154 Thanks to all the people who reported problems and suggested various
 155 improvements in
 156 .IR zlib ;
 157 who are too numerous to cite here.
 158 .LP
 159 UNIX manual page by R. P. C. Rodgers,
 160 U.S. National Library of Medicine (rodgers@nlm.nih.gov).
 161 .\" end of man page