Separate out deflateGetDictionary.3

3 files changed, 75 insertions, 59 deletions

diff --git a/Makefile b/Makefile
index 1f6b2a4..549ba86 100644
--- a/Makefile
+++ b/Makefile
@@ -7,6 +7,7 @@ MAN += crc32_combine.3
 MAN += deflate.3
 MAN += deflateBound.3
 MAN += deflateCopy.3
+MAN += deflateGetDictionary.3
 MAN += deflateInit2.3
 MAN += deflateParams.3
 MAN += deflatePending.3
@@ -23,7 +24,6 @@ MLINKS += compress.3 compress2.3
 MLINKS += crc32.3 crc32_z.3
 MLINKS += deflate.3 deflateEnd.3
 MLINKS += deflate.3 deflateInit.3
-MLINKS += deflateSetDictionary.3 deflateGetDictionary.3
 MLINKS += inflate.3 inflateEnd.3
 MLINKS += inflate.3 inflateInit.3
 MLINKS += uncompress.3 uncompress2.3
diff --git a/deflateGetDictionary.3 b/deflateGetDictionary.3
index 9c55755..729b23d 120000..100644
--- a/deflateGetDictionary.3
+++ b/deflateGetDictionary.3
@@ -1 +1,69 @@
-deflateSetDictionary.3
\ No newline at end of file
+.Dd November 10, 2018
+.Dt DEFLATEGETDICTIONARY 3
+.Os
+.
+.Sh NAME
+.Nm deflateGetDictionary
+.Nd deflate sliding dictionary
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.In zlib.h
+.Ft int
+.Fo deflateGetDictionary
+.Fa "z_streamp strm"
+.Fa "Bytef *dictionary"
+.Fa "uInt *dictLength"
+.Fc
+.
+.Sh DESCRIPTION
+Returns the sliding dictionary
+being maintained by deflate.
+.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 deflateGetDictionary
+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.
+.
+.Pp
+.Fn deflateGetDictionary
+may return a length less than the window size,
+even when more than the window size in input
+has been provided.
+It may return up to 258 bytes less in that case,
+due to how zlib's implementation of deflate
+manages the sliding window and lookahead for matches,
+where matches can be up to 258 bytes long.
+If the application needs the last window-size bytes of input,
+then that would need to be saved by the application
+outside of zlib.
+.
+.Sh RETURN VALUES
+.Fn deflateGetDictionary
+returns
+.Dv Z_OK
+on success,
+or
+.Dv Z_STREAM_ERROR
+if the stream state is inconsistent.
+.
+.Sh SEE ALSO
+.Xr deflateSetDictionary 3
diff --git a/deflateSetDictionary.3 b/deflateSetDictionary.3
index 91728ce..dc3a891 100644
--- a/deflateSetDictionary.3
+++ b/deflateSetDictionary.3
@@ -3,9 +3,8 @@
 .Os
 .
 .Sh NAME
-.Nm deflateSetDictionary ,
-.Nm deflateGetDictionary
-.Nd deflate sliding dictionary
+.Nm deflateSetDictionary
+.Nd initialize compression dictionary
 .
 .Sh LIBRARY
 .Lb libz
@@ -19,13 +18,6 @@
 .Fa "uInt dictLength"
 .Fc
 .
-.Ft int
-.Fo deflateGetDictionary
-.Fa "z_streamp strm"
-.Fa "Bytef *dictionary"
-.Fa "uInt *dictLength"
-.Fc
-.
 .Sh DESCRIPTION
 .Fn deflateSetDictionary
 initializes the compression dictionary
@@ -114,45 +106,6 @@ does not perform any compression:
 this will be done by
 .Xr deflate 3 .
 .
-.Pp
-.Fn deflateGetDictionary
-returns the sliding dictionary
-being maintained by deflate.
-.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 deflateGetDictionary
-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.
-.
-.Pp
-.Fn deflateGetDictionary
-may return a length less than the window size,
-even when more than the window size in input
-has been provided.
-It may return up to 258 bytes less in that case,
-due to how zlib's implementation of deflate
-manages the sliding window and lookahead for matches,
-where matches can be up to 258 bytes long.
-If the application needs the last window-size bytes of input,
-then that would need to be saved by the application
-outside of zlib.
-.
 .Sh RETURN VALUES
 .Fn deflateSetDictionary
 returns
@@ -174,11 +127,6 @@ or if not at a block boundary
 for raw deflate
 .Pc .
 .
-.Pp
-.Fn deflateGetDictionary
-returns
-.Dv Z_OK
-on success,
-or
-.Dv Z_STREAM_ERROR
-if the stream state is inconsistent.
+.Sh SEE ALSO
+.Xr deflateGetDictionary 3 ,
+.Xr inflateSetDictionary 3