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
mit/txt/music.txt?id=91fdb644dc5a94463c5ea9a9995ced1cb0a077e4&follow=1'>Add See Ya LaterJune McEnroe 2020-02-20Remove wiki scriptJune McEnroe 2020-02-19Add The Obelisk GateJune McEnroe 2020-02-17Add Four Tet — HandsJune McEnroe 2020-02-12Simplify macOS notify-sendJune McEnroe 2020-02-12Add imbox and notemap to pageJune McEnroe 2020-02-12Collapse simple linksJune McEnroe 2020-02-12Move catgirl up the pageJune McEnroe 2020-02-12Update catgirl pty grabJune McEnroe 2020-02-12Link to cgit /about pages where appropriateJune McEnroe 2020-02-11Separate LINKS from BINS for html to workJune McEnroe 2020-02-11Add margin to Bl-bullet itemsJune McEnroe 2020-02-10Match URLs inside parens or with paired parens insideJune McEnroe 2020-02-10Duplicate effective URL before passing it back to curlJune McEnroe 2020-02-09Add To Be Taught, If FortunateJune McEnroe 2020-02-04Add The Future of Another TimelineJune McEnroe 2020-01-31Reorganize the Makefile for the umpteenth timeJune McEnroe 2020-01-28Change scout sensitivity to 1.4June McEnroe 2020-01-28Import shows.txtJune McEnroe