aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDiego Nehab <diego@tecgraf.puc-rio.br>2011-05-25 20:57:22 +0000
committerDiego Nehab <diego@tecgraf.puc-rio.br>2011-05-25 20:57:22 +0000
commit3a8ba90dfb0c2eb224f317dd692ede426691e72a (patch)
treefe1cc5379a2e0e031663fe9c15d908653844bc73 /doc
parentbce60be30fe8e9c1b0eb33128c23c93d7bca5303 (diff)
downloadluasocket-3a8ba90dfb0c2eb224f317dd692ede426691e72a.tar.gz
luasocket-3a8ba90dfb0c2eb224f317dd692ede426691e72a.tar.bz2
luasocket-3a8ba90dfb0c2eb224f317dd692ede426691e72a.zip
Saving before big changes to support IPv6.
Diffstat (limited to 'doc')
-rw-r--r--doc/ftp.html6
-rw-r--r--doc/http.html13
-rw-r--r--doc/index.html16
-rw-r--r--doc/mime.html10
-rw-r--r--doc/smtp.html13
-rw-r--r--doc/url.html5
6 files changed, 31 insertions, 32 deletions
diff --git a/doc/ftp.html b/doc/ftp.html
index 1f6335e..3f23a4a 100644
--- a/doc/ftp.html
+++ b/doc/ftp.html
@@ -42,7 +42,7 @@
42FTP (File Transfer Protocol) is a protocol used to transfer files 42FTP (File Transfer Protocol) is a protocol used to transfer files
43between hosts. The <tt>ftp</tt> namespace offers thorough support 43between hosts. The <tt>ftp</tt> namespace offers thorough support
44to FTP, under a simple interface. The implementation conforms to 44to FTP, under a simple interface. The implementation conforms to
45<a href="http://www.cs.princeton.edu/~diego/rfc/rfc0959.txt">RFC 959</a>. 45<a href="http://www.ietf.org/rfc/rfc959.txt">RFC 959</a>.
46</p> 46</p>
47 47
48<p> 48<p>
@@ -70,8 +70,8 @@ local ftp = require("socket.ftp")
70 70
71<p> 71<p>
72URLs MUST conform to 72URLs MUST conform to
73<a href="http://www.cs.princeton.edu/~diego/rfc/rfc1738.txt">RFC 73<a href="http://www.ietf.org/rfc/rfc1738.txt">RFC 1738</a>,
741738</a>, that is, an URL is a string in the form: 74that is, an URL is a string in the form:
75</p> 75</p>
76 76
77<blockquote> 77<blockquote>
diff --git a/doc/http.html b/doc/http.html
index a274aef..66282a4 100644
--- a/doc/http.html
+++ b/doc/http.html
@@ -45,8 +45,7 @@ namespace offers full support for the client side of the HTTP
45protocol (i.e., 45protocol (i.e.,
46the facilities that would be used by a web-browser implementation). The 46the facilities that would be used by a web-browser implementation). The
47implementation conforms to the HTTP/1.1 standard, 47implementation conforms to the HTTP/1.1 standard,
48<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2616.txt">RFC 48<a href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a>.
492616</a>.
50</p> 49</p>
51 50
52<p> 51<p>
@@ -67,8 +66,7 @@ local http = require("socket.http")
67 66
68<p> 67<p>
69URLs must conform to 68URLs must conform to
70<a href="http://www.cs.princeton.edu/~diego/rfc/rfc1738.txt">RFC 69<a href="http://www.ietf.org/rfc/rfc1738.txt">RFC 1738</a>,
711738</a>,
72that is, an URL is a string in the form: 70that is, an URL is a string in the form:
73</p> 71</p>
74 72
@@ -199,8 +197,7 @@ it usually returns a message body (a web page informing the
199URL was not found or some other useless page). To make sure the 197URL was not found or some other useless page). To make sure the
200operation was successful, check the returned status <tt>code</tt>. For 198operation was successful, check the returned status <tt>code</tt>. For
201a list of the possible values and their meanings, refer to <a 199a list of the possible values and their meanings, refer to <a
202href="http://www.cs.princeton.edu/~diego/rfc/rfc2616.txt">RFC 200href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a>.
2032616</a>.
204</p> 201</p>
205 202
206<p class=description> 203<p class=description>
@@ -278,7 +275,7 @@ download and return status "401&nbsp;Authentication Required".
278The HTTP/1.1 standard defines two authentication methods: the Basic 275The HTTP/1.1 standard defines two authentication methods: the Basic
279Authentication Scheme and the Digest Authentication Scheme, both 276Authentication Scheme and the Digest Authentication Scheme, both
280explained in detail in 277explained in detail in
281<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2068.txt">RFC 2068</a>. 278<a href="http://www.ietf.org/rfc/rfc2068.txt">RFC 2068</a>.
282</p> 279</p>
283 280
284<p class=note>The Basic Authentication Scheme sends 281<p class=note>The Basic Authentication Scheme sends
@@ -304,7 +301,7 @@ b, c, h = http.request("http://fulano:silva@www.example.com/private/index.html")
304-- the request directly. 301-- the request directly.
305r, c = http.request { 302r, c = http.request {
306 url = "http://www.example.com/private/index.html", 303 url = "http://www.example.com/private/index.html",
307 headers = { authentication = "Basic " .. (mime.b64("fulano:silva")) } 304 headers = { authorization = "Basic " .. (mime.b64("fulano:silva")) }
308} 305}
309</pre> 306</pre>
310 307
diff --git a/doc/index.html b/doc/index.html
index 5b54c59..665b97b 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -138,18 +138,22 @@ all!
138</p> 138</p>
139 139
140<ul> 140<ul>
141<li> Fixed: manual sample of HTTP authentication now uses correct
142 "authorization" header (Alexandre Ittner);
143<li> Fixed: receive() returns immediatelly if prefix can satisfy
144 bytes requested (M Joonas Pihlaja);
141<li> Fixed: multicast didn't work on Windows, or anywhere 145<li> Fixed: multicast didn't work on Windows, or anywhere
142 else for that matter (Herbert Leuwer, Adrian Sietsma) 146 else for that matter (Herbert Leuwer, Adrian Sietsma);
143<li> Fixed: select() now reports an error when called with more 147<li> Fixed: select() now reports an error when called with more
144 sockets than FD_SETSIZE (Lorenzo Leonini) 148 sockets than FD_SETSIZE (Lorenzo Leonini);
145<li> Fixed: manual links to home.html changed to index.html (Robert Hahn) 149<li> Fixed: manual links to home.html changed to index.html (Robert Hahn);
146<li> Fixed: mime.unb64() would return an empty string on results that started 150<li> Fixed: mime.unb64() would return an empty string on results that started
147 with a null character (Robert Raschke) 151 with a null character (Robert Raschke);
148<li> Fixed: HTTP now automatically redirects on 303 and 307 (Jonathan Gray) 152<li> Fixed: HTTP now automatically redirects on 303 and 307 (Jonathan Gray);
149<li> Fixed: calling sleep() with negative numbers could 153<li> Fixed: calling sleep() with negative numbers could
150 block forever, wasting CPU. Now it returns immediately (MPB); 154 block forever, wasting CPU. Now it returns immediately (MPB);
151<li> Improved: FTP commands are now sent in upper case to 155<li> Improved: FTP commands are now sent in upper case to
152 help buggy servers (Anders Eurenius) 156 help buggy servers (Anders Eurenius);
153<li> Improved: known headers now sent in canonic 157<li> Improved: known headers now sent in canonic
154 capitalization to help buggy servers (Joseph Stewart); 158 capitalization to help buggy servers (Joseph Stewart);
155<li> Improved: Clarified tcp:receive() in the manual (MPB); 159<li> Improved: Clarified tcp:receive() in the manual (MPB);
diff --git a/doc/mime.html b/doc/mime.html
index 9844744..ae136fd 100644
--- a/doc/mime.html
+++ b/doc/mime.html
@@ -44,11 +44,11 @@ content transfer encodings, such as Base64 and Quoted-Printable.
44It also provides functions to break text into lines and change 44It also provides functions to break text into lines and change
45the end-of-line convention. 45the end-of-line convention.
46MIME is described mainly in 46MIME is described mainly in
47<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2045.txt">RFC 2045</a>, 47<a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>,
48<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2046.txt">2046</a>, 48<a href="http://www.ietf.org/rfc/rfc2046.txt">2046</a>,
49<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2047.txt">2047</a>, 49<a href="http://www.ietf.org/rfc/rfc2047.txt">2047</a>,
50<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2047.txt">2048</a>, and 50<a href="http://www.ietf.org/rfc/rfc2047.txt">2048</a>, and
51<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2048.txt">2049</a>. 51<a href="http://www.ietf.org/rfc/rfc2048.txt">2049</a>.
52</p> 52</p>
53 53
54<p> 54<p>
diff --git a/doc/smtp.html b/doc/smtp.html
index 980b821..2ef673a 100644
--- a/doc/smtp.html
+++ b/doc/smtp.html
@@ -48,14 +48,13 @@ control (if you bother to read the code).
48</p> 48</p>
49 49
50<p>The implementation conforms to the Simple Mail Transfer Protocol, 50<p>The implementation conforms to the Simple Mail Transfer Protocol,
51<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2821.txt">RFC 2821</a>. 51<a href="http://www.ietf.org/rfc/rfc2821.txt">RFC 2821</a>.
52Another RFC of interest is <a 52Another RFC of interest is <a
53href="http://www.cs.princeton.edu/~diego/rfc/rfc2822.txt">RFC 2822</a>, 53href="http://www.ietf.org/rfc/rfc2822.txt">RFC 2822</a>,
54which governs the Internet Message Format. 54which governs the Internet Message Format.
55Multipart messages (those that contain attachments) are part 55Multipart messages (those that contain attachments) are part
56of the MIME standard, but described mainly 56of the MIME standard, but described mainly
57in <a href="http://www.cs.princeton.edu/~diego/rfc/rfc2046.txt">RFC 57in <a href="http://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>
582046</a>
59 58
60<p> In the description below, good understanding of <a 59<p> In the description below, good understanding of <a
61href="http://lua-users.org/wiki/FiltersSourcesAndSinks"> LTN012, Filters 60href="http://lua-users.org/wiki/FiltersSourcesAndSinks"> LTN012, Filters
@@ -196,7 +195,7 @@ part of the message and will not be sent to anyone.
196</p> 195</p>
197 196
198<p class=note> 197<p class=note>
199<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2822.txt">RFC 2822</a> 198<a href="http://www.ietf.org/rfc/rfc2822.txt">RFC 2822</a>
200has two <em>important and short</em> sections, "3.6.3. Destination address 199has two <em>important and short</em> sections, "3.6.3. Destination address
201fields" and "5. Security considerations", explaining the proper 200fields" and "5. Security considerations", explaining the proper
202use of these headers. Here is a summary of what it says: 201use of these headers. Here is a summary of what it says:
@@ -236,9 +235,9 @@ exactly what you <em>don't</em> want to happen!
236 235
237<p class=note> 236<p class=note>
238I hope this clarifies the issue. Otherwise, please refer to 237I hope this clarifies the issue. Otherwise, please refer to
239<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2821.txt">RFC 2821</a> 238<a href="http://www.ietf.org/rfc/rfc2821.txt">RFC 2821</a>
240and 239and
241<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2822.txt">RFC 2822</a>. 240<a href="http://www.ietf.org/rfc/rfc2822.txt">RFC 2822</a>.
242</p> 241</p>
243 242
244<pre class=example> 243<pre class=example>
diff --git a/doc/url.html b/doc/url.html
index 303e05d..9f234d9 100644
--- a/doc/url.html
+++ b/doc/url.html
@@ -42,8 +42,7 @@
42The <tt>url</tt> namespace provides functions to parse, protect, 42The <tt>url</tt> namespace provides functions to parse, protect,
43and build URLs, as well as functions to compose absolute URLs 43and build URLs, as well as functions to compose absolute URLs
44from base and relative URLs, according to 44from base and relative URLs, according to
45<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2396.txt">RFC 45<a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>.
462396</a>.
47</p> 46</p>
48 47
49<p> 48<p>
@@ -91,7 +90,7 @@ The function returns a string with the absolute URL.
91<p class=note> 90<p class=note>
92Note: The rules that 91Note: The rules that
93govern the composition are fairly complex, and are described in detail in 92govern the composition are fairly complex, and are described in detail in
94<a href="http://www.cs.princeton.edu/~diego/rfc/rfc2396.txt">RFC 2396</a>. 93<a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>.
95The example bellow should give an idea of what the rules are. 94The example bellow should give an idea of what the rules are.
96</p> 95</p>
97 96