diff options
author | June McEnroe <june@causal.agency> | 2018-11-08 21:40:50 -0500 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2020-12-27 22:10:42 -0500 |
commit | a3e8a3d6c00072a14a681d3bd93908d452a91ab8 (patch) | |
tree | a939e8c1cf70e16adae74fd467731bf8d8c4d562 /deflateReset.3 | |
download | src-a3e8a3d6c00072a14a681d3bd93908d452a91ab8.tar.gz src-a3e8a3d6c00072a14a681d3bd93908d452a91ab8.zip |
Convert zlib.h comments to mdoc
Diffstat (limited to '')
-rw-r--r-- | deflateReset.3 | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/deflateReset.3 b/deflateReset.3 new file mode 100644 index 00000000..1a18c507 --- /dev/null +++ b/deflateReset.3 @@ -0,0 +1,57 @@ +.Dd January 15, 2017 +.Dt DEFLATERESET 3 +.Os +. +.Sh NAME +.Nm deflateReset +.Nd reset deflate stream +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft int +.Fn deflateReset "z_streamp strm" +. +.Sh DESCRIPTION +This function is equivalent to +.Xr deflateEnd 3 +followed by +.Xr deflateInit 3 , +but does not free and reallocate +the internal compression state. +The stream will leave the compression level +and any other attributes +that may have been set unchanged. +. +.Sh RETURN VALUES +.Fn deflateReset +returns +.Dv Z_OK +if success, +or +.Dv Z_STREAM_ERROR +if the source stream state was inconsistent +.Po +such as +.Fa zalloc +or +.Fa state +being +.Dv Z_NULL +.Pc . +. +.Sh SEE ALSO +.Xr deflateEnd 3 , +.Xr deflateInit 3 +. +.Sh HISTORY +This manual page was converted from +.In zlib.h +to mdoc format by +.An June 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 |