libz.3 2.86 KB
Newer Older
1
.TH ZLIB 3 "14 Aug 2014"
Mark Adler's avatar
Mark Adler committed
2
.SH NAME
3
libz \- compression/decompression library
Mark Adler's avatar
Mark Adler committed
4 5 6 7 8 9
.SH SYNOPSIS
[see
.I zlib.h
for full description]
.SH DESCRIPTION
The
10
.I libz
Mark Adler's avatar
Mark Adler committed
11
library is a general purpose data compression library.
12
The code is thread safe.
Mark Adler's avatar
Mark Adler committed
13 14
It provides in-memory compression and decompression functions,
including integrity checks of the uncompressed data.
15
This version of the library supports only one compression method (deflation).
Mark Adler's avatar
Mark Adler committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29
.LP
Compression can be done in a single step if the buffers are large enough
or can be done by repeated calls of the compression function.
In the latter case,
the application must provide more input and/or consume the output
(providing more output space) before each call.
.LP
The library also supports reading and writing files in
.IR gzip (1)
(.gz) format
with an interface similar to that of stdio.
.LP
The library does not install any signal handler.
The decoder checks the consistency of the compressed data,
Mark Adler's avatar
Mark Adler committed
30
so the library should never crash even in the case of corrupted input.
Mark Adler's avatar
Mark Adler committed
31 32 33 34 35
.LP
All functions of the compression library are documented in the file
.IR zlib.h .
.SH "SEE ALSO"
The
36
.I Sortix zlib
Mark Adler's avatar
Mark Adler committed
37
web site can be found at:
Mark Adler's avatar
Mark Adler committed
38
.IP
39
https://sortix.org/libz/
Mark Adler's avatar
Mark Adler committed
40
.LP
41
The data format used by the libz library is described by RFC
Mark Adler's avatar
Mark Adler committed
42
(Request for Comments) 1950 to 1952 in the files:
Mark Adler's avatar
Mark Adler committed
43
.IP
Mark Adler's avatar
Mark Adler committed
44
http://tools.ietf.org/html/rfc1950 (for the zlib header and trailer format)
Mark Adler's avatar
Mark Adler committed
45
.br
Mark Adler's avatar
Mark Adler committed
46
http://tools.ietf.org/html/rfc1951 (for the deflate compressed data format)
Mark Adler's avatar
Mark Adler committed
47
.br
Mark Adler's avatar
Mark Adler committed
48
http://tools.ietf.org/html/rfc1952 (for the gzip header and trailer format)
Mark Adler's avatar
Mark Adler committed
49
.LP
Mark Adler's avatar
Mark Adler committed
50
Mark Nelson wrote an article about
Mark Adler's avatar
Mark Adler committed
51 52 53 54
.I zlib
for the Jan. 1997 issue of  Dr. Dobb's Journal;
a copy of the article is available at:
.IP
Mark Adler's avatar
Mark Adler committed
55
http://marknelson.us/1997/01/01/zlib-engine/
Mark Adler's avatar
Mark Adler committed
56 57 58
.SH "REPORTING PROBLEMS"
Before reporting a problem,
please check the
59
.I libz
Mark Adler's avatar
Mark Adler committed
60
web site to verify that you have the latest version of
61
.IR libz ;
Mark Adler's avatar
Mark Adler committed
62 63 64
otherwise,
obtain the latest version and see if the problem still exists.
Please read the
65
FAQ at the website
Mark Adler's avatar
Mark Adler committed
66 67
before asking for help.
.SH AUTHORS
68 69 70 71 72
This is Sortix libz. This is not zlib.
.LP
Sortix libz is based on the offical Zlib version 1.2.8 release.
.LP
Zlib version 1.2.8
Mark Adler's avatar
Mark Adler committed
73
Copyright (C) 1995-2013 Jean-loup Gailly (jloup@gzip.org)
Mark Adler's avatar
Mark Adler committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
and Mark Adler (madler@alumni.caltech.edu).
.LP
This software is provided "as-is,"
without any express or implied warranty.
In no event will the authors be held liable for any damages
arising from the use of this software.
See the distribution directory with respect to requirements
governing redistribution.
The deflate format used by
.I zlib
was defined by Phil Katz.
The deflate and
.I zlib
specifications were written by L. Peter Deutsch.
Thanks to all the people who reported problems and suggested various
improvements in
.IR zlib ;
who are too numerous to cite here.
.LP
UNIX manual page by R. P. C. Rodgers,
94 95
U.S. National Library of Medicine (rodgers@nlm.nih.gov);
subsequently adapted by Sortix libz.
Mark Adler's avatar
Mark Adler committed
96
.\" end of man page