aboutsummaryrefslogtreecommitdiff
path: root/docs/index.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/index.html138
1 files changed, 138 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..ad92687
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,138 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4
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>
11
12<body>
13
14<!-- header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
15
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>
36
37<!-- whatis +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
38
39<h2 id="whatis">What is LuaSocket?</h2>
40
41<p>
42LuaSocket is a <a href="http://www.lua.org">Lua</a> extension library
43that is composed by two parts: a C core that provides support for the TCP
44and UDP transport layers, and a set of Lua modules that add support for
45functionality commonly needed by applications that deal with the Internet.
46</p>
47
48<p>
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
51properly initialized by the interpreter in use. The code has been tested
52and runs well on several Windows and UNIX platforms. </p>
53
54<p>
55Among 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
62protocols. These provide a very natural and generic interface to the
63functionality defined by each protocol.
64In 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>
71
72<p>
73The library is available under the same
74<a href="http://www.lua.org/copyright.html">
75terms and conditions</a> as the Lua language, the MIT license. The idea is
76that if you can use Lua in a project, you should also be able to use
77LuaSocket.
78</p>
79
80<p>
81Copyright &copy; 1999-2013 Diego Nehab. All rights reserved. <br>
82Author: <a href="http://www.impa.br/~diego">Diego Nehab</a>
83</p>
84
85<!-- download +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
86
87<h2 id="download">Download</h2>
88
89<p>
90LuaSocket version 3.1.0 is now available for download!
91It is compatible with Lua&nbsp;5.1 through 5.4.
92Chances are it works well on most UNIX distributions and Windows flavors.
93</p>
94
95<p>
96The current version of the library can be found at
97the <a href="https://github.com/lunarmodules/luasocket">LuaSocket
98project page</a> on GitHub. Besides the full C and Lua source code
99for the library, the distribution contains several examples,
100this user's manual and basic test procedures.
101</p>
102
103<p> Take a look at the <a
104href="installation.html">installation</a> section of the
105manual to find out how to properly install the library.
106</p>
107
108<!-- thanks +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
109
110<h2 id="thanks">Special thanks</h2>
111
112<p>
113This marks the first release of LuaSocket that
114wholeheartedly embraces the open-source development
115philosophy. After a long hiatus, Matthew Wild finally
116convinced me it was time for a release including IPv6 and
117Lua 5.2 support. It was more work than we anticipated.
118Special thanks to Sam Roberts, Florian Zeitz, and Paul
119Aurich, Liam Devine, Alexey Melnichuk, and everybody else
120that has helped bring this library back to life.
121</p>
122
123<!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
124
125<div class="footer">
126<hr>
127<center>
128<p class="bar">
129<a href="index.html#download">download</a> &middot;
130<a href="installation.html">installation</a> &middot;
131<a href="introduction.html">introduction</a> &middot;
132<a href="reference.html">reference</a>
133</p>
134</center>
135</div>
136
137</body>
138</html>