diff options
| -rw-r--r-- | doc/zlib.n | 21 |
1 files changed, 18 insertions, 3 deletions
@@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: zlib.n,v 1.1 2008/12/11 16:50:51 dkf Exp $ +'\" RCS: @(#) $Id: zlib.n,v 1.2 2008/12/12 16:34:45 dkf Exp $ '\" .so man.macros .TH zlib n 8.6 Tcl "Tcl Built-In Commands" @@ -24,12 +24,16 @@ Zlib library. It has the following subcommands .TP \fBzlib adler32\fI string\fR ?\fIinitValue\fR? . +Compute a checksum of binary string \fIstring\fR using the Adler-32 algorithm. +If given, \fIinitValue\fR is used to initialize the checksum engine. .TP \fBzlib compress\fI string\fR ?\fIlevel\fR? . .TP \fBzlib crc32\fI string\fR ?\fIinitValue\fR? . +Compute a checksum of binary string \fIstring\fR using the CRC-32 algorithm. +If given, \fIinitValue\fR is used to initialize the checksum engine. .TP \fBzlib decompress\fI string\fR ?\fIbufferSize\fR? . @@ -37,11 +41,22 @@ Zlib library. It has the following subcommands \fBzlib deflate\fI string\fR ?\fIlevel\fR? . .TP -\fBzlib gunzip\fI string\fR ?\fIbufferSize\fR? +\fBzlib gunzip\fI string\fR ?\fB\-headerVar \fIvarName\fR? . +Return the uncompressed contents of binary string \fIstring\fR, which must +have been in gzip format. If \fB\-headerVar\fR is given, store a dictionary +describing the contents of the gzip header in the variable called +\fIvarName\fR. +'\" TODO: describe dict fields .TP -\fBzlib gzip\fI string\fR ?\fIlevel\fR? +\fBzlib gzip\fI string\fR ?\fB\-level \fIlevel\fR? ?\fB\-header \fIdict\fR? . +Return the compressed contents of binary string \fIstring\fR in gzip format. +If \fB\-level\fR is given, \fIlevel\fR gives the compression level to use +(from 0, which is uncompressed, to 9, maximally compressed). If \fB\-header\fR +is given, \fIdict\fR is a dictionary containing values used for the gzip +header. +'\" TODO: describe dict fields .TP \fBzlib inflate\fI string\fR ?\fIbufferSize\fR? . |