summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-06-06 09:30:31 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-06-06 09:30:31 (GMT)
commitdd548295cad0d0d2a8171953d79a2380efdd7244 (patch)
treeaa7093755f0ba65facd87c9b2006fe9261c99afb /doc
parentdc3657b1b7d4d243084c3d11d2ddf5ff47135ebc (diff)
downloadtcl-dd548295cad0d0d2a8171953d79a2380efdd7244.zip
tcl-dd548295cad0d0d2a8171953d79a2380efdd7244.tar.gz
tcl-dd548295cad0d0d2a8171953d79a2380efdd7244.tar.bz2
more tests, more failures, more docs
Diffstat (limited to 'doc')
-rw-r--r--doc/zlib.n35
1 files changed, 30 insertions, 5 deletions
diff --git a/doc/zlib.n b/doc/zlib.n
index 2e08d71..ec3ea5a 100644
--- a/doc/zlib.n
+++ b/doc/zlib.n
@@ -277,10 +277,10 @@ the transformed data.
The full set of subcommands supported by a streaming instance command,
\fIstream\fR, is as follows:
.TP
-\fIstream \fBadd\fR ?\fIoption\fR? \fIdata\fR
+\fIstream \fBadd\fR ?\fIoption...\fR? \fIdata\fR
.
A short-cut for
-.QW "\fIstream \fBput \fIoption data\fR"
+.QW "\fIstream \fBput \fR?\fIoption...\fR? \fIdata\fR"
followed by
.QW "\fIstream \fBget\fR" .
.TP
@@ -325,14 +325,24 @@ Return the gzip header description dictionary extracted from the stream. Only
supported for streams created with their \fImode\fR parameter set to
\fBgunzip\fR.
.TP
-\fIstream \fBput\fR ?\fIoption\fR? \fIdata\fR
+\fIstream \fBput\fR ?\fIoption...\fR? \fIdata\fR
.
Append the contents of the binary string \fIdata\fR to \fIstream\fR's internal
-buffers while applying the transformation. If present, \fIoption\fR must be
-one of the following (or an unambiguous prefix) which are used to modify the
+buffers while applying the transformation. The following \fIoption\fRs are
+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
+decompressing the data.
+.VE
+.TP
\fB\-finalize\fR
.
Mark the stream as finished, ensuring that all bytes have been wholly
@@ -340,12 +350,22 @@ compressed or decompressed. For gzip streams, this also ensures that the
footer is written to the stream. The stream will need to be reset before
having more data written to it after this, though data can still be read out
of the stream with the \fBget\fR subcommand.
+.RS
+.PP
+This option is mutually exclusive with the \fB\-flush\fR and \fB\-fullflush\fR
+options.
+.RE
.TP
\fB\-flush\fR
.
Ensure that a decompressor consuming the bytes that the current (compressing)
stream is producing will be able to produce all the bytes that have been
compressed so far, at some performance penalty.
+.RS
+.PP
+This option is mutually exclusive with the \fB\-finalize\fR and
+\fB\-fullflush\fR options.
+.RE
.TP
\fB\-fullflush\fR
.
@@ -353,6 +373,11 @@ Ensure that not only can a decompressor handle all the bytes produced so far
(as with \fB\-flush\fR above) but also that it can restart from this point if
it detects that the stream is partially corrupt. This incurs a substantial
performance penalty.
+.RS
+.PP
+This option is mutually exclusive with the \fB\-finalize\fR and \fB\-flush\fR
+options.
+.RE
.RE
.TP
\fIstream \fBreset\fR