external/zlib-1.2.11/zlib.3
author Sam Lantinga <slouken@libsdl.org>
Fri, 26 Oct 2018 14:58:01 -0700
changeset 617 d64228a395fc
parent 521 9ed2f7d4a251
permissions -rw-r--r--
Fixed webp library detection when cross-compiling for Windows
slouken@521
     1
.TH ZLIB 3 "15 Jan 2017"
slouken@521
     2
.SH NAME
slouken@521
     3
zlib \- compression/decompression library
slouken@521
     4
.SH SYNOPSIS
slouken@521
     5
[see
slouken@521
     6
.I zlib.h
slouken@521
     7
for full description]
slouken@521
     8
.SH DESCRIPTION
slouken@521
     9
The
slouken@521
    10
.I zlib
slouken@521
    11
library is a general purpose data compression library.
slouken@521
    12
The code is thread safe, assuming that the standard library functions
slouken@521
    13
used are thread safe, such as memory allocation routines.
slouken@521
    14
It provides in-memory compression and decompression functions,
slouken@521
    15
including integrity checks of the uncompressed data.
slouken@521
    16
This version of the library supports only one compression method (deflation)
slouken@521
    17
but other algorithms may be added later
slouken@521
    18
with the same stream interface.
slouken@521
    19
.LP
slouken@521
    20
Compression can be done in a single step if the buffers are large enough
slouken@521
    21
or can be done by repeated calls of the compression function.
slouken@521
    22
In the latter case,
slouken@521
    23
the application must provide more input and/or consume the output
slouken@521
    24
(providing more output space) before each call.
slouken@521
    25
.LP
slouken@521
    26
The library also supports reading and writing files in
slouken@521
    27
.IR gzip (1)
slouken@521
    28
(.gz) format
slouken@521
    29
with an interface similar to that of stdio.
slouken@521
    30
.LP
slouken@521
    31
The library does not install any signal handler.
slouken@521
    32
The decoder checks the consistency of the compressed data,
slouken@521
    33
so the library should never crash even in the case of corrupted input.
slouken@521
    34
.LP
slouken@521
    35
All functions of the compression library are documented in the file
slouken@521
    36
.IR zlib.h .
slouken@521
    37
The distribution source includes examples of use of the library
slouken@521
    38
in the files
slouken@521
    39
.I test/example.c
slouken@521
    40
and
slouken@521
    41
.IR test/minigzip.c,
slouken@521
    42
as well as other examples in the
slouken@521
    43
.IR examples/
slouken@521
    44
directory.
slouken@521
    45
.LP
slouken@521
    46
Changes to this version are documented in the file
slouken@521
    47
.I ChangeLog
slouken@521
    48
that accompanies the source.
slouken@521
    49
.LP
slouken@521
    50
.I zlib
slouken@521
    51
is built in to many languages and operating systems, including but not limited to
slouken@521
    52
Java, Python, .NET, PHP, Perl, Ruby, Swift, and Go.
slouken@521
    53
.LP
slouken@521
    54
An experimental package to read and write files in the .zip format,
slouken@521
    55
written on top of
slouken@521
    56
.I zlib
slouken@521
    57
by Gilles Vollant (info@winimage.com),
slouken@521
    58
is available at:
slouken@521
    59
.IP
slouken@521
    60
http://www.winimage.com/zLibDll/minizip.html
slouken@521
    61
and also in the
slouken@521
    62
.I contrib/minizip
slouken@521
    63
directory of the main
slouken@521
    64
.I zlib
slouken@521
    65
source distribution.
slouken@521
    66
.SH "SEE ALSO"
slouken@521
    67
The
slouken@521
    68
.I zlib
slouken@521
    69
web site can be found at:
slouken@521
    70
.IP
slouken@521
    71
http://zlib.net/
slouken@521
    72
.LP
slouken@521
    73
The data format used by the
slouken@521
    74
.I zlib
slouken@521
    75
library is described by RFC
slouken@521
    76
(Request for Comments) 1950 to 1952 in the files:
slouken@521
    77
.IP
slouken@521
    78
http://tools.ietf.org/html/rfc1950 (for the zlib header and trailer format)
slouken@521
    79
.br
slouken@521
    80
http://tools.ietf.org/html/rfc1951 (for the deflate compressed data format)
slouken@521
    81
.br
slouken@521
    82
http://tools.ietf.org/html/rfc1952 (for the gzip header and trailer format)
slouken@521
    83
.LP
slouken@521
    84
Mark Nelson wrote an article about
slouken@521
    85
.I zlib
slouken@521
    86
for the Jan. 1997 issue of  Dr. Dobb's Journal;
slouken@521
    87
a copy of the article is available at:
slouken@521
    88
.IP
slouken@521
    89
http://marknelson.us/1997/01/01/zlib-engine/
slouken@521
    90
.SH "REPORTING PROBLEMS"
slouken@521
    91
Before reporting a problem,
slouken@521
    92
please check the
slouken@521
    93
.I zlib
slouken@521
    94
web site to verify that you have the latest version of
slouken@521
    95
.IR zlib ;
slouken@521
    96
otherwise,
slouken@521
    97
obtain the latest version and see if the problem still exists.
slouken@521
    98
Please read the
slouken@521
    99
.I zlib
slouken@521
   100
FAQ at:
slouken@521
   101
.IP
slouken@521
   102
http://zlib.net/zlib_faq.html
slouken@521
   103
.LP
slouken@521
   104
before asking for help.
slouken@521
   105
Send questions and/or comments to zlib@gzip.org,
slouken@521
   106
or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
slouken@521
   107
.SH AUTHORS AND LICENSE
slouken@521
   108
Version 1.2.11
slouken@521
   109
.LP
slouken@521
   110
Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
slouken@521
   111
.LP
slouken@521
   112
This software is provided 'as-is', without any express or implied
slouken@521
   113
warranty.  In no event will the authors be held liable for any damages
slouken@521
   114
arising from the use of this software.
slouken@521
   115
.LP
slouken@521
   116
Permission is granted to anyone to use this software for any purpose,
slouken@521
   117
including commercial applications, and to alter it and redistribute it
slouken@521
   118
freely, subject to the following restrictions:
slouken@521
   119
.LP
slouken@521
   120
.nr step 1 1
slouken@521
   121
.IP \n[step]. 3
slouken@521
   122
The origin of this software must not be misrepresented; you must not
slouken@521
   123
claim that you wrote the original software. If you use this software
slouken@521
   124
in a product, an acknowledgment in the product documentation would be
slouken@521
   125
appreciated but is not required.
slouken@521
   126
.IP \n+[step].
slouken@521
   127
Altered source versions must be plainly marked as such, and must not be
slouken@521
   128
misrepresented as being the original software.
slouken@521
   129
.IP \n+[step].
slouken@521
   130
This notice may not be removed or altered from any source distribution.
slouken@521
   131
.LP
slouken@521
   132
Jean-loup Gailly        Mark Adler
slouken@521
   133
.br
slouken@521
   134
jloup@gzip.org          madler@alumni.caltech.edu
slouken@521
   135
.LP
slouken@521
   136
The deflate format used by
slouken@521
   137
.I zlib
slouken@521
   138
was defined by Phil Katz.
slouken@521
   139
The deflate and
slouken@521
   140
.I zlib
slouken@521
   141
specifications were written by L. Peter Deutsch.
slouken@521
   142
Thanks to all the people who reported problems and suggested various
slouken@521
   143
improvements in
slouken@521
   144
.IR zlib ;
slouken@521
   145
who are too numerous to cite here.
slouken@521
   146
.LP
slouken@521
   147
UNIX manual page by R. P. C. Rodgers,
slouken@521
   148
U.S. National Library of Medicine (rodgers@nlm.nih.gov).
slouken@521
   149
.\" end of man page