From 8dac77d008d224e00f803150ce14c94be2cd58c8 Mon Sep 17 00:00:00 2001
From: Curtis McEnroe <june@causal.agency>
Date: Sun, 11 Nov 2018 16:59:24 -0500
Subject: Separate out inflateInit.3 and inflateEnd.3

---
 inflate.3 | 93 +++------------------------------------------------------------
 1 file changed, 3 insertions(+), 90 deletions(-)

(limited to 'inflate.3')

diff --git a/inflate.3 b/inflate.3
index 1996f14..7157ef1 100644
--- a/inflate.3
+++ b/inflate.3
@@ -4,7 +4,6 @@
 .
 .Sh NAME
 .Nm inflate ,
-.Nm inflateInit ,
 .Nm inflateEnd
 .Nd deflate decompression
 .
@@ -14,66 +13,9 @@
 .Sh SYNOPSIS
 .In zlib.h
 .Ft int
-.Fn inflateInit "z_streamp strm"
-.Ft int
 .Fn inflate "z_streamp strm" "int flush"
-.Ft int
-.Fn inflateEnd "z_streamp strm"
 .
 .Sh DESCRIPTION
-See
-.Xr deflate 3
-for a description of the
-.Vt z_streamp
-type.
-.
-.Pp
-.Fn inflateInit
-initializes the internal stream state for decompression.
-The fields
-.Fa next_in ,
-.Fa avail_in ,
-.Fa zalloc ,
-.Fa zfree
-and
-.Fa opaque
-must be initialized before by the caller.
-In the current version of
-.Fn inflateInit ,
-the provided input is not read or consumed.
-The allocation of a sliding window
-will be deferred to the first call of
-.Fn inflate
-(if the decompression does not complete on the first call).
-If
-.Fa zalloc
-and
-.Fa zfree
-are set to
-.Dv Z_NULL ,
-.Fn inflateInit
-updates them to use default allocation functions.
-.
-.Pp
-.Fn inflateInit
-does not perform any decompression.
-Actual decompression will be done by
-.Fn inflate .
-So
-.Fa next_in ,
-.Fa avail_in ,
-.Fa next_out
-and
-.Fa avail_out
-are unused and unchanged.
-The current implementation of
-.Fn inflateInit
-does not process any header information \(em
-that is deferred until
-.Fn inflate
-is called.
-.
-.Pp
 .Fn inflate
 decompresses as much data as possible,
 and stops when the input buffer becomes empty
@@ -380,31 +322,7 @@ The CRC-32 is checked against the gzip trailer,
 as is the uncompressed length,
 modulo 2^32.
 .
-.Pp
-.Fn inflateEnd
-causes all dynamically allocated data structures
-for this stream to be feed.
-This function discards any unprocessed input
-and does not flush any pending output.
-.
 .Sh RETURN VALUES
-.Fn inflateInit
-returns
-.Dv Z_OK
-if success,
-.Dv Z_MEM_ERROR
-if there was not enough memory,
-.Dv Z_VERSION_ERROR
-if the zlib library version
-is incompatible with the version assumed by the caller,
-or
-.Dv Z_STREAM_ERROR
-if the parameters are invalid,
-such as a null pointer to the structure.
-.Fa msg
-is set to null if there is no error message.
-.
-.Pp
 .Fn inflate
 returns
 .Dv Z_OK
@@ -461,11 +379,6 @@ to look for a good compression block
 if a partial recovery of the data
 is to be attempted.
 .
-.Pp
-.Fn inflateEnd
-returns
-.Dv Z_OK
-if success,
-or
-.Dv Z_STREAM_ERROR
-if the stream state was inconsistent.
+.Sh SEE ALSO
+.Xr inflateEnd 3 ,
+.Xr inflateInit 3
-- 
cgit 1.4.1