From 4e5ad6d5ee9e72ddf6550a6795c18039b265e501 Mon Sep 17 00:00:00 2001 From: Diego Nehab Date: Mon, 29 Nov 2004 06:55:47 +0000 Subject: Bug in poll. Debug garbage in compat-5.1.c. Improvements to the user manual. --- doc/installation.html | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) (limited to 'doc/installation.html') 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">

Instalation

-

LuaSocket 2.0 uses the new package proposal for Lua 5.1, throught the -compatibility module -Compat-5.1 released in conjunction with Roberto Ierusalimschy and The Kepler project. The proposal -was considered important enough by the community to justify early adoption. -All Lua library developers are encouraged to change their libraries in -preparation for the release of Lua 5.1.

+

LuaSocket 2.0 uses the new package proposal for Lua 5.1. +All Lua library developers are encouraged to update their libraries so that +all libraries can coexist peacefully and users can benefit from the +standardization and flexibility of the standard. +

+ +

+The proposal was considered important enough by some of us to justify +early adoption, even before release of Lua 5.1. +Thus, a compability module +compat-5.1 +has been released in conjunction with Roberto Ierusalimschy and The Kepler Project team. +It implements the Lua 5.1 package proposal on top of Lua 5.0.

As far as LuaSocket is concerned, this means that whoever is -deploying a solution that uses LuaSocket has a lot of freedom. Here we -describe only the standard distribution. If the standard doesn't meet your -needs, we refer you to the Lua discussion list, where any quesetion about -the package scheme will likely be answered promptly. +deploying a non-standard distribution of LuaSocket will probably +have no problems customizing it. Here we will only 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.

Directory structure

-

The new package scheme has a root directory for the libraries installed +

The standard distribution reserves a directory to be the root of +the libraries installed on a given system. Let's call this directory <ROOT>. On my system, this is the /usr/local/share/lua/5.0 directory. Here is the standard LuaSocket distribution directory structure:

@@ -82,7 +90,7 @@ X, they would be replaced by lsocket.dylib and

In order for the interpreter to find all LuaSocket components, three environment variables need to be set. The first environment variable tells -the interpreter to load the compat-5.1.lua module.

+the interpreter to load the compat-5.1.lua module at startup:

 LUA_INIT=@<ROOT>/compat-5.1.lua
@@ -98,7 +106,7 @@ LUA_CPATH=<ROOT>/?.dll;?.dll
 

Again, naturally, in Unix the shared library extension would be -.so instead of .dll and on Mac OS X they would be +.so instead of .dll and on Mac OS X it would be .dylib

Using LuaSocket

@@ -115,7 +123,7 @@ Lua 5.0.2 Copyright (C) 1994-2004 Tecgraf, PUC-Rio

Each module loads their dependencies automatically, so you only need to -load the modues you are directly dependent upon.

+load the modues you directly depend upon:

 Lua 5.0.2  Copyright (C) 1994-2004 Tecgraf, PUC-Rio
-- 
cgit v1.2.3-55-g6feb