summary refs log tree commit diff
path: root/zlibVersion.3
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2018-11-08 21:40:50 -0500
committerJune McEnroe <june@causal.agency>2020-12-27 22:10:42 -0500
commit470523cdad6c92d3b88a82f5e476cd4a4c61bcd2 (patch)
tree8217a4f88c46cc5f2792e17025d7044d2d0b2d28 /zlibVersion.3
downloadsrc-470523cdad6c92d3b88a82f5e476cd4a4c61bcd2.tar.gz
src-470523cdad6c92d3b88a82f5e476cd4a4c61bcd2.zip
Convert zlib.h comments to mdoc
Diffstat (limited to 'zlibVersion.3')
-rw-r--r--zlibVersion.345
1 files changed, 45 insertions, 0 deletions
diff --git a/zlibVersion.3 b/zlibVersion.3
new file mode 100644
index 00000000..35a9854b
--- /dev/null
+++ b/zlibVersion.3
@@ -0,0 +1,45 @@
+.Dd January 15, 2017
+.Dt ZLIBVERSION 3
+.Os
+.
+.Sh NAME
+.Nm zlibVersion
+.Nd check zlib version
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.In zlib.h
+.Fd #define ZLIB_VERSION \(dq1.2.11\(dq
+.Ft "const char *"
+.Fn zlibVersion void
+.
+.Sh DESCRIPTION
+The application can compare
+.Fn zlibVersion
+and
+.Dv ZLIB_VERSION
+for consistency.
+If the first character differs,
+the library code actually used
+is not compatible with the
+.In zlib.h
+header file used by the application.
+This check is automatically made by
+.Xr deflateInit 3
+and
+.Xr inflateInit 3 .
+.
+.Sh SEE ALSO
+.Xr zlibCompileFlags 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