summary refs log tree commit diff
path: root/doc/zlib/gzsetparams.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/zlib/gzsetparams.351
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/zlib/gzsetparams.3 b/doc/zlib/gzsetparams.3
new file mode 100644
index 00000000..ff544d23
--- /dev/null
+++ b/doc/zlib/gzsetparams.3
@@ -0,0 +1,51 @@
+.Dd January 15, 2017
+.Dt GZSETPARAMS 3
+.Os
+.
+.Sh NAME
+.Nm gzsetparams
+.Nd set compression level and strategy
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.In zlib.h
+.Ft int
+.Fn gzsetparams "gzFile file" "int level" "int strategy"
+.
+.Sh DESCRIPTION
+Dynamically update the compression level or strategy.
+See the description of
+.Xr deflateInit2 3
+for the meaning
+of these parameters.
+Previously provided data is flushed
+before the parameter change.
+.
+.Sh RETURN VALUES
+.Fn gzsetparams
+returns
+.Dv Z_OK
+if success,
+.Dv Z_STREAM_ERROR
+if the file was not opened for writing,
+.Dv Z_ERRNO
+if there is an error writing the flushed data,
+or
+.Dv Z_MEM_ERROR
+if there is a memory allocation error.
+.
+.Sh SEE ALSO
+.Xr deflateInit2 3 ,
+.Xr gzopen 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