summaryrefslogtreecommitdiffstats
path: root/doc/zlib.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-06-22 07:52:24 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-06-22 07:52:24 (GMT)
commit397b74eec937a0848cd4c55dc47a7a35c9cdae68 (patch)
tree37142c85b8fa19b32d1ee26647d185cc386253e4 /doc/zlib.n
parenteb3f8d5d55d1b0f7f274cd344bf5f53534ab5e61 (diff)
downloadtcl-397b74eec937a0848cd4c55dc47a7a35c9cdae68.zip
tcl-397b74eec937a0848cd4c55dc47a7a35c9cdae68.tar.gz
tcl-397b74eec937a0848cd4c55dc47a7a35c9cdae68.tar.bz2
Documenting the stream command options better.
Diffstat (limited to 'doc/zlib.n')
-rw-r--r--doc/zlib.n39
1 files changed, 25 insertions, 14 deletions
diff --git a/doc/zlib.n b/doc/zlib.n
index ec3ea5a..2edd62f 100644
--- a/doc/zlib.n
+++ b/doc/zlib.n
@@ -222,39 +222,54 @@ command works, see \fBSTREAMING INSTANCE COMMAND\fR below. The following modes
are supported:
.RS
.TP
-\fBzlib stream compress\fR ?\fIlevel\fR?
+\fBzlib stream compress\fR ?\fB\-dictionary \fIbindata\fR? ?\fB\-level \fIlevel\fR?
.
The stream will be a compressing stream that produces zlib-format output,
using compression level \fIlevel\fR (if specified) which will be an integer
-from 0 to 9.
+from 0 to 9,
+.VS
+and the compression dictionary \fIbindata\fR (if specified).
+.VE
.TP
-\fBzlib stream decompress\fR
+\fBzlib stream decompress\fR ?\fB\-dictionary \fIbindata\fR?
.
The stream will be a decompressing stream that takes zlib-format input and
produces uncompressed output.
+.VS
+If \fIbindata\fR is supplied, it is a compression dictionary to use if
+required.
+.VE
.TP
-\fBzlib stream deflate\fR ?\fIlevel\fR?
+\fBzlib stream deflate\fR ?\fB\-dictionary \fIbindata\fR? ?\fB\-level \fIlevel\fR?
.
The stream will be a compressing stream that produces raw output, using
compression level \fIlevel\fR (if specified) which will be an integer from 0
-to 9.
+to 9,
+.VS
+and the compression dictionary \fIbindata\fR (if specified). Note that
+the raw compressed data includes no metadata about what compression
+dictionary was used, if any; that is a feature of the zlib-format data.
+.VE
.TP
-\fBzlib stream gunzip\fR
+\fBzlib stream gunzip\fR ?\fIlevel\fR?
.
The stream will be a decompressing stream that takes gzip-format input and
produces uncompressed output.
.TP
-\fBzlib stream gzip\fR ?\fIlevel\fR?
+\fBzlib stream gzip\fR ?\fB\-header \fIheader\fR? ?\fB\-level \fIlevel\fR?
.
The stream will be a compressing stream that produces gzip-format output,
using compression level \fIlevel\fR (if specified) which will be an integer
-from 0 to 9.
+from 0 to 9, and the header descriptor dictionary \fIheader\fR (if specified;
+for keys see \fBzlib gzip\fR).
'\" TODO: Header dictionary!
.TP
-\fBzlib stream inflate\fR
+\fBzlib stream inflate\fR ?\fB\-dictionary \fIbindata\fR?
.
The stream will be a decompressing stream that takes raw compressed input and
-produces uncompressed output.
+produces uncompressed output. If \fIbindata\fR is supplied, it is a
+compression dictionary to use. Note that there are no checks in place
+to determine whether the compression dictionary is correct.
.RE
.SS "CHECKSUMMING SUBCOMMANDS"
.TP
@@ -333,10 +348,6 @@ supported (or an unambiguous prefix of them), which are used to modify the
way in which the transformation is applied:
.RS
.TP
-\fB\-buffer\fI bufferSize\fR
-.
-\fITODO: document this\fR
-.TP
\fB\-dictionary\fI compressionDictionary\fR
.VS "TIP 400"
Sets a compression dictionary to use when working with compressing or