summary refs log tree commit diff
path: root/doc/zlib/compressBound.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/zlib/compressBound.344
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/zlib/compressBound.3 b/doc/zlib/compressBound.3
new file mode 100644
index 00000000..5800e2ba
--- /dev/null
+++ b/doc/zlib/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