From 8e80e38f2c3121242b3b2f7a45a960c9af4d1a68 Mon Sep 17 00:00:00 2001
From: Diego Nehab
Date: Wed, 16 Jun 2004 01:02:14 +0000
Subject: [PATCH] Manual almost there.
---
doc/ftp.html | 4 ++--
doc/http.html | 5 ++---
doc/index.html | 20 ++++++++++++--------
doc/smtp.html | 12 ++++++------
doc/socket.html | 3 +--
5 files changed, 23 insertions(+), 21 deletions(-)
diff --git a/doc/ftp.html b/doc/ftp.html
index a0c9268..e834f07 100644
--- a/doc/ftp.html
+++ b/doc/ftp.html
@@ -107,7 +107,7 @@ If the argument of the get function is a table, the function
expects at least the fields host, sink, and one of
argument or path (argument takes
precedence). Host is the server to connect to. Sink is
-the LTN12 sink that will receive the downloaded data. Argument or
+the simple LTN12 sink that will receive the downloaded data. Argument or
path give the target path to the resource in the server. The
optional arguments are the following:
@@ -184,7 +184,7 @@ If the argument of the put function is a table, the function
expects at least the fields host, source, and one of
argument or path (argument takes
precedence). Host is the server to connect to. Source is
-the LTN12 source that will provide the contents to be uploaded.
+the simple LTN12 source that will provide the contents to be uploaded.
Argument or
path give the target path to the resource in the server. The
optional arguments are the following:
diff --git a/doc/http.html b/doc/http.html
index 39eb2e4..bda3088 100644
--- a/doc/http.html
+++ b/doc/http.html
@@ -193,8 +193,7 @@ Performs the generic HTTP request, controled by a request table.
-The most important parameters are the url and the 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 overriden by including
the appropriate field in the request table.
If authentication information is provided, the function
@@ -206,7 +205,7 @@ following:
- method: The HTTP request method. Defaults to "GET";
- headers: Any additional HTTP headers to send with the request;
-
- source: 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;
diff --git a/doc/index.html b/doc/index.html
index c4c1e2f..7a3afa8 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -187,18 +187,18 @@ the changes that made it into version 2.0:
-Lots of changes in the Lua modules, too. The new MIME and LTN12 modules
-make all other modules much more powerful. The main new functionality is
-the support for multipart messages in the SMTP module.
+Lots of changes in the Lua modules, too!
-
--
-
+
- New MIME and LTN12 modules make all other modules much more powerful;
+
- Support for multipart messages in the SMTP module;
+
- The old callback mechanism of FTP and HTTP has been replaced with LTN12 sources and sinks,
+with advantage;
+
- FTP, HTTP, and SMTP are implemented in multiple levels in such a way
+that users will have no problems extending the functionality.
-
Incompatibilities with previous versions
@@ -217,7 +217,11 @@ agree the new stuff is better;
sendto, setpeername and setsockname,
return convention WILL break old code;
- Interface to options has changed;
+ To enable local binding before connect, the bind method
+ does not call listen anymore. It is the new listen
+method that turns a TCP object into a server object;
+
+ Interface to options has changed.
diff --git a/doc/smtp.html b/doc/smtp.html
index b0ae634..03698bf 100644
--- a/doc/smtp.html
+++ b/doc/smtp.html
@@ -125,7 +125,7 @@ The sender is given by the e-mail address in the from field.
Rcpt is a Lua table with one entry for each recipient e-mail
address, or a string
in case there is just one recipient.
-The contents of the message are given by a LTN12 source. Several
+The contents of the message are given by a simple LTN12 source. Several
arguments are optional:
- server: Server to connect to. Defaults to "localhost";
@@ -292,10 +292,10 @@ and an epilogue.
-The function returns an LTN12 source that produces the message contents as
-defined by mesgt. Hopefuly, the following example will make
-things clear. When in doubt, refer to the appropriate RFC as listed in the
-introduction.
+The function returns a simple LTN12 source that produces the
+message contents as defined by mesgt. Hopefuly, the following
+example will make things clear. When in doubt, refer to the appropriate RFC
+as listed in the introduction.
-- load the smtp support and its friends
@@ -314,7 +314,7 @@ source = smtp.message{
},
body = {
preamble = "If your client doesn't understand attachments, \r\n" ..
- "it will still display the preamble and the epilogue.\r\n",
+ "it will still display the preamble and the epilogue.\r\n" ..
"Preamble might show up even in a MIME enabled client.",
-- first part: no headers means plain text, us-ascii.
-- The mime.eol low-level filter normalizes end-of-line markers.
diff --git a/doc/socket.html b/doc/socket.html
index eccc676..dbfdaed 100644
--- a/doc/socket.html
+++ b/doc/socket.html
@@ -106,8 +106,7 @@ writable even though the socket is not ready for sending.
-Another important note: calling select with a server socket in the receive
-parameter before a call to accept does not guarantee
+Another important note: calling select with a server socket in the receive parameter before a call to accept does not guarantee
accept will return immediately.
Use the settimeout
method or accept might block forever.