Add inflateGetDictionary.3

3 files changed, 63 insertions, 0 deletions

diff --git a/Makefile b/Makefile
index 618166e..193cc85 100644
--- a/Makefile
+++ b/Makefile
@@ -20,6 +20,7 @@ MAN += deflateSetHeader.3
 MAN += deflateTune.3
 MAN += inflate.3
 MAN += inflateEnd.3
+MAN += inflateGetDictionary.3
 MAN += inflateInit.3
 MAN += inflateInit2.3
 MAN += inflateSetDictionary.3
diff --git a/inflateGetDictionary.3 b/inflateGetDictionary.3
new file mode 100644
index 0000000..23a445e
--- /dev/null
+++ b/inflateGetDictionary.3
@@ -0,0 +1,58 @@
+.Dd November 11, 2018
+.Dt INFLATEGETDICTIONARY 3
+.Os
+.
+.Sh NAME
+.Nm inflateGetDictionary
+.Nd inflate sliding dictionary
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.In zlib.h
+.Ft int
+.Fo inflateGetDictionary
+.Fa "z_streamp strm"
+.Fa "Bytef *dictionary"
+.Fa "uInt *dictLength"
+.Fc
+.
+.Sh DESCRIPTION
+Returns the sliding dictionary
+being maintained by
+.Xr inflate 3 .
+.Fa dictLength
+is set to the number of bytes
+in the dictionary,
+and that many bytes are copied to
+.Fa dictionary .
+.Fa dictionary
+must have enough space,
+where 32768 bytes is always enough.
+If
+.Fn inflateGetDictionary
+is called with
+.Fa dictionary
+equal to
+.Dv Z_NULL ,
+then only the dictionary length is returned,
+and nothing is copied.
+Similarly,
+if
+.Fa dictLength
+is
+.Dv Z_NULL ,
+then it is not set.
+.
+.Sh RETURN VALUES
+.Fn inflateGetDictionary
+returns
+.Dv Z_OK
+on success,
+or
+.Dv Z_STREAM_ERROR
+if the stream state is inconsistent.
+.
+.Sh SEE ALSO
+.Xr inflateSetDictionary 3
diff --git a/inflateSetDictionary.3 b/inflateSetDictionary.3
index 2dec694..abc6f52 100644
--- a/inflateSetDictionary.3
+++ b/inflateSetDictionary.3
@@ -69,3 +69,7 @@ or the stream state is inconsistent,
 if the given dictionary
 doesn't match the expected one
 (incorrect Adler-32 value).
+.
+.Sh SEE ALSO
+.Xr deflateGetDictionary 3 ,
+.Xr inflateGetDictionary 3