diff options
author | Andre Carregal <carregal@luaforge.net> | 2006-03-25 15:51:04 +0000 |
---|---|---|
committer | Andre Carregal <carregal@luaforge.net> | 2006-03-25 15:51:04 +0000 |
commit | 31fa9d1491199776270611d736658a5e49857a64 (patch) | |
tree | b76b5e539362a9165beade0f4d2ed0a22b0df7bc /lualdap/doc | |
parent | Documentation update - minor details (diff) | |
download | lualdap-31fa9d1491199776270611d736658a5e49857a64.tar.xz lualdap-31fa9d1491199776270611d736658a5e49857a64.zip |
Documentation update - minor details
Diffstat (limited to '')
-rwxr-xr-x | lualdap/doc/us/index.html | 12 | ||||
-rwxr-xr-x | lualdap/doc/us/license.html | 9 | ||||
-rwxr-xr-x | lualdap/doc/us/manual.html | 81 |
3 files changed, 47 insertions, 55 deletions
diff --git a/lualdap/doc/us/index.html b/lualdap/doc/us/index.html index f1c7626..9795595 100755 --- a/lualdap/doc/us/index.html +++ b/lualdap/doc/us/index.html @@ -91,7 +91,7 @@ LuaForge page.</p> <h2><a name="history"></a>History</h2> <ul> - <li>[22/Mar/2006] Version 1.0.1 released</li> + <li>[28/Mar/2006] Version 1.0.1 released</li> <li>[10/Jun/2005] Version 1.0 released</li> <li>[10/Dec/2003] Version 1.0 alpha released</li> </ul> @@ -113,15 +113,17 @@ FINEP.</p> "mailto:info-NO-SPAM-THANKS@keplerproject.org">contact us</a>. Comments are welcome!</p> +<p>You can also reach other Kepler developers and users on the Kepler Project +<a href="http://luaforge.net/mail/?group_id=104">mailing list</a>.</p> + </div> <!-- id="content" --> </div> <!-- id="main" --> <div id="about"> - <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> - <p><small> - $Id: index.html,v 1.29 2006-03-22 17:12:16 carregal Exp $ - </small></p> + <p><a href="http://validator.w3.org/check?uri=referer"> + <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> + <p><small>$Id: index.html,v 1.30 2006-03-25 15:51:04 carregal Exp $</small></p> </div> <!-- id="about" --> </div> <!-- id="container" --> diff --git a/lualdap/doc/us/license.html b/lualdap/doc/us/license.html index 58f4239..aff292f 100755 --- a/lualdap/doc/us/license.html +++ b/lualdap/doc/us/license.html @@ -77,7 +77,7 @@ The implementation is not derived from licensed software.</p> <!-- ===================================================================== --> <hr /> -Copyright © 2003-2005 The Kepler Project. +Copyright © 2003-2006 The Kepler Project. <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation @@ -104,10 +104,9 @@ SOFTWARE.</p> </div> <!-- id="main" --> <div id="about"> - <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> - <p><small> - $Id: license.html,v 1.7 2005-05-23 18:27:11 carregal Exp $ - </small></p> + <p><a href="http://validator.w3.org/check?uri=referer"> + <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> + <p><small>$Id: license.html,v 1.8 2006-03-25 15:51:04 carregal Exp $</small></p> </div> <!-- id="about" --> </div> <!-- id="container" --> diff --git a/lualdap/doc/us/manual.html b/lualdap/doc/us/manual.html index 2bff17c..d4bcadc 100755 --- a/lualdap/doc/us/manual.html +++ b/lualdap/doc/us/manual.html @@ -54,9 +54,9 @@ <h2><a name="introduction"></a>Introduction</h2> -<p>LuaLDAP is a simple interface from Lua to an LDAP client (in +<p>LuaLDAP is a simple interface from Lua to an LDAP client, in fact it is a bind to <a href="http://www.openldap.org">OpenLDAP</a> -client).</p> +client.</p> <p>LuaLDAP defines one single global variable: a table called <code>lualdap</code>. This table holds the functions used to create an @@ -70,17 +70,12 @@ tables; attributes are its fields. The attribute values can be strings or tables of strings (used to represent multiple values).</p> -<p>LuaLDAP is a bind to the <a href= -"http://www.openldap.org">OpenLDAP</a> library, therefore it +<p>LuaLDAP is a bind to the +<a href="http://www.openldap.org">OpenLDAP</a> library and it depends on a previous installation of this library. You can -download OpenLDAP from the OpenLDAP <a href= -"http://www.openldap.org/software/download">download -page</a>.</p> - -<p>LuaLDAP source consists in a single C source file. -The distribution provides a <code>Makefile</code> prepared to -compile the library and install it. The file <code>config</code> should -be edited to suit the needs of the aimed platform.</p> +download OpenLDAP from the +<a href="http://www.openldap.org/software/download">OpenLDAP download</a> +page.</p> <h2><a name="installation"></a>Installation</h2> @@ -89,10 +84,10 @@ be edited to suit the needs of the aimed platform.</p> for Lua 5.1, therefore it should be "installed". Refer to <a href="http://www.keplerproject.org/compat/manual.html#configuration"> Compat-5.1 configuration</a> section about how to install the compiled -binary properly. -The compiled binary should be copied to a directory in your LUA_CPATH.</p> +binary properly. The compiled binary should be copied to a directory in your +<code>LUA_CPATH</code>.</p> -<p>Windows users can use the pre-compiled versions of LuaLDAP +<p>Windows users can use the binary versions of LuaLDAP (<code>lualdap.dll</code>) and OpenLDAP (<code>libsasl.dll</code>) available at <a href="http://luaforge.net/projects/lualdap/files">LuaForge</a>.</p> @@ -100,14 +95,12 @@ The compiled binary should be copied to a directory in your LUA_CPATH.</p> <h2><a name="attributes"></a>Representing attributes</h2> <p>Many LDAP operations manage sets of attributes and values. -LuaLDAP provides a uniform way of representing them: using Lua -tables. A table of attributes is indexed by the name of the -attribute and its value can be a string (be careful: it can also be -a "binary string") or a list/table of values indexed by numbers -from 1 to <em>n</em>. Some operations have different approaches -that will be explained when necessary.</p> +LuaLDAP provides a uniform way of representing them by using Lua +tables. The table attributes can be Lua string, a binary string (a string of +bits), or table of <em>n</em> values indexed from 1 to <em>n</em>. +Some operations have different approaches that will be explained as necessary.</p> -<p>Follows a small example:</p> +<p>Here is a simple example:</p> <pre class="example"> entry = { @@ -119,7 +112,7 @@ entry = { } </pre> -Attribute names cannot contain zeroes (<code>'\0'</code>) +Attribute names cannot contain the <code>'\0'</code> character. <h2><a name="dn"></a>Distinguished names</h2> @@ -131,7 +124,7 @@ to represent the DN of any entry.</p> <p>A more precise definition can be found on the LDAP documentation. A list of some of these files can be found in -section <a href="#related_docs">Related documentation</a>.</p> +<a href="#related_docs">Related documentation</a> section.</p> <h2><a name="initialization"></a>Initialization functions</h2> @@ -152,29 +145,29 @@ section <a href="#related_docs">Related documentation</a>.</p> <code>password</code>. The optional argument <code>usetls</code> is a Boolean flag indicating if Transport Layer Security (TLS) should be used.<br/> - Returns a connection object or <code>nil</code> followed by an error - string.</dd> + Returns a connection object if the operation was successful. In case of + error it returns <code>nil</code> followed by an error string.</dd> </dl> <h2><a name="connection"></a>Connection objects</h2> <p>A connection object offers methods which implement LDAP -operations. Almost all of them need a <a href="#dn">distinguished -name</a> to identify the entry on which the operation will be -executed.</p> +operations. Almost all of them need a +<a href="#dn">distinguished name</a> to identify the entry on which the +operation will be executed.</p> <p>These methods execute asynchronous operations and return a -function that should be called to obtain the result(s). These -functions will return <code>true</code> indicating success of the -operation; the only exception is the function <code>compare</code> +function that should be called to obtain the results. The called +functions will return <code>true</code> indicating the success of the +operation. The only exception is the <code>compare</code> function which can return either <code>true</code> or <code>false</code> -(which is the result of the comparison) on a successful operation.</p> +(as the result of the comparison) on a successful operation.</p> <p>There are two types of errors: <em>API errors</em>, such as wrong parameters, absent connection etc.; and <em>LDAP errors</em>, -such as mal-formed DN, unknown attribute etc. API errors will raise +such as malformed DN, unknown attribute etc. API errors will raise a Lua error, while LDAP errors will be reported by the -function/method returning <code>nil</code> followed by the error +function/method returning <code>nil</code> plus the error message provided by the OpenLDAP client.</p> <p>A connection object can be created by calling the <a href= @@ -193,15 +186,15 @@ message provided by the OpenLDAP client.</p> <dt><strong><code>conn:compare (distinguished_name, attribute, value)</code></strong></dt> - <dd>Compares a value against an entry.</dd> + <dd>Compares a value to an entry.</dd> <dt><strong><code>conn:delete (distinguished_name)</code></strong></dt> <dd>Deletes an entry from the directory.</dd> <dt><strong><code>conn:modify (distinguished_name, table_of_operations*)</code></strong></dt> - <dd>Changes values of attributes in the given entry. The tables of - operations are <a href="#attributes">table of attributes</a> but + <dd>Changes the values of attributes in the given entry. The tables of + operations are <a href="#attributes">tables of attributes</a> with the value on index <code>1</code> indicating the operation to be performed. The valid operations are: <ul> @@ -209,13 +202,12 @@ message provided by the OpenLDAP client.</p> <li><strong><code>'-'</code></strong> to delete the values of the attributes</li> <li><strong><code>'='</code></strong> to replace the values of the attributes</li> </ul> - All tables of operations given as arguments will be joined together - to perform a single LDAP modify operation.</dd> + Any number of tables of operations will be used in a single LDAP modify + operation.</dd> <dt><strong><code>conn:rename (distinguished_name, new_relative_dn, new_parent)</code></strong></dt> - <dd>Changes entry names (i.e. change its <a href="#dn">distinguished - name</a>).</dd> + <dd>Changes an entry name (i.e. change its <a href="#dn">distinguished name</a>).</dd> <dt><strong><code>conn:search (table_of_search_parameters)</code></strong></dt> <dd>Performs a search operation on the directory. The parameters are @@ -263,8 +255,7 @@ message provided by the OpenLDAP client.</p> <h2><a name="examples"></a>Example</h2> -<p>Below is a small sample code displaying the basic use of the -library.</p> +<p>here is a some sample code that demonstrate the basic use of the library.</p> <pre class="example"> require "lualdap" @@ -331,7 +322,7 @@ ld:delete ("mydn=newuser,ou=people,dc=ldp,dc=world")() <div id="about"> <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> <p><small> - $Id: manual.html,v 1.28 2006-03-22 17:12:16 carregal Exp $ + $Id: manual.html,v 1.29 2006-03-25 15:51:04 carregal Exp $ </small></p> </div> <!-- id="about" --> |