about summary refs log tree commit diff homepage
path: root/adler32_combine.3
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2018-11-11 15:35:56 -0500
committerJune McEnroe <june@causal.agency>2018-11-11 15:35:56 -0500
commit482654692b90e96110356ee23a3a612a62fb4414 (patch)
tree7cf04608a0b42c4a96d1b7126aedcc3114b7abe8 /adler32_combine.3
parentAdd missing .In zlib.h (diff)
downloadzlib-man-pages-482654692b90e96110356ee23a3a612a62fb4414.tar.gz
zlib-man-pages-482654692b90e96110356ee23a3a612a62fb4414.zip
Separate out adler32_combine.3
Diffstat (limited to 'adler32_combine.3')
-rw-r--r--[l---------]adler32_combine.354
1 files changed, 53 insertions, 1 deletions
diff --git a/adler32_combine.3 b/adler32_combine.3
index 630dd96..883ddb2 120000..100644
--- a/adler32_combine.3
+++ b/adler32_combine.3
@@ -1 +1,53 @@
-adler32.3
\ No newline at end of file
+.Dd November 9, 2018
+.Dt ADLER32_COMBINE 3
+.Os
+.
+.Sh NAME
+.Nm adler32_combine
+.Nd combine Adler-32 checksums
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.In zlib.h
+.Ft uLong
+.Fn adler32_combine "uLong adler1" "uLong adler2" "z_off_t len2"
+.
+.Sh DESCRIPTION
+Combine two Adler-32 checksums into one.
+For two sequences of bytes,
+.Va seq1
+and
+.Va seq2
+with lengths
+.Va len1
+and
+.Va len2 ,
+Adler-32 checksums were calculated for each,
+.Va adler1
+and
+.Va adler2 .
+.Fn adler32_combine
+returns the Adler-32 checksum of
+.Va seq1
+and
+.Va seq2
+concatenated,
+requiring only
+.Fa adler1 ,
+.Fa adler2 ,
+and
+.Fa len2 .
+Note that the
+.Vt z_off_t
+type
+.Pq like Vt off_t
+is a signed integer.
+If
+.Fa len2
+is negative,
+the result has no meaning or utility.
+.
+.Sh SEE ALSO
+.Xr adler32 3