aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDiego Nehab <diego@tecgraf.puc-rio.br>2004-06-16 01:02:14 +0000
committerDiego Nehab <diego@tecgraf.puc-rio.br>2004-06-16 01:02:14 +0000
commit8e80e38f2c3121242b3b2f7a45a960c9af4d1a68 (patch)
tree4c643fe319f364a87767a287bfcecb402a524d5e
parentd46f7a09a768b146f2f3cdc9a6a50357832bd1c7 (diff)
downloadluasocket-8e80e38f2c3121242b3b2f7a45a960c9af4d1a68.tar.gz
luasocket-8e80e38f2c3121242b3b2f7a45a960c9af4d1a68.tar.bz2
luasocket-8e80e38f2c3121242b3b2f7a45a960c9af4d1a68.zip
Manual almost there.
-rw-r--r--doc/ftp.html4
-rw-r--r--doc/http.html5
-rw-r--r--doc/index.html20
-rw-r--r--doc/smtp.html12
-rw-r--r--doc/socket.html3
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 <tt>get</tt> function is a table, the function
107expects at least the fields <tt>host</tt>, <tt>sink</tt>, and one of 107expects at least the fields <tt>host</tt>, <tt>sink</tt>, and one of
108<tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes 108<tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes
109precedence). <tt>Host</tt> is the server to connect to. <tt>Sink</tt> is 109precedence). <tt>Host</tt> is the server to connect to. <tt>Sink</tt> is
110the LTN12 sink that will receive the downloaded data. <tt>Argument</tt> or 110the <em>simple</em> LTN12 sink that will receive the downloaded data. <tt>Argument</tt> or
111<tt>path</tt> give the target path to the resource in the server. The 111<tt>path</tt> give the target path to the resource in the server. The
112optional arguments are the following: 112optional arguments are the following:
113</p> 113</p>
@@ -184,7 +184,7 @@ If the argument of the <tt>put</tt> function is a table, the function
184expects at least the fields <tt>host</tt>, <tt>source</tt>, and one of 184expects at least the fields <tt>host</tt>, <tt>source</tt>, and one of
185<tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes 185<tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes
186precedence). <tt>Host</tt> is the server to connect to. <tt>Source</tt> is 186precedence). <tt>Host</tt> is the server to connect to. <tt>Source</tt> is
187the LTN12 source that will provide the contents to be uploaded. 187the <em>simple</em> LTN12 source that will provide the contents to be uploaded.
188<tt>Argument</tt> or 188<tt>Argument</tt> or
189<tt>path</tt> give the target path to the resource in the server. The 189<tt>path</tt> give the target path to the resource in the server. The
190optional arguments are the following: 190optional 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.
193</p> 193</p>
194 194
195<p class=parameters> 195<p class=parameters>
196The most important parameters are the <tt>url</tt> and the LTN12 196The most important parameters are the <tt>url</tt> and the <em>simple</em> LTN12 <tt>sink</tt> that will receive the downloaded content.
197<tt>sink</tt> that will receive the downloaded content.
198Any part of the <tt>url</tt> can be overriden by including 197Any part of the <tt>url</tt> can be overriden by including
199the appropriate field in the request table. 198the appropriate field in the request table.
200If authentication information is provided, the function 199If authentication information is provided, the function
@@ -206,7 +205,7 @@ following:
206<ul> 205<ul>
207<li><tt>method</tt>: The HTTP request method. Defaults to "GET"; 206<li><tt>method</tt>: The HTTP request method. Defaults to "GET";
208<li><tt>headers</tt>: Any additional HTTP headers to send with the request; 207<li><tt>headers</tt>: Any additional HTTP headers to send with the request;
209<li><tt>source</tt>: LTN12 source to provide the request body. If there 208<li><tt>source</tt>: <em>simple</em> LTN12 source to provide the request body. If there
210is a body, you need to provide an appropriate "<tt>content-length</tt>" 209is a body, you need to provide an appropriate "<tt>content-length</tt>"
211request header field, or the function will attempt to send the body as 210request header field, or the function will attempt to send the body as
212"<tt>chunked</tt>" (something few servers support). Defaults to the empty source; 211"<tt>chunked</tt>" (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:
187</ul> 187</ul>
188 188
189<p> 189<p>
190Lots of changes in the Lua modules, too. The new MIME and LTN12 modules 190Lots of changes in the Lua modules, too!
191make all other modules much more powerful. The main new functionality is
192the support for multipart messages in the SMTP module.
193</p> 191</p>
194 192
195<ul> 193<ul>
196 194<li> New MIME and LTN12 modules make all other modules much more powerful;
197<li> 195<li> Support for multipart messages in the SMTP module;
198 196<li> The old callback mechanism of FTP and HTTP has been replaced with LTN12 sources and sinks,
197with advantage;
198<li> FTP, HTTP, and SMTP are implemented in multiple levels in such a way
199that users will have no problems extending the functionality.
199</ul> 200</ul>
200 201
201
202<!-- incompatible +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 202<!-- incompatible +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
203 203
204<h3 id=incompatible>Incompatibilities with previous versions</h3> 204<h3 id=incompatible>Incompatibilities with previous versions</h3>
@@ -217,7 +217,11 @@ agree the new stuff is better;
217<tt>sendto</tt>, <tt>setpeername</tt> and <tt>setsockname</tt>, 217<tt>sendto</tt>, <tt>setpeername</tt> and <tt>setsockname</tt>,
218return convention WILL break old code; 218return convention WILL break old code;
219 219
220<li> Interface to options has changed; 220<li> To enable local binding before connect, the <tt>bind</tt> method
221 does not call <tt>listen</tt> anymore. It is the new <tt>listen</tt>
222method that turns a TCP object into a server object;
223
224<li> Interface to options has changed.
221 225
222</ul> 226</ul>
223 227
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 <tt>from</tt> field.
125<tt>Rcpt</tt> is a Lua table with one entry for each recipient e-mail 125<tt>Rcpt</tt> is a Lua table with one entry for each recipient e-mail
126address, or a string 126address, or a string
127in case there is just one recipient. 127in case there is just one recipient.
128The contents of the message are given by a LTN12 <tt>source</tt>. Several 128The contents of the message are given by a <em>simple</em> LTN12 <tt>source</tt>. Several
129arguments are optional: 129arguments are optional:
130<ul> 130<ul>
131<li> <tt>server</tt>: Server to connect to. Defaults to "localhost"; 131<li> <tt>server</tt>: Server to connect to. Defaults to "localhost";
@@ -292,10 +292,10 @@ and an epilogue.
292</p> 292</p>
293 293
294<p class=return> 294<p class=return>
295The function returns an LTN12 source that produces the message contents as 295The function returns a <em>simple</em> LTN12 source that produces the
296defined by <tt>mesgt</tt>. Hopefuly, the following example will make 296message contents as defined by <tt>mesgt</tt>. Hopefuly, the following
297things clear. When in doubt, refer to the appropriate RFC as listed in the 297example will make things clear. When in doubt, refer to the appropriate RFC
298introduction. </p> 298as listed in the introduction. </p>
299 299
300<pre class=example> 300<pre class=example>
301-- load the smtp support and its friends 301-- load the smtp support and its friends
@@ -314,7 +314,7 @@ source = smtp.message{
314 }, 314 },
315 body = { 315 body = {
316 preamble = "If your client doesn't understand attachments, \r\n" .. 316 preamble = "If your client doesn't understand attachments, \r\n" ..
317 "it will still display the preamble and the epilogue.\r\n", 317 "it will still display the preamble and the epilogue.\r\n" ..
318 "Preamble might show up even in a MIME enabled client.", 318 "Preamble might show up even in a MIME enabled client.",
319 -- first part: no headers means plain text, us-ascii. 319 -- first part: no headers means plain text, us-ascii.
320 -- The mime.eol low-level filter normalizes end-of-line markers. 320 -- 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 <em>not</em> ready for sending.
106</p> 106</p>
107 107
108<p class=note> 108<p class=note>
109<b>Another important note</b>: calling select with a server socket in the receive 109<b>Another important note</b>: calling select with a server socket in the receive parameter before a call to accept does <em>not</em> guarantee
110parameter before a call to accept does <em>not</em> guarantee
111<a href=tcp.html#accept><tt>accept</tt></a> will return immediately. 110<a href=tcp.html#accept><tt>accept</tt></a> will return immediately.
112Use the <a href=tcp.html#settimeout><tt>settimeout</tt></a> 111Use the <a href=tcp.html#settimeout><tt>settimeout</tt></a>
113method or <tt>accept</tt> might block forever. 112method or <tt>accept</tt> might block forever.