aboutsummaryrefslogtreecommitdiff
path: root/doc/installation.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/installation.html')
-rw-r--r--doc/installation.html38
1 files changed, 23 insertions, 15 deletions
diff --git a/doc/installation.html b/doc/installation.html
index 97888c6..63a555c 100644
--- a/doc/installation.html
+++ b/doc/installation.html
@@ -39,24 +39,32 @@ Installation">
39 39
40<h2>Instalation</h2> 40<h2>Instalation</h2>
41 41
42<p> LuaSocket 2.0 uses the new package proposal for Lua 5.1, throught the 42<p> LuaSocket 2.0 uses the new package proposal for Lua 5.1.
43compatibility module <a href=http://www.keplerproject.org/compat/> 43All Lua library developers are encouraged to update their libraries so that
44Compat-5.1</a> released in conjunction with Roberto Ierusalimschy and <a 44all libraries can coexist peacefully and users can benefit from the
45href=http://www.keplerproject.org/">The Kepler project</a>. The proposal 45standardization and flexibility of the standard.
46was considered important enough by the community to justify early adoption. 46</p>
47All Lua library developers are encouraged to change their libraries in 47
48preparation for the release of Lua 5.1. </p> 48<p>
49The proposal was considered important enough by some of us to justify
50early adoption, even before release of Lua 5.1.
51Thus, a compability module
52<a href=http://www.keplerproject.org/compat/>compat-5.1</a>
53has been released in conjunction with Roberto Ierusalimschy and <a
54href=http://www.keplerproject.org/">The Kepler Project</a> team.
55It implements the Lua 5.1 package proposal on top of Lua 5.0. </p>
49 56
50<p> As far as LuaSocket is concerned, this means that whoever is 57<p> As far as LuaSocket is concerned, this means that whoever is
51deploying a solution that uses LuaSocket has a lot of freedom. Here we 58deploying a non-standard distribution of LuaSocket will probably
52describe only the standard distribution. If the standard doesn't meet your 59have no problems customizing it. Here we will only describe the standard distribution. If the standard doesn't meet your
53needs, we refer you to the Lua discussion list, where any quesetion about 60needs, we refer you to the Lua discussion list, where any question about
54the package scheme will likely be answered promptly. 61the package scheme will likely already have been answered.
55</p> 62</p>
56 63
57<h3>Directory structure</h3> 64<h3>Directory structure</h3>
58 65
59<p> The new package scheme has a root directory for the libraries installed 66<p> The standard distribution reserves a directory to be the root of
67the libraries installed
60on a given system. Let's call this directory <tt>&lt;ROOT&gt;</tt>. 68on a given system. Let's call this directory <tt>&lt;ROOT&gt;</tt>.
61On my system, this is the <tt>/usr/local/share/lua/5.0</tt> directory. 69On my system, this is the <tt>/usr/local/share/lua/5.0</tt> directory.
62Here is the standard LuaSocket distribution directory structure:</p> 70Here is the standard LuaSocket distribution directory structure:</p>
@@ -82,7 +90,7 @@ X, they would be replaced by <tt>lsocket.dylib</tt> and
82 90
83<p> In order for the interpreter to find all LuaSocket components, three 91<p> In order for the interpreter to find all LuaSocket components, three
84environment variables need to be set. The first environment variable tells 92environment variables need to be set. The first environment variable tells
85the interpreter to load the <tt>compat-5.1.lua</tt> module. </p> 93the interpreter to load the <tt>compat-5.1.lua</tt> module at startup: </p>
86 94
87<pre class=example> 95<pre class=example>
88LUA_INIT=@&lt;ROOT&gt;/compat-5.1.lua 96LUA_INIT=@&lt;ROOT&gt;/compat-5.1.lua
@@ -98,7 +106,7 @@ LUA_CPATH=&lt;ROOT&gt;/?.dll;?.dll
98</pre> 106</pre>
99 107
100<p> Again, naturally, in Unix the shared library extension would be 108<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 109<tt>.so</tt> instead of <tt>.dll</tt> and on Mac OS X it would be
102<tt>.dylib</tt></p> 110<tt>.dylib</tt></p>
103 111
104<h3>Using LuaSocket</h3> 112<h3>Using LuaSocket</h3>
@@ -115,7 +123,7 @@ Lua 5.0.2 Copyright (C) 1994-2004 Tecgraf, PUC-Rio
115</pre> 123</pre>
116 124
117<p> Each module loads their dependencies automatically, so you only need to 125<p> Each module loads their dependencies automatically, so you only need to
118load the modues you are directly dependent upon. <p> 126load the modues you directly depend upon: <p>
119 127
120<pre class=example> 128<pre class=example>
121Lua 5.0.2 Copyright (C) 1994-2004 Tecgraf, PUC-Rio 129Lua 5.0.2 Copyright (C) 1994-2004 Tecgraf, PUC-Rio