diff options
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | deflateTune.3 | 55 |
2 files changed, 56 insertions, 0 deletions
diff --git a/Makefile b/Makefile index 85e1510..d51dad1 100644 --- a/Makefile +++ b/Makefile @@ -7,6 +7,7 @@ MAN += deflateInit2.3 MAN += deflateParams.3 MAN += deflateReset.3 MAN += deflateSetDictionary.3 +MAN += deflateTune.3 MAN += inflate.3 MAN += uncompress.3 MAN += zlibCompileFlags.3 diff --git a/deflateTune.3 b/deflateTune.3 new file mode 100644 index 0000000..178b029 --- /dev/null +++ b/deflateTune.3 @@ -0,0 +1,55 @@ +.Dd November 11, 2018 +.Dt DEFLATETUNE 3 +.Os +. +.Sh NAME +.Nm deflateTune +.Nd fine tune compression parameters +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.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. |