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 /compressBound.3 | |
| parent | Separate out crc32_combine.3 (diff) | |
| download | zlib-man-pages-c857f9d7ef06ed53b4e4e81d4844e706e6da426d.tar.gz zlib-man-pages-c857f9d7ef06ed53b4e4e81d4844e706e6da426d.zip | |
Separate out compressBound.3
Diffstat (limited to '')
| -rw-r--r--[l---------] | compressBound.3 | 34 |
1 files changed, 33 insertions, 1 deletions
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 |