beta-0.89.2
[luatex.git] / source / texk / web2c / luatexdir / luasocket / doc / index.html
blobd8ee4a492d2643f5d8cdcf2b6a0af299df84189b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
5 <head>
6 <meta name="description" content="The LuaSocket Homepage">
7 <meta name="keywords" content="Lua, LuaSocket, Network, Library, Support, Internet">
8 <title>LuaSocket: Network support for the Lua language </title>
9 <link rel="stylesheet" href="reference.css" type="text/css">
10 </head>
12 <body>
14 <!-- header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
16 <div class=header>
17 <hr>
18 <center>
19 <table summary="LuaSocket logo">
20 <tr><td align=center><a href="http://www.lua.org">
21 <img width=128 height=128 border=0 alt="LuaSocket" src="luasocket.png">
22 </a></td></tr>
23 <tr><td align=center valign=top>Network support for the Lua language
24 </td></tr>
25 </table>
26 <p class=bar>
27 <a href="index.html">home</a> &middot;
28 <a href="index.html#download">download</a> &middot;
29 <a href="installation.html">installation</a> &middot;
30 <a href="introduction.html">introduction</a> &middot;
31 <a href="reference.html">reference</a>
32 </p>
33 </center>
34 <hr>
35 </div>
37 <!-- whatis +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
39 <h2 id=whatis>What is LuaSocket?</h2>
41 <p>
42 LuaSocket is a <a href="http://www.lua.org">Lua</a> extension library
43 that is composed by two parts: a C core that provides support for the TCP
44 and UDP transport layers, and a set of Lua modules that add support for
45 functionality commonly needed by applications that deal with the Internet.
46 </p>
48 <p>
49 The core support has been implemented so that it is both efficient and
50 simple to use. It is available to any Lua application once it has been
51 properly initialized by the interpreter in use. The code has been tested
52 and runs well on several Windows and Unix platforms. </p>
54 <p>
55 Among the support modules, the most commonly used implement the
56 <a href=smtp.html>SMTP</a>
57 (sending e-mails),
58 <a href=http.html>HTTP</a>
59 (WWW access) and
60 <a href=ftp.html>FTP</a>
61 (uploading and downloading files) client
62 protocols. These provide a very natural and generic interface to the
63 functionality defined by each protocol.
64 In addition, you will find that the
65 <a href=mime.html>MIME</a> (common encodings),
66 <a href=url.html>URL</a>
67 (anything you could possible want to do with one) and
68 <a href=ltn12.html>LTN12</a>
69 (filters, sinks, sources and pumps) modules can be very handy.
70 </p>
72 <p>
73 The library is available under the same
74 <a href="http://www.lua.org/copyright.html">
75 terms and conditions</a> as the Lua language, the MIT license. The idea is
76 that if you can use Lua in a project, you should also be able to use
77 LuaSocket.
78 </p>
80 <p>
81 Copyright &copy; 1999-2012 Diego Nehab. All rights reserved. <br>
82 Author: <A href="http://www.impa.br/~diego">Diego Nehab</a>
83 </p>
85 <!-- download +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
87 <h2 id=download>Download</h2>
89 <p>
90 LuaSocket version 2.1-rc1 is now available for download!
91 It is compatible with Lua&nbsp;5.1 and 5.2, and has
92 been tested on Windows&nbsp;XP, Linux, and Mac OS X. Chances
93 are it works well on most UNIX distributions and Windows flavors.
94 </p>
96 <p>
97 The library can be downloaded in source code from the
98 <a href="https://github.com/diegonehab/luasocket/downloads">LuaSocket
99 project page</a> at GitHub. Besides the full C and Lua source code
100 for the library, the distribution contains several examples,
101 this user's manual and basic test procedures.
102 </p>
104 <p> Take a look at the <a
105 href=installation.html>installation</a> section of the
106 manual to find out how to properly install the library.
107 </p>
109 <!-- thanks +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
111 <h2 id=thanks>Special thanks</h2>
114 This marks the first release of LuaSocket that
115 wholeheartedly embraces the open-source development
116 philosophy. After a long hiatus, Matthew Wild finally
117 convinced me it was time for a release including IPv6
118 and Lua 5.2 support. Special thanks to Sam Roberts, Florian
119 Zeitz, and Paul Aurich, Liam Devine, and everybody else that
120 has helped bring this library back to life.
121 </p>
123 <!-- whatsnew +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
125 <h2 id=new>What's New</h2>
128 Main changes for LuaSocket&nbsp;2.1-rc1 are IPv6 support
129 and Lua&nbsp;5.2 compatibility.
130 </p>
132 <ul>
133 <li> Added: Compatible with Lua&nbsp;5.2 (using <tt>LUA_COMPAT_MODULE</tt>);
134 <li> Added: IPv6 support;
135 <ul>
136 <li> <tt>Socket.connect</tt> and <tt>socket.bind</tt> support IPv6 addresses;
137 <li> <tt>Getpeername</tt> and <tt>getsockname</tt> support
138 IPv6 addresses, and return the socket family as a third value;
139 <li> URL module updated to support IPv6 host names;
140 <li> New <tt>socket.tcp6</tt> and <tt>socket.udp6</tt> functions;
141 <li> New <tt>socket.dns.getaddrinfo</tt> function;
142 </ul>
143 <li> Added: <tt>getoption</tt> method;
144 <li> Fixed: <tt>url.unescape</tt> was returning additional values;
145 <li> Fixed: <tt>mime.qp</tt>, <tt>mime.unqp</tt>,
146 <tt>mime.b64</tt>, and <tt>mime.unb64</tt> could
147 mistaking their own stack slots for functions arguments;
148 <li> Fixed: Receiving zero-length datagram is now possible;
149 <li> Improved: Hidden all internal library symbols;
150 <li> Improved: Better error messages;
151 <li> Improved: Better documentation of socket options.
152 </ul>
154 <!-- old ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
156 <h2 id=old>Old Versions</h2>
159 All previous versions of the LuaSocket library can be downloaded <a
160 href="http://www.impa.br/~diego/software/luasocket/old">
161 here</a>. Although these versions are no longer supported, they are
162 still available for those that have compatibility issues.
163 </p>
165 <!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
167 <div class=footer>
168 <hr>
169 <center>
170 <p class=bar>
171 <a href="index.html#download">download</a> &middot;
172 <a href="installation.html">installation</a> &middot;
173 <a href="introduction.html">introduction</a> &middot;
174 <a href="reference.html">reference</a>
175 </p>
177 <small>
178 Last modified by Diego Nehab on <br>
179 Mon Apr 16 21:58:56 HKT 2012
180 </small>
181 </p>
182 </center>
183 </div>
185 </body>
186 </html>