diff options
author | June McEnroe <june@causal.agency> | 2018-11-11 15:50:35 -0500 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2018-11-11 15:50:35 -0500 |
commit | c857f9d7ef06ed53b4e4e81d4844e706e6da426d (patch) | |
tree | 1f6222edbe81cd0b5d13e44bdec157d320bfaa4e | |
parent | Separate out crc32_combine.3 (diff) | |
download | zlib-man-pages-c857f9d7ef06ed53b4e4e81d4844e706e6da426d.tar.gz zlib-man-pages-c857f9d7ef06ed53b4e4e81d4844e706e6da426d.zip |
Separate out compressBound.3
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | compress.3 | 24 | ||||
-rw-r--r--[l---------] | compressBound.3 | 34 |
3 files changed, 38 insertions, 22 deletions
diff --git a/Makefile b/Makefile index 911f96e..1f6b2a4 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,7 @@ MAN += adler32.3 MAN += adler32_combine.3 MAN += compress.3 +MAN += compressBound.3 MAN += crc32.3 MAN += crc32_combine.3 MAN += deflate.3 @@ -19,7 +20,6 @@ MAN += zlibVersion.3 MLINKS += adler32.3 adler32_z.3 MLINKS += compress.3 compress2.3 -MLINKS += compress.3 compressBound.3 MLINKS += crc32.3 crc32_z.3 MLINKS += deflate.3 deflateEnd.3 MLINKS += deflate.3 deflateInit.3 diff --git a/compress.3 b/compress.3 index 799312d..c0e6547 100644 --- a/compress.3 +++ b/compress.3 @@ -4,8 +4,7 @@ . .Sh NAME .Nm compress , -.Nm compress2 , -.Nm compressBound +.Nm compress2 .Nd compress source buffer into destination buffer . .Sh LIBRARY @@ -31,9 +30,6 @@ .Fa "int level" .Fc . -.Ft uLong -.Fn compressBound "uLong sourceLen" -. .Sh DESCRIPTION Compresses the source buffer into the destination buffer. .Fa sourceLen @@ -56,21 +52,6 @@ with a parameter of .Dv Z_DEFAULT_COMPRESSION . . -.Pp -.Fn compressBound -returns an upper bound on the compressed size after -.Fn compress -or -.Fn compress2 -on -.Fa sourceLen -bytes. -It would be used before a -.Fn compress -or -.Fn compress2 -call to allocate the destination buffer. -. .Sh RETURN VALUES .Fn compress and @@ -86,3 +67,6 @@ if there was not enough room in the output buffer, if the .Fa level parameter is invalid. +. +.Sh SEE ALSO +.Xr compressBound 3 diff --git a/compressBound.3 b/compressBound.3 index 07c2c16..ca9635a 120000..100644 --- a/compressBound.3 +++ b/compressBound.3 @@ -1 +1,33 @@ -compress.3 \ No newline at end of file +.Dd November 8, 2018 +.Dt COMPRESSBOUND 3 +.Os +. +.Sh NAME +.Nm compressBound +.Nd compressed size upper bound +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft uLong +.Fn compressBound "uLong sourceLen" +. +.Sh DESCRIPTION +.Fn compressBound +returns an upper bound on the compressed size after +.Xr compress 3 +or +.Xr compress2 3 +on +.Fa sourceLen +bytes. +It would be used before a +.Xr compress 3 +or +.Xr compress2 3 +call to allocate the destination buffer. +. +.Sh SEE ALSO +.Xr compress 3 |