luasocket/docs/installation.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> &middot;
<a href="index.html#download">download</a> &middot;
<a href="installation.html">installation</a> &middot;
<a href="introduction.html">introduction</a> &middot;
<a href="reference.html">reference</a>
</p>
</center>
<hr>
</div>

<!-- installation ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

<h2>Installation</h2>

<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>&lt;CDIR&gt;</tt>
and <tt>&lt;LDIR&gt;</tt>, respectively.
For example, in my laptp, Lua&nbsp;5.1 is configured to
use '<tt>/usr/local/lib/lua/5.1</tt>' for
<tt>&lt;CDIR&gt;</tt> and '<tt>/usr/local/share/lua/5.1</tt>' for
<tt>&lt;LDIR&gt;</tt>. On Windows, <tt>&lt;CDIR&gt;</tt>
usually points to the directory where the Lua executable is
found, and <tt>&lt;LDIR&gt;</tt> points to a
<tt>lua/</tt> directory inside <tt>&lt;CDIR&gt;</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>
&lt;LDIR&gt;/ltn12.lua
&lt;LDIR&gt;/socket.lua
&lt;CDIR&gt;/socket/core.dll
&lt;LDIR&gt;/socket/http.lua
&lt;LDIR&gt;/socket/tp.lua
&lt;LDIR&gt;/socket/ftp.lua
&lt;LDIR&gt;/socket/smtp.lua
&lt;LDIR&gt;/socket/url.lua
&lt;LDIR&gt;/mime.lua
&lt;CDIR&gt;/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.2.2  Copyright (C) 1994-2013 Lua.org, PUC-Rio
&gt; socket = require("socket")
&gt; print(socket._VERSION)
--&gt; LuaSocket 3.1.0
</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.2.2  Copyright (C) 1994-2013 Lua.org, PUC-Rio
&gt; http = require("socket.http")
&gt; print(http.request("http://www.impa.br/~diego/software/luasocket"))
--&gt; homepage gets dumped to terminal
</pre>

<!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

<div class=footer>
<hr>
<center>
<p class=bar>
<a href="index.html">home</a> &middot;
<a href="index.html#down">download</a> &middot;
<a href="installation.html">installation</a> &middot;
<a href="introduction.html">introduction</a> &middot;
<a href="reference.html">reference</a>
</p>
<p>
<small>
Last modified by Diego Nehab on <br>
Tue Jun 11 19:06:14 HKT 2013
</small>
</p>
</center>
</div>

</body>
</html>
style(docs): Trim trailing whitespace in HTML docs Many editors remove these automatically anyway which makes opening and editng the docs cause a bunch of noise. This is just to get the noise out of the way in a style commit so it doesn't leak into other PRs 2023-11-11 06:07:36 +01:00			`<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`"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,`
style(docs): Trim trailing whitespace in HTML docs Many editors remove these automatically anyway which makes opening and editng the docs cause a bunch of noise. This is just to get the noise out of the way in a style commit so it doesn't leak into other PRs 2023-11-11 06:07:36 +01:00			`Installation">`
Spell checked the manual. 2004-12-13 07:26:01 +01:00			`<title>LuaSocket: Installation</title>`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`<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>`
Decent makefiles! 2009-05-27 11:31:38 +02:00			`<a href="index.html">home</a> ·`
			`<a href="index.html#download">download</a> ·`
Spell checked the manual. 2004-12-13 07:26:01 +01:00			`<a href="installation.html">installation</a> ·`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`<a href="introduction.html">introduction</a> ·`
style(docs): Trim trailing whitespace in HTML docs Many editors remove these automatically anyway which makes opening and editng the docs cause a bunch of noise. This is just to get the noise out of the way in a style commit so it doesn't leak into other PRs 2023-11-11 06:07:36 +01:00			`<a href="reference.html">reference</a>`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`</p>`
			`</center>`
			`<hr>`
			`</div>`

Spell checked the manual. 2004-12-13 07:26:01 +01:00			`<!-- installation ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00
Spell checking on the manuals. David's changes to lp.lua. 2005-11-21 08:04:44 +01:00			`<h2>Installation</h2>`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00
First stab at documenation Update Lua and Luasocket version in samples and in documentation Documented ipv5_v6only default option being set Documented tcp6 and udp6 Documented dns.getaddrinfo Documented zero-sized datagram change? Documented getoption 2012-04-16 19:15:26 +02:00			`<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>`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00
			`<h3>Directory structure</h3>`

Almost ready to release. 2005-09-29 08:11:42 +02:00			`<p> On Unix systems, the standard distribution uses two base`
			`directories, one for system dependent files, and another for system`
style(docs): Trim trailing whitespace in HTML docs Many editors remove these automatically anyway which makes opening and editng the docs cause a bunch of noise. This is just to get the noise out of the way in a style commit so it doesn't leak into other PRs 2023-11-11 06:07:36 +01:00			`independent files. Let's call these directories <tt><CDIR></tt>`
			`and <tt><LDIR></tt>, respectively.`
First stab at documenation Update Lua and Luasocket version in samples and in documentation Documented ipv5_v6only default option being set Documented tcp6 and udp6 Documented dns.getaddrinfo Documented zero-sized datagram change? Documented getoption 2012-04-16 19:15:26 +02:00			`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`
style(docs): Trim trailing whitespace in HTML docs Many editors remove these automatically anyway which makes opening and editng the docs cause a bunch of noise. This is just to get the noise out of the way in a style commit so it doesn't leak into other PRs 2023-11-11 06:07:36 +01:00			`settings can be overridden by environment variables`
First stab at documenation Update Lua and Luasocket version in samples and in documentation Documented ipv5_v6only default option being set Documented tcp6 and udp6 Documented dns.getaddrinfo Documented zero-sized datagram change? Documented getoption 2012-04-16 19:15:26 +02:00			`<tt>LUA_PATH</tt> and <tt>LUA_CPATH</tt>. See the Lua`
style(docs): Trim trailing whitespace in HTML docs Many editors remove these automatically anyway which makes opening and editng the docs cause a bunch of noise. This is just to get the noise out of the way in a style commit so it doesn't leak into other PRs 2023-11-11 06:07:36 +01:00			`documentation for details.) Here is the standard LuaSocket`
Almost ready to release. 2005-09-29 08:11:42 +02:00			`distribution directory structure:</p>`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00
			`<pre class=example>`
Changed LIB/SHARE to CDIR/LDIR. 2005-11-22 21:51:28 +01:00			`<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`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`</pre>`

Final push for release... 2005-08-12 07:56:32 +02:00			`<p> Naturally, on Unix systems, <tt>core.dll</tt>`
style(docs): Trim trailing whitespace in HTML docs Many editors remove these automatically anyway which makes opening and editng the docs cause a bunch of noise. This is just to get the noise out of the way in a style commit so it doesn't leak into other PRs 2023-11-11 06:07:36 +01:00			`would be replaced by <tt>core.so</tt>.`
Bugs sent by David. 2005-10-05 05:16:17 +02:00			`</p>`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00
			`<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>`
Changing from 2.1-rc1 to 3.0-rc1. 2013-06-11 13:10:03 +02:00			`Lua 5.2.2 Copyright (C) 1994-2013 Lua.org, PUC-Rio`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`> socket = require("socket")`
Almost ready to release. 2005-09-29 08:11:42 +02:00			`> print(socket._VERSION)`
chore(core): Update version markers to last released version Closes #401 2023-11-10 22:47:54 +01:00			`--> LuaSocket 3.1.0`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`</pre>`

			`<p> Each module loads their dependencies automatically, so you only need to`
Spell checking on the manuals. David's changes to lp.lua. 2005-11-21 08:04:44 +01:00			`load the modules you directly depend upon: </p>`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00
			`<pre class=example>`
Changing from 2.1-rc1 to 3.0-rc1. 2013-06-11 13:10:03 +02:00			`Lua 5.2.2 Copyright (C) 1994-2013 Lua.org, PUC-Rio`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`> http = require("socket.http")`
First stab at documenation Update Lua and Luasocket version in samples and in documentation Documented ipv5_v6only default option being set Documented tcp6 and udp6 Documented dns.getaddrinfo Documented zero-sized datagram change? Documented getoption 2012-04-16 19:15:26 +02:00			`> print(http.request("http://www.impa.br/~diego/software/luasocket"))`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`--> homepage gets dumped to terminal`
			`</pre>`

			`<!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->`

			`<div class=footer>`
			`<hr>`
			`<center>`
			`<p class=bar>`
Decent makefiles! 2009-05-27 11:31:38 +02:00			`<a href="index.html">home</a> ·`
			`<a href="index.html#down">download</a> ·`
Spell checked the manual. 2004-12-13 07:26:01 +01:00			`<a href="installation.html">installation</a> ·`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`<a href="introduction.html">introduction</a> ·`
			`<a href="reference.html">reference</a>`
			`</p>`
			`<p>`
			`<small>`
			`Last modified by Diego Nehab on <br>`
Changing from 2.1-rc1 to 3.0-rc1. 2013-06-11 13:10:03 +02:00			`Tue Jun 11 19:06:14 HKT 2013`
Added new instalation section to the manual. 2004-11-28 09:17:16 +01:00			`</small>`
			`</p>`
			`</center>`
			`</div>`

			`</body>`
			`</html>`