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
020-10-27 09:44:45 -0400'>2020-10-27Allow cd host:path over sshJune McEnroe 2020-10-07Use mandoc -T utf8 for text.June McEnroe 2020-09-20Add The Awakened KingdomJune McEnroe 2020-09-12Move /opt/local back, cheat port select to use system manJune McEnroe 2020-09-12Move /opt/local behind /usr againJune McEnroe 2020-09-12Enable toc in cgit renderings of man pagesJune McEnroe 2020-09-11Install mandoc on macOSJune McEnroe 2020-09-11Rewrite install script yet againJune McEnroe 2020-09-11Remove NetBSD from install scriptJune McEnroe 2020-09-11Use MacPorts rather than pkgsrcJune McEnroe 2020-09-11Add debian VM name to sshJune McEnroe 2020-09-11Add influencer tweetJune McEnroe 2020-09-10Add The Kingdom of GodsJune McEnroe 2020-09-07Add SunglassesJune McEnroe 2020-09-06Add Between the BreathsJune McEnroe 2020-09-04Open /dev/tty in nudgeJune McEnroe 2020-09-04Add nudgeJune McEnroe 2020-09-03Build fbclock with -lzJune McEnroe 2020-08-29Add tweets from retweetsJune McEnroe