diff options
| author | June McEnroe <june@causal.agency> | 2018-11-09 00:24:00 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2018-11-09 00:24:00 -0500 |
| commit | e6477781302bd147c997e2f61166737f54aadd7d (patch) | |
| tree | afa5af4f99861acfcb05c56da1c1b8fc0af49c5d | |
| parent | Add crc32.3 (diff) | |
| download | zlib-man-pages-e6477781302bd147c997e2f61166737f54aadd7d.tar.gz zlib-man-pages-e6477781302bd147c997e2f61166737f54aadd7d.zip | |
Add adler32.3
| -rw-r--r-- | adler32.3 | 51 | ||||
| l--------- | adler32_z.3 | 1 |
2 files changed, 52 insertions, 0 deletions
diff --git a/adler32.3 b/adler32.3 new file mode 100644 index 0000000..18371a3 --- /dev/null +++ b/adler32.3 @@ -0,0 +1,51 @@ +.Dd November 9, 2018 +.Dt ADLER32 3 +.Os +. +.Sh NAME +.Nm adler32 , +.Nm adler32_z +.Nd update Adler-32 checksum +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft uLong +.Fn adler32 "uLong adler" "const Bytef *buf" "uInt len" +.Ft uLong +.Fn adler32_z "uLong adler" "const Bytef *buf" "z_size_t len" +. +.Sh DESCRIPTION +Update a running Adler-32 checksum with the bytes +.Fa "buf[0..len-1]" +and return the updated checksum. +If +.Fa buf +is +.Dv Z_NULL , +this function returns +the required initial value for the checksum. +. +.Pp +An Adler-32 checksum is almost as reliable as a CRC-32 +but can be computed much faster. +. +.Pp +.Fn adler32_z +is the same as +.Fn adler32 , +but with a +.Vt size_t +length. +. +.Sh EXAMPLES +.Bd -literal -offset indent +uLong adler = adler32(0L, Z_NULL, 0); + +while (read_buffer(buffer, length) != EOF) { + adler = adler32(adler, buffer, length); +} +if (adler != original_adler) error(); +.Ed diff --git a/adler32_z.3 b/adler32_z.3 new file mode 120000 index 0000000..630dd96 --- /dev/null +++ b/adler32_z.3 @@ -0,0 +1 @@ +adler32.3 \ No newline at end of file |