aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDiego Nehab <diego@impa.br>2013-06-11 19:10:03 +0800
committerDiego Nehab <diego@impa.br>2013-06-11 19:10:03 +0800
commit6e00ffd62f135c30be3b5a6404a722beb1bdf215 (patch)
treea49bf542aa24ae34e563ff6b0bd5a5e1a139b41f /doc
parent906abf29d146272512feddd74005a8833ee34e7d (diff)
downloadluasocket-6e00ffd62f135c30be3b5a6404a722beb1bdf215.tar.gz
luasocket-6e00ffd62f135c30be3b5a6404a722beb1bdf215.tar.bz2
luasocket-6e00ffd62f135c30be3b5a6404a722beb1bdf215.zip
Changing from 2.1-rc1 to 3.0-rc1.
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html32
-rw-r--r--doc/installation.html14
-rw-r--r--doc/tcp.html2
-rw-r--r--doc/udp.html2
4 files changed, 25 insertions, 25 deletions
diff --git a/doc/index.html b/doc/index.html
index d8ee4a4..b8f8798 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -49,7 +49,7 @@ functionality commonly needed by applications that deal with the Internet.
49The core support has been implemented so that it is both efficient and 49The core support has been implemented so that it is both efficient and
50simple to use. It is available to any Lua application once it has been 50simple to use. It is available to any Lua application once it has been
51properly initialized by the interpreter in use. The code has been tested 51properly initialized by the interpreter in use. The code has been tested
52and runs well on several Windows and Unix platforms. </p> 52and runs well on several Windows and UNIX platforms. </p>
53 53
54<p> 54<p>
55Among the support modules, the most commonly used implement the 55Among the support modules, the most commonly used implement the
@@ -78,7 +78,7 @@ LuaSocket.
78</p> 78</p>
79 79
80<p> 80<p>
81Copyright &copy; 1999-2012 Diego Nehab. All rights reserved. <br> 81Copyright &copy; 1999-2013 Diego Nehab. All rights reserved. <br>
82Author: <A href="http://www.impa.br/~diego">Diego Nehab</a> 82Author: <A href="http://www.impa.br/~diego">Diego Nehab</a>
83</p> 83</p>
84 84
@@ -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>
90LuaSocket version 2.1-rc1 is now available for download! 90LuaSocket version 3.0-rc1 is now available for download!
91It is compatible with Lua&nbsp;5.1 and 5.2, and has 91It is compatible with Lua&nbsp;5.1 and 5.2, and has
92been tested on Windows&nbsp;XP, Linux, and Mac OS X. Chances 92been tested on Windows&nbsp;XP, Linux, and Mac OS X. Chances
93are it works well on most UNIX distributions and Windows flavors. 93are it works well on most UNIX distributions and Windows flavors.
@@ -96,7 +96,7 @@ are it works well on most UNIX distributions and Windows flavors.
96<p> 96<p>
97The library can be downloaded in source code from the 97The library can be downloaded in source code from the
98<a href="https://github.com/diegonehab/luasocket/downloads">LuaSocket 98<a href="https://github.com/diegonehab/luasocket/downloads">LuaSocket
99project page</a> at GitHub. Besides the full C and Lua source code 99project page</a> on GitHub. Besides the full C and Lua source code
100for the library, the distribution contains several examples, 100for the library, the distribution contains several examples,
101this user's manual and basic test procedures. 101this user's manual and basic test procedures.
102</p> 102</p>
@@ -113,11 +113,12 @@ manual to find out how to properly install the library.
113<p> 113<p>
114This marks the first release of LuaSocket that 114This marks the first release of LuaSocket that
115wholeheartedly embraces the open-source development 115wholeheartedly embraces the open-source development
116philosophy. After a long hiatus, Matthew Wild finally 116philosophy. After a long hiatus, Matthew Wild finally
117convinced me it was time for a release including IPv6 117convinced me it was time for a release including IPv6 and
118and Lua 5.2 support. Special thanks to Sam Roberts, Florian 118Lua 5.2 support. It was more work than we anticipated.
119Zeitz, and Paul Aurich, Liam Devine, and everybody else that 119Special thanks to Sam Roberts, Florian Zeitz, and Paul
120has helped bring this library back to life. 120Aurich, Liam Devine, Alexey Melnichuk, and everybody else
121that has helped bring this library back to life.
121</p> 122</p>
122 123
123<!-- whatsnew +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 124<!-- whatsnew +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
@@ -125,12 +126,16 @@ has helped bring this library back to life.
125<h2 id=new>What's New</h2> 126<h2 id=new>What's New</h2>
126 127
127<p> 128<p>
128Main changes for LuaSocket&nbsp;2.1-rc1 are IPv6 support 129Main changes for LuaSocket&nbsp;3.0-rc1 are IPv6 support
129and Lua&nbsp;5.2 compatibility. 130and Lua&nbsp;5.2 compatibility.
130</p> 131</p>
131 132
132<ul> 133<ul>
133<li> Added: Compatible with Lua&nbsp;5.2 (using <tt>LUA_COMPAT_MODULE</tt>); 134<li> Added: Compatible with Lua&nbsp;5.2
135<ul>
136<li> Note that unless you define <tt>LUA_COMPAT_MODULE</tt>,
137package tables will <em>not</em> be exported as globals!
138</ul>
134<li> Added: IPv6 support; 139<li> Added: IPv6 support;
135<ul> 140<ul>
136<li> <tt>Socket.connect</tt> and <tt>socket.bind</tt> support IPv6 addresses; 141<li> <tt>Socket.connect</tt> and <tt>socket.bind</tt> support IPv6 addresses;
@@ -138,7 +143,8 @@ and Lua&nbsp;5.2 compatibility.
138IPv6 addresses, and return the socket family as a third value; 143IPv6 addresses, and return the socket family as a third value;
139<li> URL module updated to support IPv6 host names; 144<li> URL module updated to support IPv6 host names;
140<li> New <tt>socket.tcp6</tt> and <tt>socket.udp6</tt> functions; 145<li> New <tt>socket.tcp6</tt> and <tt>socket.udp6</tt> functions;
141<li> New <tt>socket.dns.getaddrinfo</tt> function; 146<li> New <tt>socket.dns.getaddrinfo</tt> and
147 <tt>socket.dns.getnameinfo</tt> functions;
142</ul> 148</ul>
143<li> Added: <tt>getoption</tt> method; 149<li> Added: <tt>getoption</tt> method;
144<li> Fixed: <tt>url.unescape</tt> was returning additional values; 150<li> Fixed: <tt>url.unescape</tt> was returning additional values;
@@ -176,7 +182,7 @@ still available for those that have compatibility issues.
176<p> 182<p>
177<small> 183<small>
178Last modified by Diego Nehab on <br> 184Last modified by Diego Nehab on <br>
179Mon Apr 16 21:58:56 HKT 2012 185Tue Jun 11 18:50:23 HKT 2013
180</small> 186</small>
181</p> 187</p>
182</center> 188</center>
diff --git a/doc/installation.html b/doc/installation.html
index 37c309b..28a9fbb 100644
--- a/doc/installation.html
+++ b/doc/installation.html
@@ -39,12 +39,6 @@ Installation">
39 39
40<h2>Installation</h2> 40<h2>Installation</h2>
41 41
42<p> LuaSocket 2.1-rc still uses Lua&nbsp;5.1's package
43system. Users that have already made the switch to
44Lua&nbsp;5.2 should leave the default
45<tt>LUA_COMPAT_MODULE</tt> defined when compiling their Lua
46distribution for compatibility with LuaSocket. </p>
47
48<p> Here we describe the standard distribution. If the 42<p> Here we describe the standard distribution. If the
49standard doesn't meet your needs, we refer you to the Lua 43standard doesn't meet your needs, we refer you to the Lua
50discussion list, where any question about the package scheme 44discussion list, where any question about the package scheme
@@ -92,17 +86,17 @@ it should be easy to use LuaSocket. Just fire the interpreter and use the
92<tt>require</tt> function to gain access to whatever module you need:</p> 86<tt>require</tt> function to gain access to whatever module you need:</p>
93 87
94<pre class=example> 88<pre class=example>
95Lua 5.1.5 Copyright (C) 1994-2012 Lua.org, PUC-Rio 89Lua 5.2.2 Copyright (C) 1994-2013 Lua.org, PUC-Rio
96&gt; socket = require("socket") 90&gt; socket = require("socket")
97&gt; print(socket._VERSION) 91&gt; print(socket._VERSION)
98--&gt; LuaSocket 2.1-rc1 92--&gt; LuaSocket 3.0-rc1
99</pre> 93</pre>
100 94
101<p> Each module loads their dependencies automatically, so you only need to 95<p> Each module loads their dependencies automatically, so you only need to
102load the modules you directly depend upon: </p> 96load the modules you directly depend upon: </p>
103 97
104<pre class=example> 98<pre class=example>
105Lua 5.1.5 Copyright (C) 1994-2012 Lua.org, PUC-Rio 99Lua 5.2.2 Copyright (C) 1994-2013 Lua.org, PUC-Rio
106&gt; http = require("socket.http") 100&gt; http = require("socket.http")
107&gt; print(http.request("http://www.impa.br/~diego/software/luasocket")) 101&gt; print(http.request("http://www.impa.br/~diego/software/luasocket"))
108--&gt; homepage gets dumped to terminal 102--&gt; homepage gets dumped to terminal
@@ -123,7 +117,7 @@ Lua 5.1.5 Copyright (C) 1994-2012 Lua.org, PUC-Rio
123<p> 117<p>
124<small> 118<small>
125Last modified by Diego Nehab on <br> 119Last modified by Diego Nehab on <br>
126Mon Apr 16 21:01:42 HKT 2012 120Tue Jun 11 19:06:14 HKT 2013
127</small> 121</small>
128</p> 122</p>
129</center> 123</center>
diff --git a/doc/tcp.html b/doc/tcp.html
index 151a4c9..4226d78 100644
--- a/doc/tcp.html
+++ b/doc/tcp.html
@@ -208,7 +208,7 @@ established.
208</p> 208</p>
209 209
210<p class=note> 210<p class=note>
211Note: Starting with LuaSocket 2.1, the host name resolution 211Note: Starting with LuaSocket 3.0, the host name resolution
212depends on whether the socket was created by <a 212depends on whether the socket was created by <a
213href=#socket.tcp><tt>socket.tcp</tt></a> or <a 213href=#socket.tcp><tt>socket.tcp</tt></a> or <a
214href=#socket.tcp6><tt>socket.tcp6</tt></a>. Addresses from 214href=#socket.tcp6><tt>socket.tcp6</tt></a>. Addresses from
diff --git a/doc/udp.html b/doc/udp.html
index 554fa31..e5b0ad0 100644
--- a/doc/udp.html
+++ b/doc/udp.html
@@ -365,7 +365,7 @@ and can result in up to 30% performance gains.
365</p> 365</p>
366 366
367<p class=note> 367<p class=note>
368Note: Starting with LuaSocket 2.1, the host name resolution 368Note: Starting with LuaSocket 3.0, the host name resolution
369depends on whether the socket was created by <a 369depends on whether the socket was created by <a
370href=#socket.udp><tt>socket.udp</tt></a> or <a 370href=#socket.udp><tt>socket.udp</tt></a> or <a
371href=#socket.udp6><tt>socket.udp6</tt></a>. Addresses from 371href=#socket.udp6><tt>socket.udp6</tt></a>. Addresses from