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 /adler32_combine.3 | |
| download | zlib-man-pages-470523cdad6c92d3b88a82f5e476cd4a4c61bcd2.tar.gz zlib-man-pages-470523cdad6c92d3b88a82f5e476cd4a4c61bcd2.zip | |
Convert zlib.h comments to mdoc
Diffstat (limited to 'adler32_combine.3')
| -rw-r--r-- | adler32_combine.3 | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/adler32_combine.3 b/adler32_combine.3 new file mode 100644 index 0000000..861f235 --- /dev/null +++ b/adler32_combine.3 @@ -0,0 +1,63 @@ +.Dd January 15, 2017 +.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 +. +.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 |