From c503b3daa55ffca5b17b7482a35120d19f6b2451 Mon Sep 17 00:00:00 2001
From: Curtis McEnroe <june@causal.agency>
Date: Sun, 11 Nov 2018 17:07:33 -0500
Subject: Add deflatePrime.3

---
 deflatePrime.3 | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 deflatePrime.3

(limited to 'deflatePrime.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.
-- 
cgit 1.4.1