From af28fa64622c36ee5cac7a389b551daf2c103dbb Mon Sep 17 00:00:00 2001
From: Curtis McEnroe <june@causal.agency>
Date: Sat, 10 Nov 2018 14:06:27 -0500
Subject: Add deflateCopy.3

---
 deflateCopy.3 | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 deflateCopy.3

(limited to 'deflateCopy.3')

diff --git a/deflateCopy.3 b/deflateCopy.3
new file mode 100644
index 0000000..1281c36
--- /dev/null
+++ b/deflateCopy.3
@@ -0,0 +1,52 @@
+.Dd November 10, 2018
+.Dt DEFLATECOPY 3
+.Os
+.
+.Sh NAME
+.Nm deflateCopy
+.Nd copy deflate stream
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.Ft int
+.Fn deflateCopy "z_streamp dest" "z_streamp source"
+.
+.Sh DESCRIPTION
+Sets the destination stream
+as a complete copy of the source stream.
+.
+.Pp
+This function can be useful when
+several compression strategies will be tried,
+for example when there are several ways of
+pre-processing the input data with a filter.
+The streams that will be discarded
+should then be freed by calling
+.Xr deflateEnd 3 .
+Note that
+.Fn deflateCopy
+duplicates the internal compression state
+which can be quite large,
+so this strategy is slow
+and can consume lots of memory.
+.
+.Sh RETURN VALUES
+.Fn deflateCopy
+returns
+.Dv Z_OK
+if success,
+.Dv Z_MEM_ERROR
+if there was not enough memory,
+.Dv Z_STREAM_ERROR
+if the source stream state was inconsistent
+.Po
+such as
+.Fa zalloc
+being
+.Dv Z_NULL
+.Pc .
+.Fa msg
+is left unchanged
+in both source and destination.
-- 
cgit 1.4.1