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 .\"
   3 .TH ZLIB 3 "11 March 2002"
   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 and will have the same stream interface.
  19 .LP
  20 Compression can be done in a single step if the buffers are large enough
  21 (for example if an input file is mmap'ed),
  22 or can be done by repeated calls of the compression function.
  23 In the latter case,
  24 the application must provide more input and/or consume the output
  25 (providing more output space) before each call.
  26 .LP
  27 The library also supports reading and writing files in
  28 .I gzip
  29 (.gz) format
  30 with an interface similar to that of stdio.
  31 .LP
  32 The library does not install any signal handler.
  33 The decoder checks
  34 the consistency of the compressed data, so the library should never
  35 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 the files
  41 .I example.c
  42 and
  43 .IR minigzip.c .
  44 .LP
  45 A Java implementation of
  46 .IR zlib
  47 is available in the Java Development Kit 1.1
  48 .IP
  49 http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
  50 .LP
  51 A Perl interface to
  52 .IR zlib ,
  53 written by Paul Marquess (pmarquess@bfsec.bt.co.uk)
  54 is available at CPAN (Comprehensive Perl Archive Network) sites,
  55 such as:
  56 .IP
  57 ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
  58 .LP
  59 A Python interface to
  60 .IR zlib
  61 written by A.M. Kuchling <amk@magnet.com>
  62 is available from the Python Software Association sites, such as:
  63 .IP
  64 ftp://ftp.python.org/pub/python/contrib/Encoding/zlib*.tar.gz
  65 .SH "SEE ALSO"
  66 Questions about zlib should be sent to:
  67 .IP
  68 zlib@quest.jpl.nasa.gov
  69 or, if this fails, to the author addresses given below.
  70 The zlib home page is:
  71 .IP
  72 http://www.cdrom.com/pub/infozip/zlib/
  73 .LP
  74 The data format used by the zlib library is described by RFC
  75 (Request for Comments) 1950 to 1952 in the files:
  76 .IP
  77 ftp://ds.internic.net/rfc/rfc1950.txt (zlib format)
  78 .br
  79 rfc1951.txt (deflate format)
  80 .br
  81 rfc1952.txt (gzip format)
  82 .LP
  83 These documents are also available in other formats from:
  84 .IP
  85 ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
  86 .SH AUTHORS
  87 Version 1.1.4
  88 Copyright (C) 1995-2002 Jean-loup Gailly (jloup@gzip.org)
  89 and Mark Adler (madler@alumni.caltech.edu).
  90 .LP
  91 This software is provided "as-is,"
  92 without any express or implied warranty.
  93 In no event will the authors be held liable for any damages
  94 arising from the use of this software.
  95 See the distribution directory with respect to requirements
  96 governing redistribution.
  97 The deflate format used by
  98 .I zlib
  99 was defined by Phil Katz.
 100 The deflate and
 101 .I zlib
 102 specifications were written by L. Peter Deutsch.
 103 Thanks to all the people who reported problems and suggested various
 104 improvements in
 105 .IR zlib ;
 106 who are too numerous to cite here.
 107 .LP
 108 UNIX manual page by R. P. C. Rodgers,
 109 U.S. National Library of Medicine (rodgers@nlm.nih.gov).
 110 .\" end of man page