diff options
author | Diego Nehab <diego@tecgraf.puc-rio.br> | 2004-11-28 08:17:16 +0000 |
---|---|---|
committer | Diego Nehab <diego@tecgraf.puc-rio.br> | 2004-11-28 08:17:16 +0000 |
commit | 534b0cedf714d4de0a6cf67570e11f232cdccf84 (patch) | |
tree | 14b26a6a8460e57c9739025eb0e661f64bb78b4f /doc | |
parent | 297b32e828b76ee544c9d4f89f996eda78830cc0 (diff) | |
download | luasocket-534b0cedf714d4de0a6cf67570e11f232cdccf84.tar.gz luasocket-534b0cedf714d4de0a6cf67570e11f232cdccf84.tar.bz2 luasocket-534b0cedf714d4de0a6cf67570e11f232cdccf84.zip |
Added new instalation section to the manual.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/dns.html | 4 | ||||
-rw-r--r-- | doc/ftp.html | 4 | ||||
-rw-r--r-- | doc/http.html | 4 | ||||
-rw-r--r-- | doc/index.html | 84 | ||||
-rw-r--r-- | doc/installation.html | 149 | ||||
-rw-r--r-- | doc/introduction.html | 39 | ||||
-rw-r--r-- | doc/ltn12.html | 6 | ||||
-rw-r--r-- | doc/mime.html | 4 | ||||
-rw-r--r-- | doc/reference.html | 5 | ||||
-rw-r--r-- | doc/smtp.html | 5 | ||||
-rw-r--r-- | doc/socket.html | 4 | ||||
-rw-r--r-- | doc/tcp.html | 4 | ||||
-rw-r--r-- | doc/udp.html | 4 | ||||
-rw-r--r-- | doc/url.html | 4 |
14 files changed, 245 insertions, 75 deletions
diff --git a/doc/dns.html b/doc/dns.html index 09a9bdb..2c4c51f 100644 --- a/doc/dns.html +++ b/doc/dns.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: DNS support"> | 6 | <meta name="description" content="LuaSocket: DNS support"> |
7 | <meta name="keywords" content="Lua, Library, DNS, Network, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, DNS, Network, Library, Support"> |
8 | <title>LuaSocket: DNS support</title> | 8 | <title>LuaSocket: DNS support</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -26,6 +26,7 @@ | |||
26 | <p class=bar> | 26 | <p class=bar> |
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 30 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
@@ -114,6 +115,7 @@ message. | |||
114 | <p class=bar> | 115 | <p class=bar> |
115 | <a href="home.html">home</a> · | 116 | <a href="home.html">home</a> · |
116 | <a href="home.html#down">download</a> · | 117 | <a href="home.html#down">download</a> · |
118 | <a href="instalation.html">instalation</a> · | ||
117 | <a href="introduction.html">introduction</a> · | 119 | <a href="introduction.html">introduction</a> · |
118 | <a href="reference.html">reference</a> | 120 | <a href="reference.html">reference</a> |
119 | </p> | 121 | </p> |
diff --git a/doc/ftp.html b/doc/ftp.html index 0b52007..a1a5162 100644 --- a/doc/ftp.html +++ b/doc/ftp.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: FTP support"> | 6 | <meta name="description" content="LuaSocket: FTP support"> |
7 | <meta name="keywords" content="Lua, Library, FTP, Network, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, FTP, Network, Library, Support"> |
8 | <title>LuaSocket: FTP support</title> | 8 | <title>LuaSocket: FTP support</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -26,6 +26,7 @@ | |||
26 | <p class=bar> | 26 | <p class=bar> |
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 30 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
@@ -265,6 +266,7 @@ f, e = ftp.put{ | |||
265 | <p class=bar> | 266 | <p class=bar> |
266 | <a href="home.html">home</a> · | 267 | <a href="home.html">home</a> · |
267 | <a href="home.html#download">download</a> · | 268 | <a href="home.html#download">download</a> · |
269 | <a href="instalation.html">instalation</a> · | ||
268 | <a href="introduction.html">introduction</a> · | 270 | <a href="introduction.html">introduction</a> · |
269 | <a href="reference.html">reference</a> | 271 | <a href="reference.html">reference</a> |
270 | </p> | 272 | </p> |
diff --git a/doc/http.html b/doc/http.html index 13acd1c..deacaa5 100644 --- a/doc/http.html +++ b/doc/http.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: HTTP support"> | 6 | <meta name="description" content="LuaSocket: HTTP support"> |
7 | <meta name="keywords" content="Lua, Library, HTTP, WWW, browser, Network, Support"> | 7 | <meta name="keywords" content="Lua, HTTP, Library, WWW, Browser, Network, Support"> |
8 | <title>LuaSocket: HTTP support</title> | 8 | <title>LuaSocket: HTTP support</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -27,6 +27,7 @@ | |||
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="introduction.html">introduction</a> · | 29 | <a href="introduction.html">introduction</a> · |
30 | <a href="introduction.html">introduction</a> · | ||
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
32 | </center> | 33 | </center> |
@@ -299,6 +300,7 @@ r, c = http.request { | |||
299 | <p class=bar> | 300 | <p class=bar> |
300 | <a href="home.html">home</a> · | 301 | <a href="home.html">home</a> · |
301 | <a href="home.html#download">download</a> · | 302 | <a href="home.html#download">download</a> · |
303 | <a href="instalation.html">instalation</a> · | ||
302 | <a href="introduction.html">introduction</a> · | 304 | <a href="introduction.html">introduction</a> · |
303 | <a href="reference.html">reference</a> | 305 | <a href="reference.html">reference</a> |
304 | </p> | 306 | </p> |
diff --git a/doc/index.html b/doc/index.html index c0a46ea..c3c391f 100644 --- a/doc/index.html +++ b/doc/index.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="The LuaSocket Homepage"> | 6 | <meta name="description" content="The LuaSocket Homepage"> |
7 | <meta name="keywords" content="Lua, Library, Network, Support, Internet"> | 7 | <meta name="keywords" content="Lua, LuaSocket, Network, Library, Support, Internet"> |
8 | <title>LuaSocket: Network support for the Lua language </title> | 8 | <title>LuaSocket: Network support for the Lua language </title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -26,6 +26,7 @@ | |||
26 | <p class=bar> | 26 | <p class=bar> |
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 30 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
@@ -79,7 +80,7 @@ LuaSocket. | |||
79 | </p> | 80 | </p> |
80 | 81 | ||
81 | <p> | 82 | <p> |
82 | Copyright © 1999-2004 Tecgraf/PUC-Rio. All rights reserved. <br> | 83 | Copyright © 2004 Diego Nehab. All rights reserved. <br> |
83 | Author: <A href="http://www.cs.princeton.edu/~diego">Diego Nehab</a> | 84 | Author: <A href="http://www.cs.princeton.edu/~diego">Diego Nehab</a> |
84 | </p> | 85 | </p> |
85 | 86 | ||
@@ -88,7 +89,7 @@ Author: <A href="http://www.cs.princeton.edu/~diego">Diego Nehab</a> | |||
88 | <h2 id=download>Download</h2> | 89 | <h2 id=download>Download</h2> |
89 | 90 | ||
90 | <p> | 91 | <p> |
91 | LuaSocket version 2.0 beta2 is now available for download! It is | 92 | LuaSocket version 2.0 (beta3) is now available for download! It is |
92 | compatible with Lua 5.0 and has been tested on | 93 | compatible with Lua 5.0 and has been tested on |
93 | Windows XP, Linux, and Mac OS X. | 94 | Windows XP, Linux, and Mac OS X. |
94 | </p> | 95 | </p> |
@@ -99,8 +100,8 @@ The library can be downloaded in source code from the following links: | |||
99 | 100 | ||
100 | <blockquote> | 101 | <blockquote> |
101 | <p> | 102 | <p> |
102 | <a href="luasocket-2.0-beta2.tar.gz">luasocket-2.0-beta2.tar.gz</a> <br> | 103 | <a href="luasocket-2.0-beta3.tar.gz">luasocket-2.0-beta3.tar.gz</a> <br> |
103 | <a href="luasocket-2.0-beta2.zip">luasocket-2.0-beta2.zip</a> | 104 | <a href="luasocket-2.0-beta3.zip">luasocket-2.0-beta3.zip</a> |
104 | </p> | 105 | </p> |
105 | </blockquote> | 106 | </blockquote> |
106 | 107 | ||
@@ -116,7 +117,7 @@ LuaSocket a quick try: | |||
116 | 117 | ||
117 | <blockquote> | 118 | <blockquote> |
118 | <p> | 119 | <p> |
119 | <a href="luasocket-2.0-beta2-win32.zip">luasocket-2.0-beta2-win32.zip</a> | 120 | <a href="luasocket-2.0-beta3-win32.zip">luasocket-2.0-beta3-win32.zip</a> |
120 | </p> | 121 | </p> |
121 | </blockquote> | 122 | </blockquote> |
122 | 123 | ||
@@ -124,11 +125,15 @@ LuaSocket a quick try: | |||
124 | The quick and dirty way to use these binaries is to unpack everything into a | 125 | The quick and dirty way to use these binaries is to unpack everything into a |
125 | directory, say <tt>c:\luasocket</tt> (include all Lua files from the | 126 | directory, say <tt>c:\luasocket</tt> (include all Lua files from the |
126 | LuaSocket distrbitution in the same directory too!). | 127 | LuaSocket distrbitution in the same directory too!). |
127 | Then set <tt>LUA_INIT</tt> to load the <tt>lua.lua</tt> helper file: | 128 | Then set <tt>LUA_INIT</tt> to load the <tt>compat-5.1.lua</tt> and set |
129 | <tt>LUA_PATH</tt> and <tt>LUA_CPATH</tt> to look for files in that | ||
130 | directory: | ||
128 | </p> | 131 | </p> |
129 | 132 | ||
130 | <pre class=example> | 133 | <pre class=example> |
131 | c:\luasocket\> set LUA_INIT=@lua.lua | 134 | c:\luasocket\> set LUA_INIT=@compat-5.1.lua |
135 | c:\luasocket\> set LUA_CPATH=?.dll | ||
136 | c:\luasocket\> set LUA_PATH=?.lua | ||
132 | </pre> | 137 | </pre> |
133 | 138 | ||
134 | <p> | 139 | <p> |
@@ -142,9 +147,13 @@ c:\luasocket\> lua | |||
142 | Lua 5.0.2 Copyright (C) 1994-2004 Tecgraf, PUC-Rio | 147 | Lua 5.0.2 Copyright (C) 1994-2004 Tecgraf, PUC-Rio |
143 | > http = require"http" | 148 | > http = require"http" |
144 | > print(http.request"http://www.tecgraf.puc-rio.br/luasocket/") | 149 | > print(http.request"http://www.tecgraf.puc-rio.br/luasocket/") |
145 | --> this file | 150 | --> this gets dumped to terminal |
146 | </pre> | 151 | </pre> |
147 | 152 | ||
153 | <p> Take a look at the <a href=instalation.html>installation</a> section of | ||
154 | the manual to find out how to properly install the library after you are | ||
155 | done playing with it. </p> | ||
156 | |||
148 | <!-- thanks +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 157 | <!-- thanks +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
149 | 158 | ||
150 | <h2 id=thanks>Special thanks</h2> | 159 | <h2 id=thanks>Special thanks</h2> |
@@ -165,35 +174,31 @@ has been helping a lot too! Thanks to you all! | |||
165 | <h2 id=new>What's New</h2> | 174 | <h2 id=new>What's New</h2> |
166 | 175 | ||
167 | <p> | 176 | <p> |
168 | Changes in the 2.0-beta2 were mostly bug-fixes. | 177 | The big change for the 2.0 (beta3) release was the adoption of the Lua 5.1 |
178 | package proposal. There were several bug fixes too (a beta is a | ||
179 | beta, is a beta). | ||
169 | </p> | 180 | </p> |
170 | 181 | ||
171 | <ul> | 182 | <ul> |
172 | <li> Fixed silly last-minute-change bug in HTTP/SMTP; | 183 | <li> New compat-5.1 distribution: |
173 | <li> <tt>usocket.c</tt>/<tt>wsocket.c</tt> look nicer thanks to Mike; | 184 | <ul> |
174 | <li> Finally total timeout is reliable on Windows! (found a pretty | 185 | <li> Instalation uses new directory structure; |
175 | simple work around); | 186 | <li> Namespace hierarchy is in now back in use (ex. <tt>socket.url</tt> |
176 | <li> UDP has a reasonable maximum datagram size (8k); | 187 | instead of <tt>url</tt>); |
177 | <li> <tt>Receive</tt> accepts the prefix optional argument (good for | 188 | <li> Globals not visible from inside namespaces; |
178 | non-blocking); | 189 | <li> All modules call <tt>require</tt> even for standard libraries; |
179 | <li> <b><tt>Send</tt> doesn't support multiple arguments anymore</b>; | 190 | </ul> |
180 | <li> Instead, <tt>send</tt> allows the selection of the substring | 191 | <li> LTN12 avoids coroutines (so you can go wild on the C side); |
181 | to be sent (good for non-blocking); | 192 | <li> Kludge on wsocket.c:sock_send for windows timeout issue |
182 | <li> Fixed bug that caused select return tables not to be associative | 193 | moved to buffer.c:sendraw; |
183 | on windows; | 194 | <li> <tt>socket.protect </tt>only catches errors thrown by <tt>socket.try</tt>; |
184 | <li> Should compile with g++; | 195 | <li> Fixed <tt>udp:sendto</tt> to call <tt>sock_sendto</tt> instead of |
185 | <li> New sample unix domain support; | 196 | <tt>sock_send</tt>; |
186 | <li> New sample LPD support; | 197 | <li> <tt>close</tt> wasn't returning 1! |
187 | <li> Comprehensive error messages; | 198 | <li> <tt>socket.gettime</tt> returns time since Unix Epoch 1/1/1970 (UTC) |
188 | <li> New <tt>getstats</tt> and <tt>setstats</tt> methods to help throttling; | 199 | <li> <tt>socket.sleep</tt> is robust to interrupts; |
189 | <li> <tt>Listen</tt> defaults to 32 backlog; | 200 | <li> <tt>socket.select</tt> wasn't calling <tt>tm_markstart</tt>; |
190 | <li> SMTP/FTP/HTTP fail gracefully; | 201 | <li> <tt>http.PROXY</tt> etc wasn't working. |
191 | <li> <tt>accept</tt>/<tt>connect</tt>/<tt>select</tt> interrupt safe | ||
192 | <li> Fixed bug that didn't set accepted sockets as non-blocking | ||
193 | <li> <b>New timming functions <tt>sleep</tt> and <tt>gettime</tt> have | ||
194 | higher resolution and no wrap around problems</b>; | ||
195 | <li> Bug fixes in the manual; | ||
196 | <li> Fixed bug of missing cast in <tt>getfd</tt>. | ||
197 | </ul> | 202 | </ul> |
198 | 203 | ||
199 | <!-- incompatible +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 204 | <!-- incompatible +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
@@ -201,10 +206,9 @@ higher resolution and no wrap around problems</b>; | |||
201 | <h3 id=incompatible>Incompatibilities with previous versions</h3> | 206 | <h3 id=incompatible>Incompatibilities with previous versions</h3> |
202 | 207 | ||
203 | <ul> | 208 | <ul> |
204 | 209 | <li> Namespaces are hierarchical again. This means that whoever called | |
205 | <li> New <tt>send</tt> inteface doesn't send multiple arguments anymore; | 210 | <tt>require("url")</tt> should update their code to |
206 | <li> <tt>Time</tt> is replaced by <tt>gettime</tt> with advantage. | 211 | <tt>require("socket.url")</tt>. |
207 | |||
208 | </ul> | 212 | </ul> |
209 | 213 | ||
210 | <!-- old ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 214 | <!-- old ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
@@ -225,6 +229,8 @@ those that have compatibility issues. | |||
225 | <center> | 229 | <center> |
226 | <p class=bar> | 230 | <p class=bar> |
227 | <a href="home.html#down">download</a> · | 231 | <a href="home.html#down">download</a> · |
232 | <a href="home.html#download">download</a> · | ||
233 | <a href="instalation.html">instalation</a> · | ||
228 | <a href="introduction.html">introduction</a> · | 234 | <a href="introduction.html">introduction</a> · |
229 | <a href="reference.html">reference</a> | 235 | <a href="reference.html">reference</a> |
230 | </p> | 236 | </p> |
diff --git a/doc/installation.html b/doc/installation.html new file mode 100644 index 0000000..d5e82d9 --- /dev/null +++ b/doc/installation.html | |||
@@ -0,0 +1,149 @@ | |||
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="LuaSocket: Introduction to the core"> | ||
7 | <meta name="keywords" content="Lua, LuaSocket, TCP, UDP, Network, Support, | ||
8 | Installation"> | ||
9 | <title>LuaSocket: Instalation</title> | ||
10 | <link rel="stylesheet" href="reference.css" type="text/css"> | ||
11 | </head> | ||
12 | |||
13 | <body> | ||
14 | |||
15 | <!-- header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
16 | |||
17 | <div class=header> | ||
18 | <hr> | ||
19 | <center> | ||
20 | <table summary="LuaSocket logo"> | ||
21 | <tr><td align=center><a href="http://www.lua.org"> | ||
22 | <img width=128 height=128 border=0 alt="LuaSocket" src="luasocket.png"> | ||
23 | </a></td></tr> | ||
24 | <tr><td align=center valign=top>Network support for the Lua language | ||
25 | </td></tr> | ||
26 | </table> | ||
27 | <p class=bar> | ||
28 | <a href="home.html">home</a> · | ||
29 | <a href="home.html#download">download</a> · | ||
30 | <a href="instalation.html">instalation</a> · | ||
31 | <a href="introduction.html">introduction</a> · | ||
32 | <a href="reference.html">reference</a> | ||
33 | </p> | ||
34 | </center> | ||
35 | <hr> | ||
36 | </div> | ||
37 | |||
38 | <!-- instalation ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
39 | |||
40 | <h2>Instalation</h2> | ||
41 | |||
42 | <p> LuaSocket 2.0 uses the new package proposal for Lua 5.1, throught the | ||
43 | compatibility module <a href=http://www.keplerproject.org/compat/> | ||
44 | Compat-5.1</a> released in conjunction with Roberto Ierusalimschy and <a | ||
45 | href=http://www.keplerproject.org/">The Kepler project</a>. The proposal | ||
46 | was considered important enough by the community to justify early adoption. | ||
47 | All Lua library developers are encouraged to change their libraries in | ||
48 | preparation for the release of Lua 5.1. </p> | ||
49 | |||
50 | <p> As far as LuaSocket is concerned, this means that whoever is | ||
51 | deploying a solution that uses LuaSocket has a lot of freedom. Here we | ||
52 | describe only the standard distribution. If the standard doesn't meet your | ||
53 | needs, we refer you to the Lua discussion list, where any quesetion about | ||
54 | the package scheme will likely be answered promptly. | ||
55 | </p> | ||
56 | |||
57 | <h3>Directory structure</h3> | ||
58 | |||
59 | <p> The new package scheme has a root directory for the libraries installed | ||
60 | on a given system. Let's call this directory <tt><ROOT></tt>. | ||
61 | On my system, this is the <tt>/usr/local/share/lua/5.0</tt> directory. | ||
62 | Here is the standard LuaSocket distribution directory structure:</p> | ||
63 | |||
64 | <pre class=example> | ||
65 | <ROOT>/compat-5.1.lua | ||
66 | <ROOT>/socket.lua | ||
67 | <ROOT>/lsocket.dll | ||
68 | <ROOT>/mime.lua | ||
69 | <ROOT>/lmime.dll | ||
70 | <ROOT>/ltn12.lua | ||
71 | <ROOT>/socket/http.lua | ||
72 | <ROOT>/socket/tp.lua | ||
73 | <ROOT>/socket/ftp.lua | ||
74 | <ROOT>/socket/smtp.lua | ||
75 | <ROOT>/socket/url.lua | ||
76 | </pre> | ||
77 | |||
78 | <p> Naturally, on Unix systems, <tt>lsocket.dll</tt> and <tt>lmime.dll</tt> | ||
79 | would be replaced by <tt>lsocket.so</tt> and <tt>lmime.so</tt>. In Mac OS | ||
80 | X, they would be replaced by <tt>lsocket.dylib</tt> and | ||
81 | <tt>lmime.dylib</tt>. </p> | ||
82 | |||
83 | <p> In order for the interpreter to find all LuaSocket components, three | ||
84 | environment variables need to be set. The first environment variable tells | ||
85 | the interpreter to load the <tt>compat-5.1.lua</tt> module. </p> | ||
86 | |||
87 | <pre class=example> | ||
88 | LUA_INIT=@<ROOT>/compat-5.1.lua | ||
89 | </pre> | ||
90 | |||
91 | The other two environment variables instruct the compatibility module to | ||
92 | look for dynamic libraries and modules in the appropriate directories and | ||
93 | with the appropriate filename extensions. | ||
94 | |||
95 | <pre class=example> | ||
96 | LUA_PATH=<ROOT>/?.lua;?.lua | ||
97 | LUA_CPATH=<ROOT>/?.dll;?.dll | ||
98 | </pre> | ||
99 | |||
100 | <p> Again, naturally, in Unix the shared library extension would be | ||
101 | <tt>.so</tt> instead of <tt>.dll</tt> and on Mac OS X they would be | ||
102 | <tt>.dylib</tt></p> | ||
103 | |||
104 | <h3>Using LuaSocket</h3> | ||
105 | |||
106 | <p> With the above setup, and an interpreter with shared library support, | ||
107 | it should be easy to use LuaSocket. Just fire the interpreter and use the | ||
108 | <tt>require</tt> function to gain access to whatever module you need:</p> | ||
109 | |||
110 | <pre class=example> | ||
111 | Lua 5.0.2 Copyright (C) 1994-2004 Tecgraf, PUC-Rio | ||
112 | > socket = require("socket") | ||
113 | > print(socket.VERSION) | ||
114 | --> LuaSocket 2.0 (beta3) | ||
115 | </pre> | ||
116 | |||
117 | <p> Each module loads their dependencies automatically, so you only need to | ||
118 | load the modues you are directly dependent upon. <p> | ||
119 | |||
120 | <pre class=example> | ||
121 | Lua 5.0.2 Copyright (C) 1994-2004 Tecgraf, PUC-Rio | ||
122 | > http = require("socket.http") | ||
123 | > print(http.get("http://www.tecgraf.puc-rio.br/luasocket")) | ||
124 | --> homepage gets dumped to terminal | ||
125 | </pre> | ||
126 | |||
127 | <!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
128 | |||
129 | <div class=footer> | ||
130 | <hr> | ||
131 | <center> | ||
132 | <p class=bar> | ||
133 | <a href="home.html">home</a> · | ||
134 | <a href="home.html#down">download</a> · | ||
135 | <a href="instalation.html">instalation</a> · | ||
136 | <a href="introduction.html">introduction</a> · | ||
137 | <a href="reference.html">reference</a> | ||
138 | </p> | ||
139 | <p> | ||
140 | <small> | ||
141 | Last modified by Diego Nehab on <br> | ||
142 | Thu Jun 17 02:47:21 EDT 2004 | ||
143 | </small> | ||
144 | </p> | ||
145 | </center> | ||
146 | </div> | ||
147 | |||
148 | </body> | ||
149 | </html> | ||
diff --git a/doc/introduction.html b/doc/introduction.html index 20c4d36..a285b81 100644 --- a/doc/introduction.html +++ b/doc/introduction.html | |||
@@ -4,7 +4,8 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: Introduction to the core"> | 6 | <meta name="description" content="LuaSocket: Introduction to the core"> |
7 | <meta name="keywords" content="Lua, Library, TCP, UDP, Network, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, TCP, UDP, Network, |
8 | Library, Support"> | ||
8 | <title>LuaSocket: Introduction to the core</title> | 9 | <title>LuaSocket: Introduction to the core</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 10 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 11 | </head> |
@@ -26,6 +27,7 @@ | |||
26 | <p class=bar> | 27 | <p class=bar> |
27 | <a href="home.html">home</a> · | 28 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 29 | <a href="home.html#download">download</a> · |
30 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 31 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 32 | <a href="reference.html">reference</a> |
31 | </p> | 33 | </p> |
@@ -104,29 +106,6 @@ Together, these changes make network programming in LuaSocket much simpler | |||
104 | than it is in C, as the following sections will show. | 106 | than it is in C, as the following sections will show. |
105 | </p> | 107 | </p> |
106 | 108 | ||
107 | <!-- initializing +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
108 | |||
109 | <h3>Initializing the library</h3> | ||
110 | |||
111 | <p> | ||
112 | The core LuaSocket is almost entirely implemented in C. It is | ||
113 | usually available as a dynamic library which the interpreter can load | ||
114 | with the help of a loader module written in Lua. | ||
115 | Beginning with version 2.0 and following the Lua 5.0 trend, all LuaSocket | ||
116 | functionality is defined inside tables (or rather namespaces). No global | ||
117 | variables are ever created. | ||
118 | Namespaces are obtained with the <tt>require</tt> Lua function, which loads | ||
119 | and initializes any required library and returns the namespace. | ||
120 | For example, the core functionality or LuaSocket is usually available | ||
121 | from the "<tt>socket</tt>" namespace. | ||
122 | </p> | ||
123 | |||
124 | <pre class="example"> | ||
125 | socket = require("socket") | ||
126 | print(socket.VERSION) | ||
127 | --> LuaSocket 2.0 | ||
128 | </pre> | ||
129 | |||
130 | <!-- tcp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 109 | <!-- tcp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
131 | 110 | ||
132 | <h3 id=tcp>TCP</h3> | 111 | <h3 id=tcp>TCP</h3> |
@@ -318,6 +297,17 @@ io.write(socket.try((udp:receive()))) | |||
318 | </pre> | 297 | </pre> |
319 | </blockquote> | 298 | </blockquote> |
320 | 299 | ||
300 | <!-- More +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
301 | |||
302 | <h3 id=more>Much more</h3> | ||
303 | |||
304 | <p> LuaSocket offers much more than TCP and UDP support. As the library | ||
305 | evolved, support for <a href=http.html>HTTP</a>, <a href=ftp.html>FTP</a>, | ||
306 | <a href=smtp.html>SMTP</a>, <a href=mime.html>MIME</a>, <a | ||
307 | href=url.html>URLs</a> and much more was made available.</a> These are | ||
308 | mostly implemented in Lua itself, with critical parts implemented in C for | ||
309 | efficiency</p> | ||
310 | |||
321 | <!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 311 | <!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
322 | 312 | ||
323 | <div class=footer> | 313 | <div class=footer> |
@@ -326,6 +316,7 @@ io.write(socket.try((udp:receive()))) | |||
326 | <p class=bar> | 316 | <p class=bar> |
327 | <a href="home.html">home</a> · | 317 | <a href="home.html">home</a> · |
328 | <a href="home.html#down">download</a> · | 318 | <a href="home.html#down">download</a> · |
319 | <a href="instalation.html">instalation</a> · | ||
329 | <a href="introduction.html">introduction</a> · | 320 | <a href="introduction.html">introduction</a> · |
330 | <a href="reference.html">reference</a> | 321 | <a href="reference.html">reference</a> |
331 | </p> | 322 | </p> |
diff --git a/doc/ltn12.html b/doc/ltn12.html index 40dcf96..4b8f188 100644 --- a/doc/ltn12.html +++ b/doc/ltn12.html | |||
@@ -4,8 +4,8 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: LTN12 support"> | 6 | <meta name="description" content="LuaSocket: LTN12 support"> |
7 | <meta name="keywords" content="Lua, Library, Filters, Source, Sink, | 7 | <meta name="keywords" content="Lua, LuaSocket, Filters, Source, Sink, |
8 | Pump, Support"> | 8 | Pump, Support, Library"> |
9 | <title>LuaSocket: LTN12 module</title> | 9 | <title>LuaSocket: LTN12 module</title> |
10 | <link rel="stylesheet" href="reference.css" type="text/css"> | 10 | <link rel="stylesheet" href="reference.css" type="text/css"> |
11 | </head> | 11 | </head> |
@@ -27,6 +27,7 @@ Pump, Support"> | |||
27 | <p class=bar> | 27 | <p class=bar> |
28 | <a href="home.html">home</a> · | 28 | <a href="home.html">home</a> · |
29 | <a href="home.html#download">download</a> · | 29 | <a href="home.html#download">download</a> · |
30 | <a href="instalation.html">instalation</a> · | ||
30 | <a href="introduction.html">introduction</a> · | 31 | <a href="introduction.html">introduction</a> · |
31 | <a href="reference.html">reference</a> | 32 | <a href="reference.html">reference</a> |
32 | </p> | 33 | </p> |
@@ -412,6 +413,7 @@ Creates and returns a source that produces the contents of a | |||
412 | <p class=bar> | 413 | <p class=bar> |
413 | <a href="home.html">home</a> · | 414 | <a href="home.html">home</a> · |
414 | <a href="home.html#down">download</a> · | 415 | <a href="home.html#down">download</a> · |
416 | <a href="instalation.html">instalation</a> · | ||
415 | <a href="introduction.html">introduction</a> · | 417 | <a href="introduction.html">introduction</a> · |
416 | <a href="reference.html">reference</a> | 418 | <a href="reference.html">reference</a> |
417 | </p> | 419 | </p> |
diff --git a/doc/mime.html b/doc/mime.html index 6758a4b..594d749 100644 --- a/doc/mime.html +++ b/doc/mime.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: MIME support"> | 6 | <meta name="description" content="LuaSocket: MIME support"> |
7 | <meta name="keywords" content="Lua, Library, MIME, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, MIME, Library, Support"> |
8 | <title>LuaSocket: MIME module</title> | 8 | <title>LuaSocket: MIME module</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -26,6 +26,7 @@ | |||
26 | <p class=bar> | 26 | <p class=bar> |
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 30 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
@@ -458,6 +459,7 @@ marker. | |||
458 | <p class=bar> | 459 | <p class=bar> |
459 | <a href="home.html">home</a> · | 460 | <a href="home.html">home</a> · |
460 | <a href="home.html#down">download</a> · | 461 | <a href="home.html#down">download</a> · |
462 | <a href="instalation.html">instalation</a> · | ||
461 | <a href="introduction.html">introduction</a> · | 463 | <a href="introduction.html">introduction</a> · |
462 | <a href="reference.html">reference</a> | 464 | <a href="reference.html">reference</a> |
463 | </p> | 465 | </p> |
diff --git a/doc/reference.html b/doc/reference.html index 744da58..b15a2aa 100644 --- a/doc/reference.html +++ b/doc/reference.html | |||
@@ -4,7 +4,8 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: Index to reference manual"> | 6 | <meta name="description" content="LuaSocket: Index to reference manual"> |
7 | <meta name="keywords" content="Lua, Library, Index, Manual, Network, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, Index, Manual, Network, Library, |
8 | Support, Manual"> | ||
8 | <title>LuaSocket: Index to reference manual</title> | 9 | <title>LuaSocket: Index to reference manual</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 10 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 11 | </head> |
@@ -26,6 +27,7 @@ | |||
26 | <p class=bar> | 27 | <p class=bar> |
27 | <a href="home.html">home</a> · | 28 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 29 | <a href="home.html#download">download</a> · |
30 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 31 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 32 | <a href="reference.html">reference</a> |
31 | </p> | 33 | </p> |
@@ -220,6 +222,7 @@ | |||
220 | <p class=bar> | 222 | <p class=bar> |
221 | <a href="home.html">home</a> · | 223 | <a href="home.html">home</a> · |
222 | <a href="home.html#down">download</a> · | 224 | <a href="home.html#down">download</a> · |
225 | <a href="instalation.html">instalation</a> · | ||
223 | <a href="introduction.html">introduction</a> · | 226 | <a href="introduction.html">introduction</a> · |
224 | <a href="reference.html">reference</a> | 227 | <a href="reference.html">reference</a> |
225 | </p> | 228 | </p> |
diff --git a/doc/smtp.html b/doc/smtp.html index 4a9aaac..27223ae 100644 --- a/doc/smtp.html +++ b/doc/smtp.html | |||
@@ -4,7 +4,8 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: SMTP support"> | 6 | <meta name="description" content="LuaSocket: SMTP support"> |
7 | <meta name="keywords" content="Lua, Library, SMTP, e-mail, MIME, Multipart, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, SMTP, E-Mail, MIME, Multipart, |
8 | Library, Support"> | ||
8 | <title>LuaSocket: SMTP support</title> | 9 | <title>LuaSocket: SMTP support</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 10 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 11 | </head> |
@@ -26,6 +27,7 @@ | |||
26 | <p class=bar> | 27 | <p class=bar> |
27 | <a href="home.html">home</a> · | 28 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 29 | <a href="home.html#download">download</a> · |
30 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 31 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 32 | <a href="reference.html">reference</a> |
31 | </p> | 33 | </p> |
@@ -394,6 +396,7 @@ r, e = smtp.send{ | |||
394 | <p class=bar> | 396 | <p class=bar> |
395 | <a href="home.html">home</a> · | 397 | <a href="home.html">home</a> · |
396 | <a href="home.html#down">download</a> · | 398 | <a href="home.html#down">download</a> · |
399 | <a href="instalation.html">instalation</a> · | ||
397 | <a href="introduction.html">introduction</a> · | 400 | <a href="introduction.html">introduction</a> · |
398 | <a href="reference.html">reference</a> | 401 | <a href="reference.html">reference</a> |
399 | </p> | 402 | </p> |
diff --git a/doc/socket.html b/doc/socket.html index c7525eb..809c256 100644 --- a/doc/socket.html +++ b/doc/socket.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: The core namespace"> | 6 | <meta name="description" content="LuaSocket: The core namespace"> |
7 | <meta name="keywords" content="Lua, Library, socket, Network, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, Socket, Network, Library, Support"> |
8 | <title>LuaSocket: The socket namespace</title> | 8 | <title>LuaSocket: The socket namespace</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -26,6 +26,7 @@ | |||
26 | <p class=bar> | 26 | <p class=bar> |
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 30 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
@@ -382,6 +383,7 @@ This constant has a string describing the current LuaSocket version. | |||
382 | <p class=bar> | 383 | <p class=bar> |
383 | <a href="home.html">home</a> · | 384 | <a href="home.html">home</a> · |
384 | <a href="home.html#down">download</a> · | 385 | <a href="home.html#down">download</a> · |
386 | <a href="instalation.html">instalation</a> · | ||
385 | <a href="introduction.html">introduction</a> · | 387 | <a href="introduction.html">introduction</a> · |
386 | <a href="reference.html">reference</a> | 388 | <a href="reference.html">reference</a> |
387 | </p> | 389 | </p> |
diff --git a/doc/tcp.html b/doc/tcp.html index dfc2c29..57784ea 100644 --- a/doc/tcp.html +++ b/doc/tcp.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: The TCP/IP support"> | 6 | <meta name="description" content="LuaSocket: The TCP/IP support"> |
7 | <meta name="keywords" content="Lua, Library, socket, TCP, Network, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, Socket, TCP, Library, Network, Support"> |
8 | <title>LuaSocket: TCP/IP support</title> | 8 | <title>LuaSocket: TCP/IP support</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -26,6 +26,7 @@ | |||
26 | <p class=bar> | 26 | <p class=bar> |
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 30 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
@@ -527,6 +528,7 @@ This function returns 1. | |||
527 | <p class=bar> | 528 | <p class=bar> |
528 | <a href="home.html">home</a> · | 529 | <a href="home.html">home</a> · |
529 | <a href="home.html#down">download</a> · | 530 | <a href="home.html#down">download</a> · |
531 | <a href="instalation.html">instalation</a> · | ||
530 | <a href="introduction.html">introduction</a> · | 532 | <a href="introduction.html">introduction</a> · |
531 | <a href="reference.html">reference</a> | 533 | <a href="reference.html">reference</a> |
532 | </p> | 534 | </p> |
diff --git a/doc/udp.html b/doc/udp.html index b0c51f6..f712b2f 100644 --- a/doc/udp.html +++ b/doc/udp.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: The UDP support"> | 6 | <meta name="description" content="LuaSocket: The UDP support"> |
7 | <meta name="keywords" content="Lua, Library, socket, UDP, Network, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, Socket, UDP, Library, Network, Support"> |
8 | <title>LuaSocket: UDP support</title> | 8 | <title>LuaSocket: UDP support</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -26,6 +26,7 @@ | |||
26 | <p class=bar> | 26 | <p class=bar> |
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 30 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
@@ -398,6 +399,7 @@ imperative nature obvious. | |||
398 | <p class=bar> | 399 | <p class=bar> |
399 | <a href="home.html">home</a> · | 400 | <a href="home.html">home</a> · |
400 | <a href="home.html#download">download</a> · | 401 | <a href="home.html#download">download</a> · |
402 | <a href="instalation.html">instalation</a> · | ||
401 | <a href="introduction.html">introduction</a> · | 403 | <a href="introduction.html">introduction</a> · |
402 | <a href="reference.html">reference</a> | 404 | <a href="reference.html">reference</a> |
403 | </p> | 405 | </p> |
diff --git a/doc/url.html b/doc/url.html index 92acf36..5c2be65 100644 --- a/doc/url.html +++ b/doc/url.html | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | <head> | 5 | <head> |
6 | <meta name="description" content="LuaSocket: URL manipulation"> | 6 | <meta name="description" content="LuaSocket: URL manipulation"> |
7 | <meta name="keywords" content="Lua, Library, URL, link, Network, Support"> | 7 | <meta name="keywords" content="Lua, LuaSocket, URL, Library, Link, Network, Support"> |
8 | <title>LuaSocket: URL support</title> | 8 | <title>LuaSocket: URL support</title> |
9 | <link rel="stylesheet" href="reference.css" type="text/css"> | 9 | <link rel="stylesheet" href="reference.css" type="text/css"> |
10 | </head> | 10 | </head> |
@@ -26,6 +26,7 @@ | |||
26 | <p class=bar> | 26 | <p class=bar> |
27 | <a href="home.html">home</a> · | 27 | <a href="home.html">home</a> · |
28 | <a href="home.html#download">download</a> · | 28 | <a href="home.html#download">download</a> · |
29 | <a href="instalation.html">instalation</a> · | ||
29 | <a href="introduction.html">introduction</a> · | 30 | <a href="introduction.html">introduction</a> · |
30 | <a href="reference.html">reference</a> | 31 | <a href="reference.html">reference</a> |
31 | </p> | 32 | </p> |
@@ -311,6 +312,7 @@ The function returns the decoded string. | |||
311 | <p class=bar> | 312 | <p class=bar> |
312 | <a href="home.html">home</a> · | 313 | <a href="home.html">home</a> · |
313 | <a href="home.html#down">download</a> · | 314 | <a href="home.html#down">download</a> · |
315 | <a href="instalation.html">instalation</a> · | ||
314 | <a href="introduction.html">introduction</a> · | 316 | <a href="introduction.html">introduction</a> · |
315 | <a href="reference.html">reference</a> | 317 | <a href="reference.html">reference</a> |
316 | </p> | 318 | </p> |