lib/libz/zlib.3

   1 .\" $FreeBSD: src/lib/libz/zlib.3,v 1.3.2.2 2003/02/01 13:33:12 sobomax Exp $
   2 .\" $DragonFly: src/lib/libz/Attic/zlib.3,v 1.2 2003/06/17 04:26:52 dillon Exp $
   3 .\"
   4 .TH ZLIB 3 "11 March 2002"
   5 .SH NAME
   6 zlib \- compression/decompression library
   7 .SH SYNOPSIS
   8 [see
   9 .I zlib.h
  10 for full description]
  11 .SH DESCRIPTION
  12 The
  13 .I zlib
  14 library is a general purpose data compression library.
  15 The code is thread safe.
  16 It provides in-memory compression and decompression functions,
  17 including integrity checks of the uncompressed data.
  18 This version of the library supports only one compression method (deflation)
  19 but other algorithms will be added later 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 .I gzip
  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
  35 the consistency of the compressed data, so the library should never
  36 crash even in case of corrupted input.
  37 .LP
  38 All functions of the compression library are documented in the file
  39 .IR zlib.h.
  40 The distribution source includes examples of use of the library
  41 the files
  42 .I example.c
  43 and
  44 .IR minigzip.c .
  45 .LP
  46 A Java implementation of
  47 .IR zlib
  48 is available in the Java Development Kit 1.1
  49 .IP
  50 http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
  51 .LP
  52 A Perl interface to
  53 .IR zlib ,
  54 written by Paul Marquess (pmarquess@bfsec.bt.co.uk)
  55 is available at CPAN (Comprehensive Perl Archive Network) sites,
  56 such as:
  57 .IP
  58 ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
  59 .LP
  60 A Python interface to
  61 .IR zlib
  62 written by A.M. Kuchling <amk@magnet.com>
  63 is available from the Python Software Association sites, such as:
  64 .IP
  65 ftp://ftp.python.org/pub/python/contrib/Encoding/zlib*.tar.gz
  66 .SH "SEE ALSO"
  67 Questions about zlib should be sent to:
  68 .IP
  69 zlib@quest.jpl.nasa.gov
  70 or, if this fails, to the author addresses given below.
  71 The zlib home page is:
  72 .IP
  73 http://www.cdrom.com/pub/infozip/zlib/
  74 .LP
  75 The data format used by the zlib library is described by RFC
  76 (Request for Comments) 1950 to 1952 in the files:
  77 .IP
  78 ftp://ds.internic.net/rfc/rfc1950.txt (zlib format)
  79 .br
  80 rfc1951.txt (deflate format)
  81 .br
  82 rfc1952.txt (gzip format)
  83 .LP
  84 These documents are also available in other formats from:
  85 .IP
  86 ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
  87 .SH AUTHORS
  88 Version 1.1.4
  89 Copyright (C) 1995-2002 Jean-loup Gailly (jloup@gzip.org)
  90 and Mark Adler (madler@alumni.caltech.edu).
  91 .LP
  92 This software is provided "as-is,"
  93 without any express or implied warranty.
  94 In no event will the authors be held liable for any damages
  95 arising from the use of this software.
  96 See the distribution directory with respect to requirements
  97 governing redistribution.
  98 The deflate format used by
  99 .I zlib
 100 was defined by Phil Katz.
 101 The deflate and
 102 .I zlib
 103 specifications were written by L. Peter Deutsch.
 104 Thanks to all the people who reported problems and suggested various
 105 improvements in
 106 .IR zlib ;
 107 who are too numerous to cite here.
 108 .LP
 109 UNIX manual page by R. P. C. Rodgers,
 110 U.S. National Library of Medicine (rodgers@nlm.nih.gov).
 111 .\" end of man page