From ba2f0b8c6ba7fb3a26fa6d9676ee1aefe6d873cc Mon Sep 17 00:00:00 2001
From: Diego Nehab
Date: Wed, 16 Jun 2004 20:41:03 +0000
Subject: Fine tuning the manual...
---
doc/http.html | 28 ++++++++++++++++------------
1 file changed, 16 insertions(+), 12 deletions(-)
(limited to 'doc/http.html')
diff --git a/doc/http.html b/doc/http.html
index 0fc04cd..a621ec7 100644
--- a/doc/http.html
+++ b/doc/http.html
@@ -50,11 +50,13 @@ implementation conforms to the HTTP/1.1 standard,
The module exports functions that provide HTTP functionality in different
levels of abstraction, from the simple
get function, through the generic
-LTN12 based request function, down to
+LTN12 based
+request function, down to
even lower-level if you bother to look through the source code.
- To obtain the ftp namespace, run:
+
+To obtain the http namespace, run:
@@ -85,12 +87,8 @@ MIME headers are represented as a Lua table in the form:
headers = {
field-1-name = field-1-value,
field-2-name = field-2-value,
- field-3-name = field-3-value,
-
-|
- ...
- |
-
+ field-3-name = field-3-value,
+ ...
field-n-name = field-n-value
}
|
@@ -188,7 +186,7 @@ Note: This function is also trivially implemented with the use of the
http.request{
url = string,
- [sink = LTN12 sink],]
+ [sink = LTN12 sink,]
[method = string,]
[headers = header-table,]
[source = LTN12 source],
@@ -203,7 +201,9 @@ Performs the generic HTTP request, controlled by a request table.
-The most important parameters are the url and the simple LTN12 sink that will receive the downloaded content.
+The most important parameters are the url and the simple
+LTN12
+sink that will receive the downloaded content.
Any part of the url can be overridden by including
the appropriate field in the request table.
If authentication information is provided, the function
@@ -215,11 +215,15 @@ following:
- method: The HTTP request method. Defaults to "GET";
- headers: Any additional HTTP headers to send with the request;
-
- source: simple LTN12 source to provide the request body. If there
+
- source: simple
+LTN12
+source to provide the request body. If there
is a body, you need to provide an appropriate "content-length"
request header field, or the function will attempt to send the body as
"chunked" (something few servers support). Defaults to the empty source;
-
- step: LTN12 pump step function used to move data.
+
- step:
+LTN12
+pump step function used to move data.
Defaults to the LTN12 pump.step function.
- proxy: The URL of a proxy server to use. Defaults to no proxy;
- redirect: Set to false to prevent the
--
cgit v1.2.3-55-g6feb