summaryrefslogtreecommitdiffstats
path: root/doc/zlib.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-05-05 14:29:48 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-05-05 14:29:48 (GMT)
commitb4ee8396d0f8b3626646235fd727414e997b8bbc (patch)
tree9f5636c893225616b45de4dd037c771ca44dadbd /doc/zlib.n
parentee3d9db0cccb2c38010453b8432933b3233f8f15 (diff)
downloadtcl-b4ee8396d0f8b3626646235fd727414e997b8bbc.zip
tcl-b4ee8396d0f8b3626646235fd727414e997b8bbc.tar.gz
tcl-b4ee8396d0f8b3626646235fd727414e997b8bbc.tar.bz2
start writing some documentation
Diffstat (limited to 'doc/zlib.n')
-rw-r--r--doc/zlib.n8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/zlib.n b/doc/zlib.n
index 9fa83c6..6f1564c 100644
--- a/doc/zlib.n
+++ b/doc/zlib.n
@@ -1,5 +1,5 @@
'\"
-'\" Copyright (c) 2008 Donal K. Fellows
+'\" Copyright (c) 2008-2012 Donal K. Fellows
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
@@ -317,6 +317,12 @@ A short-cut for
Return up to \fIcount\fR bytes from \fIstream\fR's internal buffers with the
transformation applied. If \fIcount\fR is omitted, the entire contents of the
buffers are returned.
+.
+\fIstream \fBheader\fR
+.
+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
.