mirror of
https://github.com/lunarmodules/luasocket.git
synced 2024-11-16 18:28:21 +01:00
f960b3872a
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
134 lines
4.0 KiB
HTML
134 lines
4.0 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
|
"http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
|
|
<head>
|
|
<meta name="description" content="LuaSocket: Introduction to the core">
|
|
<meta name="keywords" content="Lua, LuaSocket, TCP, UDP, Network, Support,
|
|
Installation">
|
|
<title>LuaSocket: Installation</title>
|
|
<link rel="stylesheet" href="reference.css" type="text/css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<!-- header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
<div class=header>
|
|
<hr>
|
|
<center>
|
|
<table summary="LuaSocket logo">
|
|
<tr><td align=center><a href="http://www.lua.org">
|
|
<img width=128 height=128 border=0 alt="LuaSocket" src="luasocket.png">
|
|
</a></td></tr>
|
|
<tr><td align=center valign=top>Network support for the Lua language
|
|
</td></tr>
|
|
</table>
|
|
<p class=bar>
|
|
<a href="index.html">home</a> ·
|
|
<a href="index.html#download">download</a> ·
|
|
<a href="installation.html">installation</a> ·
|
|
<a href="introduction.html">introduction</a> ·
|
|
<a href="reference.html">reference</a>
|
|
</p>
|
|
</center>
|
|
<hr>
|
|
</div>
|
|
|
|
<!-- installation ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
<h2>Installation</h2>
|
|
|
|
<p> LuaSocket 2.1-rc still uses Lua 5.1's package
|
|
system. Users that have already made the switch to
|
|
Lua 5.2 should leave the default
|
|
<tt>LUA_COMPAT_MODULE</tt> defined when compiling their Lua
|
|
distribution for compatibility with LuaSocket. </p>
|
|
|
|
<p> Here we describe the standard distribution. If the
|
|
standard doesn't meet your needs, we refer you to the Lua
|
|
discussion list, where any question about the package scheme
|
|
will likely already have been answered. </p>
|
|
|
|
<h3>Directory structure</h3>
|
|
|
|
<p> On Unix systems, the standard distribution uses two base
|
|
directories, one for system dependent files, and another for system
|
|
independent files. Let's call these directories <tt><CDIR></tt>
|
|
and <tt><LDIR></tt>, respectively.
|
|
For example, in my laptp, Lua 5.1 is configured to
|
|
use '<tt>/usr/local/lib/lua/5.1</tt>' for
|
|
<tt><CDIR></tt> and '<tt>/usr/local/share/lua/5.1</tt>' for
|
|
<tt><LDIR></tt>. On Windows, <tt><CDIR></tt>
|
|
usually points to the directory where the Lua executable is
|
|
found, and <tt><LDIR></tt> points to a
|
|
<tt>lua/</tt> directory inside <tt><CDIR></tt>. (These
|
|
settings can be overridden by environment variables
|
|
<tt>LUA_PATH</tt> and <tt>LUA_CPATH</tt>. See the Lua
|
|
documentation for details.) Here is the standard LuaSocket
|
|
distribution directory structure:</p>
|
|
|
|
<pre class=example>
|
|
<LDIR>/ltn12.lua
|
|
<LDIR>/socket.lua
|
|
<CDIR>/socket/core.dll
|
|
<LDIR>/socket/http.lua
|
|
<LDIR>/socket/tp.lua
|
|
<LDIR>/socket/ftp.lua
|
|
<LDIR>/socket/smtp.lua
|
|
<LDIR>/socket/url.lua
|
|
<LDIR>/mime.lua
|
|
<CDIR>/mime/core.dll
|
|
</pre>
|
|
|
|
<p> Naturally, on Unix systems, <tt>core.dll</tt>
|
|
would be replaced by <tt>core.so</tt>.
|
|
</p>
|
|
|
|
<h3>Using LuaSocket</h3>
|
|
|
|
<p> With the above setup, and an interpreter with shared library support,
|
|
it should be easy to use LuaSocket. Just fire the interpreter and use the
|
|
<tt>require</tt> function to gain access to whatever module you need:</p>
|
|
|
|
<pre class=example>
|
|
Lua 5.1.5 Copyright (C) 1994-2012 Lua.org, PUC-Rio
|
|
> socket = require("socket")
|
|
> print(socket._VERSION)
|
|
--> LuaSocket 2.1-rc1
|
|
</pre>
|
|
|
|
<p> Each module loads their dependencies automatically, so you only need to
|
|
load the modules you directly depend upon: </p>
|
|
|
|
<pre class=example>
|
|
Lua 5.1.5 Copyright (C) 1994-2012 Lua.org, PUC-Rio
|
|
> http = require("socket.http")
|
|
> print(http.request("http://www.impa.br/~diego/software/luasocket"))
|
|
--> homepage gets dumped to terminal
|
|
</pre>
|
|
|
|
<!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
<div class=footer>
|
|
<hr>
|
|
<center>
|
|
<p class=bar>
|
|
<a href="index.html">home</a> ·
|
|
<a href="index.html#down">download</a> ·
|
|
<a href="installation.html">installation</a> ·
|
|
<a href="introduction.html">introduction</a> ·
|
|
<a href="reference.html">reference</a>
|
|
</p>
|
|
<p>
|
|
<small>
|
|
Last modified by Diego Nehab on <br>
|
|
Mon Apr 16 21:01:42 HKT 2012
|
|
</small>
|
|
</p>
|
|
</center>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|