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