diff options
author | Diego Nehab <diego.nehab@gmail.com> | 2012-04-23 00:18:45 +0800 |
---|---|---|
committer | Diego Nehab <diego.nehab@gmail.com> | 2012-04-23 00:18:45 +0800 |
commit | f960b3872a668ed1b53bd50c5b6a708367332f3c (patch) | |
tree | e82a1b113ed40d70afae36d230b6a6048e1d9fab /doc | |
parent | f37e0260261f7691246429d227cf7124c291e8b1 (diff) | |
download | luasocket-f960b3872a668ed1b53bd50c5b6a708367332f3c.tar.gz luasocket-f960b3872a668ed1b53bd50c5b6a708367332f3c.tar.bz2 luasocket-f960b3872a668ed1b53bd50c5b6a708367332f3c.zip |
Making progress toward a release
Documented headers.lua
Update copyright date everywhere
Remove RCSID from files
Move version back to 2.1 rather than 2.1.1
Fixed url package to support ipv6 hosts
Changed "domain" to "family" in tcp and udp structures
Implemented getfamily methods
Diffstat (limited to 'doc')
-rw-r--r-- | doc/http.html | 6 | ||||
-rw-r--r-- | doc/index.html | 5 | ||||
-rw-r--r-- | doc/installation.html | 4 | ||||
-rw-r--r-- | doc/reference.html | 1 | ||||
-rw-r--r-- | doc/smtp.html | 5 | ||||
-rw-r--r-- | doc/socket.html | 23 |
6 files changed, 36 insertions, 8 deletions
diff --git a/doc/http.html b/doc/http.html index 9f3f087..cd41c0d 100644 --- a/doc/http.html +++ b/doc/http.html | |||
@@ -95,8 +95,9 @@ headers = {<br> | |||
95 | </blockquote> | 95 | </blockquote> |
96 | 96 | ||
97 | <p> | 97 | <p> |
98 | Field names are case insensitive (as specified by the standard) and all | 98 | Field names are case insensitive (as specified by the standard) and all |
99 | functions work with lowercase field names. | 99 | functions work with lowercase field names (but see |
100 | <a href=socket.html#headers.canonic><tt>socket.headers.canonic</tt></a>). | ||
100 | Field values are left unmodified. | 101 | Field values are left unmodified. |
101 | </p> | 102 | </p> |
102 | 103 | ||
@@ -117,6 +118,7 @@ the HTTP module: | |||
117 | <li> <tt>USERAGENT</tt>: default user agent reported to server. | 118 | <li> <tt>USERAGENT</tt>: default user agent reported to server. |
118 | </ul> | 119 | </ul> |
119 | 120 | ||
121 | |||
120 | <!-- http.request ++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 122 | <!-- http.request ++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
121 | 123 | ||
122 | <p class=name id="request"> | 124 | <p class=name id="request"> |
diff --git a/doc/index.html b/doc/index.html index 9da0f3c..833c9a8 100644 --- a/doc/index.html +++ b/doc/index.html | |||
@@ -87,7 +87,7 @@ Author: <A href="http://www.impa.br/~diego">Diego Nehab</a> | |||
87 | <h2 id=download>Download</h2> | 87 | <h2 id=download>Download</h2> |
88 | 88 | ||
89 | <p> | 89 | <p> |
90 | LuaSocket version 2.1.1-rc1 is now available for download! | 90 | LuaSocket version 2.1-rc1 is now available for download! |
91 | It is compatible with Lua 5.1 and 5.2, and has | 91 | It is compatible with Lua 5.1 and 5.2, and has |
92 | been tested on Windows XP, Linux, and Mac OS X. Chances | 92 | been tested on Windows XP, Linux, and Mac OS X. Chances |
93 | are it works well on most UNIX distributions and Windows flavors. | 93 | are it works well on most UNIX distributions and Windows flavors. |
@@ -125,7 +125,7 @@ has helped bring this library back to life. | |||
125 | <h2 id=new>What's New</h2> | 125 | <h2 id=new>What's New</h2> |
126 | 126 | ||
127 | <p> | 127 | <p> |
128 | Main changes for LuaSocket 2.1.1-rc1 are IPv6 support | 128 | Main changes for LuaSocket 2.1-rc1 are IPv6 support |
129 | and Lua 5.2 compatibility. | 129 | and Lua 5.2 compatibility. |
130 | </p> | 130 | </p> |
131 | 131 | ||
@@ -135,6 +135,7 @@ and Lua 5.2 compatibility. | |||
135 | <ul> | 135 | <ul> |
136 | <li> <tt>Socket.connect</tt> and <tt>socket.bind</tt> support IPv6 addresses; | 136 | <li> <tt>Socket.connect</tt> and <tt>socket.bind</tt> support IPv6 addresses; |
137 | <li> <tt>Getpeername</tt> and <tt>getsockname</tt> support IPv6 addresses; | 137 | <li> <tt>Getpeername</tt> and <tt>getsockname</tt> support IPv6 addresses; |
138 | <li> URL module updated to support IPv6 host names; | ||
138 | <li> New <tt>socket.tcp6</tt> and <tt>socket.udp6</tt> functions; | 139 | <li> New <tt>socket.tcp6</tt> and <tt>socket.udp6</tt> functions; |
139 | <li> New <tt>socket.dns.getaddrinfo</tt> function; | 140 | <li> New <tt>socket.dns.getaddrinfo</tt> function; |
140 | </ul> | 141 | </ul> |
diff --git a/doc/installation.html b/doc/installation.html index 00b2db0..37c309b 100644 --- a/doc/installation.html +++ b/doc/installation.html | |||
@@ -39,7 +39,7 @@ Installation"> | |||
39 | 39 | ||
40 | <h2>Installation</h2> | 40 | <h2>Installation</h2> |
41 | 41 | ||
42 | <p> LuaSocket 2.1.1-rc still uses Lua 5.1's package | 42 | <p> LuaSocket 2.1-rc still uses Lua 5.1's package |
43 | system. Users that have already made the switch to | 43 | system. Users that have already made the switch to |
44 | Lua 5.2 should leave the default | 44 | Lua 5.2 should leave the default |
45 | <tt>LUA_COMPAT_MODULE</tt> defined when compiling their Lua | 45 | <tt>LUA_COMPAT_MODULE</tt> defined when compiling their Lua |
@@ -95,7 +95,7 @@ it should be easy to use LuaSocket. Just fire the interpreter and use the | |||
95 | Lua 5.1.5 Copyright (C) 1994-2012 Lua.org, PUC-Rio | 95 | Lua 5.1.5 Copyright (C) 1994-2012 Lua.org, PUC-Rio |
96 | > socket = require("socket") | 96 | > socket = require("socket") |
97 | > print(socket._VERSION) | 97 | > print(socket._VERSION) |
98 | --> LuaSocket 2.1.1-rc1 | 98 | --> LuaSocket 2.1-rc1 |
99 | </pre> | 99 | </pre> |
100 | 100 | ||
101 | <p> Each module loads their dependencies automatically, so you only need to | 101 | <p> Each module loads their dependencies automatically, so you only need to |
diff --git a/doc/reference.html b/doc/reference.html index d1043d4..f069d47 100644 --- a/doc/reference.html +++ b/doc/reference.html | |||
@@ -148,6 +148,7 @@ Support, Manual"> | |||
148 | <a href="socket.html#debug">_DEBUG</a>, | 148 | <a href="socket.html#debug">_DEBUG</a>, |
149 | <a href="dns.html#dns">dns</a>, | 149 | <a href="dns.html#dns">dns</a>, |
150 | <a href="socket.html#gettime">gettime</a>, | 150 | <a href="socket.html#gettime">gettime</a>, |
151 | <a href="socket.html#headers.canonic">headers.canonic</a>, | ||
151 | <a href="socket.html#newtry">newtry</a>, | 152 | <a href="socket.html#newtry">newtry</a>, |
152 | <a href="socket.html#protect">protect</a>, | 153 | <a href="socket.html#protect">protect</a>, |
153 | <a href="socket.html#select">select</a>, | 154 | <a href="socket.html#select">select</a>, |
diff --git a/doc/smtp.html b/doc/smtp.html index 2ef673a..bbbff80 100644 --- a/doc/smtp.html +++ b/doc/smtp.html | |||
@@ -90,8 +90,9 @@ headers = {<br> | |||
90 | </blockquote> | 90 | </blockquote> |
91 | 91 | ||
92 | <p> | 92 | <p> |
93 | Field names are case insensitive (as specified by the standard) and all | 93 | Field names are case insensitive (as specified by the standard) and all |
94 | functions work with lowercase field names. | 94 | functions work with lowercase field names (but see |
95 | <a href=socket.html#headers.canonic><tt>socket.headers.canonic</tt></a>). | ||
95 | Field values are left unmodified. | 96 | Field values are left unmodified. |
96 | </p> | 97 | </p> |
97 | 98 | ||
diff --git a/doc/socket.html b/doc/socket.html index 2267b4a..dcf8b61 100644 --- a/doc/socket.html +++ b/doc/socket.html | |||
@@ -112,6 +112,29 @@ t = socket.gettime() | |||
112 | print(socket.gettime() - t .. " seconds elapsed") | 112 | print(socket.gettime() - t .. " seconds elapsed") |
113 | </pre> | 113 | </pre> |
114 | 114 | ||
115 | <!-- socket.headers ++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
116 | |||
117 | <p class=name id="headers.canonic"> | ||
118 | socket.headers.<b>canonic</b></p> | ||
119 | |||
120 | <p> The <tt>socket.headers.canonic</tt> table | ||
121 | is used by the HTTP and SMTP modules to translate from | ||
122 | lowercase field names back into their canonic | ||
123 | capitalization. When a lowercase field name exists as a key | ||
124 | in this table, the associated value is substituted in | ||
125 | whenever the field name is sent out. | ||
126 | </p> | ||
127 | |||
128 | <p> | ||
129 | You can obtain the <tt>headers</tt> namespace if case run-time | ||
130 | modifications are required by running: | ||
131 | </p> | ||
132 | |||
133 | <pre class=example> | ||
134 | -- loads the headers module | ||
135 | local headers = require("headers") | ||
136 | </pre> | ||
137 | |||
115 | <!-- newtry +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 138 | <!-- newtry +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
116 | 139 | ||
117 | <p class=name id=newtry> | 140 | <p class=name id=newtry> |