summary refs log tree commit diff
path: root/doc/zlib/deflateTune.3
blob: 7269dec06b39310ca42ef258d31712ffec09228b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.Dd January 15, 2017
.Dt DEFLATETUNE 3
.Os
.
.Sh NAME
.Nm deflateTune
.Nd fine tune compression parameters
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft int
.Fo deflateTune
.Fa "z_streamp strm"
.Fa "int good_length"
.Fa "int max_lazy"
.Fa "int nice_length"
.Fa "int max_chain"
.Fc
.
.Sh DESCRIPTION
Fine tune deflate's internal compression parameters.
This should only be used
by someone who understands the algorithm
used by zlib's deflate
for searching for the best matching string,
and even then only by the most fanatic optimizer
trying to squeeze out the last compressed bit
for their specific input data.
Read the
.Pa deflate.c
source code for the meaning of the
.Fa max_lazy ,
.Fa good_length ,
.Fa nice_length ,
and
.Fa max_chain
parameters.
.
.Pp
.Fn deflateTune
can be called after
.Xr deflateInit 3
or
.Xr deflateInit2 3 .
.
.Sh RETURN VALUES
.Fn deflateTune
returns
.Dv Z_OK
on success,
or
.Dv Z_STREAM_ERROR
for an invalid deflate stream.
.
.Sh SEE ALSO
.Xr deflateInit 3 ,
.Xr deflateInit2 3
.
.Sh HISTORY
This manual page was converted from
.In zlib.h
to mdoc format by
.An C. McEnroe Aq Mt june@causal.agency .
.
.Sh AUTHORS
.An Jean-loup Gailly Aq Mt jloup@gzip.org
.An Mark Adler Aq Mt madler@alumni.caltech.edu
017-07-31 22:04:50 -0400'>2017-07-31Use designated initializer for hnel tableJune McEnroe 2017-07-30Add juneJune McEnroe 2017-07-30Play nethack as ValkyrieJune McEnroe 2017-07-28Add toggle to hnelJune McEnroe 2017-07-28Install slJune McEnroe 2017-07-25Add up, supJune McEnroe 2017-07-24Autopickup ringsJune McEnroe 2017-07-24Name dogJune McEnroe 2017-07-23Add nethackrcJune McEnroe 2017-07-23Remove useless setuid in briJune McEnroe 2017-07-23Clean up hnel a tiny bitJune McEnroe 2017-07-21Set window size in hnelJune McEnroe 2017-07-21Add hnelJune McEnroe 2017-07-19chmod 600 in dtchJune McEnroe