diff options
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | deflatePrime.3 | 51 |
2 files changed, 52 insertions, 0 deletions
diff --git a/Makefile b/Makefile index 2f6ad63..970c6a1 100644 --- a/Makefile +++ b/Makefile @@ -13,6 +13,7 @@ MAN += deflateInit.3 MAN += deflateInit2.3 MAN += deflateParams.3 MAN += deflatePending.3 +MAN += deflatePrime.3 MAN += deflateReset.3 MAN += deflateSetDictionary.3 MAN += deflateTune.3 diff --git a/deflatePrime.3 b/deflatePrime.3 new file mode 100644 index 0000000..17c37cd --- /dev/null +++ b/deflatePrime.3 @@ -0,0 +1,51 @@ +.Dd November 11, 2018 +.Dt DEFLATEPRIME 3 +.Os +. +.Sh NAME +.Nm deflatePrime +.Nd insert bits in deflate stream +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft int +.Fn deflatePrime "z_streamp strm" "int bits" "int value" +. +.Sh DESCRIPTION +.Fn deflatePrime +inserts bits in the deflate output stream. +The intent is that this function +is used to start off the deflate output +with the bits leftover +from a previous deflate stream +when appending to it. +As such, +this function can only be used for raw deflate, +and must be used before the first +.Xr deflate 3 +call +after a +.Xr deflateInit2 3 +or +.Xr deflateReset 3 . +.Fa bits +must be less than or equal to 16, +and that many of the least significant bits of +.Fa value +will be inserted in the output. +. +.Sh RETURN VALUES +.Fn deflatePrime +returns +.Dv Z_OK +if success, +.Dv Z_BUF_ERROR +if there was not enough room +in the internal buffer +to insert the bits, +or +.Dv Z_STREAM_ERROR +if the source stream state was inconsistent. |