summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorhobbs <hobbs>2008-03-12 09:51:36 (GMT)
committerhobbs <hobbs>2008-03-12 09:51:36 (GMT)
commitabb6e593c4fe93a99241275011aaa97b6a259485 (patch)
tree9606360702be5fc0ff9a22d6e04f523cda0a5a65 /doc
parent2a8fbfca012f397ebc7a5978ce851691cc48ba7b (diff)
downloadtcl-abb6e593c4fe93a99241275011aaa97b6a259485.zip
tcl-abb6e593c4fe93a99241275011aaa97b6a259485.tar.gz
tcl-abb6e593c4fe93a99241275011aaa97b6a259485.tar.bz2
* unix/Makefile.in (install-libraries): Bump http to 2.7
* win/Makefile.in (install-libraries): Added -myaddr option to allow * library/http/http.tcl (http::geturl): control of selected socket * library/http/pkgIndex.tcl: interface. [Bug 559898] * doc/http.n, tests/http.test: Added -keepalive and -protocol 1.1 with chunked transfer encoding support. [Bug 1063703, 1470377, 219225] Added ability to override Host in -headers. [Bug 928154] Added -strict option to control URL validation on per-call basis. [Bug 1560506]
Diffstat (limited to 'doc')
-rw-r--r--doc/http.n34
1 files changed, 25 insertions, 9 deletions
diff --git a/doc/http.n b/doc/http.n
index 69538f4..8c4434e 100644
--- a/doc/http.n
+++ b/doc/http.n
@@ -6,16 +6,16 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: http.n,v 1.34 2008/03/12 05:57:44 hobbs Exp $
+'\" RCS: @(#) $Id: http.n,v 1.35 2008/03/12 09:51:39 hobbs Exp $
'\"
.so man.macros
-.TH "http" n 2.5.5 http "Tcl Bundled Packages"
+.TH "http" n 2.7 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.1 protocol
.SH SYNOPSIS
-\fBpackage require http ?2.5.5?\fR
+\fBpackage require http ?2.7?\fR
.\" See Also -useragent option documentation in body!
.sp
\fB::http::config \fI?options?\fR
@@ -50,9 +50,9 @@ http \- Client-side implementation of the HTTP/1.0 protocol
.BE
.SH DESCRIPTION
.PP
-The \fBhttp\fR package provides the client side of the HTTP/1.0
+The \fBhttp\fR package provides the client side of the HTTP/1.1
protocol. The package implements the GET, POST, and HEAD operations
-of HTTP/1.0. It allows configuration of a proxy host to get through
+of HTTP/1.1. 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 extended to support
@@ -123,7 +123,7 @@ characters.
.TP
\fB\-useragent\fR \fIstring\fR
The value of the User-Agent header in the HTTP request. The default is
-.QW "\fBTcl http client package 2.5\fR" .
+.QW "\fBTcl http client package 2.7\fR" .
.RE
.TP
\fB::http::geturl\fR \fIurl\fR ?\fIoptions\fR?
@@ -206,11 +206,19 @@ HTTP request:
Pragma: no-cache
.CE
.TP
+\fB\-keepalive\fR \fIboolean\fR
+If true (the default), attempt to keep the connection open for servicing
+multiple requests.
+.TP
\fB\-method\fR \fItype\fR
Force the HTTP request method to \fItype\fR. \fB::http::geturl\fR will
-auto-select GET, POST or HEAD based on other optiosn, but this option
+auto-select GET, POST or HEAD based on other options, but this option
enables choices like PUT and DELETE for webdav support.
.TP
+\fB\-myaddr\fR \fIaddress\fR
+Pass an specific local address to the underlying \fBsocket\fR call in case
+multiple interfaces are available.
+.TP
\fB\-progress\fR \fIcallback\fR
The \fIcallback\fR is made after each transfer of data from the URL.
The callback gets three additional arguments: the \fItoken\fR from
@@ -227,6 +235,11 @@ proc httpProgress {token total current} {
.CE
.RE
.TP
+\fB\-protocol\fR \fIversion\fR
+Select the HTTP protocol version to use. This should be 1.0 or 1.1 (the
+default). Should only be necessary for servers that do not understand or
+otherwise complain about HTTP/1.1.
+.TP
\fB\-query\fR \fIquery\fR
This flag causes \fB::http::geturl\fR to do a POST request that passes the
\fIquery\fR to the server. The \fIquery\fR must be an x-url-encoding
@@ -256,6 +269,9 @@ The \fIcallback\fR is made after each transfer of data to the URL
(i.e. POST) and acts exactly like the \fB\-progress\fR option (the
callback format is the same).
.TP
+\fB\-strict\fR \fIboolean\fR
+Whether to enforce RFC 3986 URL validation on the request. Default is 1.
+.TP
\fB\-timeout\fR \fImilliseconds\fR
If \fImilliseconds\fR is non-zero, then \fB::http::geturl\fR sets up a timeout
to occur after the specified number of milliseconds.
@@ -458,7 +474,7 @@ The HTTP status reply from the server. This value
is returned by the \fB::http::code\fR command. The format of this value is:
.RS
.CS
-\fIHTTP/1.0 code string\fR
+\fIHTTP/1.1 code string\fR
.CE
The \fIcode\fR is a three-digit number defined in the HTTP standard.
A code of 200 is OK. Codes beginning with 4 or 5 indicate errors.