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 | a3e8a3d6c00072a14a681d3bd93908d452a91ab8 (patch) | |
| tree | a939e8c1cf70e16adae74fd467731bf8d8c4d562 /compressBound.3 | |
| download | src-a3e8a3d6c00072a14a681d3bd93908d452a91ab8.tar.gz src-a3e8a3d6c00072a14a681d3bd93908d452a91ab8.zip | |
Convert zlib.h comments to mdoc
Diffstat (limited to 'compressBound.3')
| -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 00000000..d61891eb --- /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 June 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 |