diff options
| author | June McEnroe <june@causal.agency> | 2018-11-08 21:40:50 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2020-12-27 22:10:42 -0500 |
| commit | 470523cdad6c92d3b88a82f5e476cd4a4c61bcd2 (patch) | |
| tree | 8217a4f88c46cc5f2792e17025d7044d2d0b2d28 /compressBound.3 | |
| download | zlib-man-pages-470523cdad6c92d3b88a82f5e476cd4a4c61bcd2.tar.gz zlib-man-pages-470523cdad6c92d3b88a82f5e476cd4a4c61bcd2.zip | |
Convert zlib.h comments to mdoc
Diffstat (limited to '')
| -rw-r--r-- | compressBound.3 | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/compressBound.3 b/compressBound.3 new file mode 100644 index 0000000..5800e2b --- /dev/null +++ b/compressBound.3 @@ -0,0 +1,44 @@ +.Dd January 15, 2017 +.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 , +.Xr deflateBound 3 +. +.Sh HISTORY +This manual page was converted from +.In zlib.h +to mdoc format by +.An C. McEnroe Aq Mt june@causal.agency . +. +.Sh AUTHORS +.An Jean-loup Gailly Aq Mt jloup@gzip.org +.An Mark Adler Aq Mt madler@alumni.caltech.edu |