diff options
Diffstat (limited to 'tcl/doc/http.n')
| -rw-r--r-- | tcl/doc/http.n | 42 |
1 files changed, 26 insertions, 16 deletions
diff --git a/tcl/doc/http.n b/tcl/doc/http.n index fb2de76392e..07d6af4102c 100644 --- a/tcl/doc/http.n +++ b/tcl/doc/http.n @@ -8,13 +8,13 @@ '\" RCS: @(#) $Id$ '\" .so man.macros -.TH "Http" n 8.3 Tcl "Tcl Built-In Commands" +.TH "http" n 2.4 http "Tcl Bundled Packages" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -Http \- Client-side implementation of the HTTP/1.0 protocol. +http \- Client-side implementation of the HTTP/1.0 protocol. .SH SYNOPSIS -\fBpackage require http ?2.3?\fP +\fBpackage require http ?2.4?\fR .sp \fB::http::config \fI?options?\fR .sp @@ -52,7 +52,7 @@ protocol. The package implements the GET, POST, and HEAD operations of HTTP/1.0. It allows configuration of a proxy host to get through firewalls. The package is compatible with the \fBSafesock\fR security policy, so it can be used by untrusted applets to do URL fetching from -a restricted set of hosts. This package can be extened to support +a restricted set of hosts. This package can be extended to support additional HTTP transport protocols, such as HTTPS, by providing a custom \fBsocket\fR command, via \fBhttp::register\fR. .PP @@ -110,11 +110,11 @@ non-empty. .TP \fB\-useragent\fP \fIstring\fP The value of the User-Agent header in the HTTP request. The default -is \fB"Tcl http client package 2.2."\fR +is \fB"Tcl http client package 2.4."\fR .RE .TP \fB::http::geturl\fP \fIurl\fP ?\fIoptions\fP? -The \fB::http::geturl \fR command is the main procedure in the package. +The \fB::http::geturl\fR command is the main procedure in the package. The \fB\-query\fR option causes a POST operation and the \fB\-validate\fR option causes a HEAD operation; otherwise, a GET operation is performed. The \fB::http::geturl\fR command @@ -126,13 +126,16 @@ that is invoked when the HTTP transaction completes. \fB::http::geturl\fR takes several options: .RS .TP +\fB\-binary\fP \fIboolean\fP +Specifies whether to force interpreting the url data as binary. Normally +this is auto-detected (anything not beginning with a \fBtext\fR content +type or whose content encoding is \fBgzip\fR or \fBcompress\fR is +considered binary data). +.TP \fB\-blocksize\fP \fIsize\fP The blocksize used when reading the URL. -At most -\fIsize\fR -bytes are read at once. After each block, a call to the -\fB\-progress\fR -callback is made (if that option is specified). +At most \fIsize\fR bytes are read at once. After each block, a call to the +\fB\-progress\fR callback is made (if that option is specified). .TP \fB\-channel\fP \fIname\fP Copy the URL contents to channel \fIname\fR instead of saving it in @@ -349,7 +352,7 @@ HTTP reply headers or data, no exception is thrown. This is because after writing the HTTP headers, \fB::http::geturl\fP returns, and the rest of the HTTP transaction occurs in the background. The command callback can check if any error occurred during the read by calling -\fB::http::status\fP to check the status and if it's \fIerror\fP, +\fB::http::status\fP to check the status and if its \fIerror\fP, calling \fB::http::error\fP to get the error message. .PP Alternatively, if the main program flow reaches a point where it needs @@ -407,6 +410,15 @@ the array are supported: The contents of the URL. This will be empty if the \fB\-channel\fR option has been specified. This value is returned by the \fB::http::data\fP command. .TP +\fBcharset\fR +The value of the charset attribute from the \fBContent-Type\fR meta-data +value. If none was specified, this defaults to the RFC standard +\fBiso8859-1\fR, or the value of \fB$::http::defaultCharset\fR. Incoming +text data will be automatically converted from this charset to utf-8. +.TP +\fBcoding\fR +A copy of the \fBContent-Encoding\fR meta-data value. +.TP \fBcurrentsize\fR The current number of bytes fetched from the URL. This value is returned by the \fB::http::size\fP command. @@ -505,12 +517,10 @@ proc ::http::copy { url file {chunk 4096} } { proc ::http::Progress {args} { puts -nonewline stderr . ; flush stderr } - .DE + .SH "SEE ALSO" safe(n), socket(n), safesock(n) + .SH KEYWORDS security policy, socket - - - |