diff options
| -rwxr-xr-x | lualdap/doc/us/index.html | 8 | ||||
| -rwxr-xr-x | lualdap/doc/us/manual.html | 123 |
2 files changed, 73 insertions, 58 deletions
diff --git a/lualdap/doc/us/index.html b/lualdap/doc/us/index.html index cf89ba6..5d46b83 100755 --- a/lualdap/doc/us/index.html +++ b/lualdap/doc/us/index.html @@ -70,7 +70,7 @@ to:</p> <h2><a name="status"></a>Status</h2> -<p>Current version is 1.0 beta. It was developed for Lua 5.0 and +<p>Current version is 1.0. It was developed for Lua 5.0 and OpenLDAP 2.1.</p> <p>Version 1.0 follows the <a href= @@ -81,7 +81,7 @@ details).</p> <h2><a name="download"></a>Download</h2> <p>LuaLDAP can be downloaded in source code from the -<a href="http://luaforge.net/frs/?group_id=14">LuaForge</a> +<a href="http://luaforge.net/projects/lualdap/files">LuaForge</a> page.</p> <p>LuaLDAP <a href="http://luaforge.net/scm/?group_id=14">CVS</a> @@ -90,7 +90,7 @@ can also be accessed at LuaForge</p> <h2><a name="history"></a>History</h2> <ul> - <li>[?/Apr/2005] Version 1.0 Beta released</li> + <li>[23/May/2005] Version 1.0 released</li> <li>[10/Dec/2003] Version 1.0 Alpha released</li> </ul> @@ -119,7 +119,7 @@ Comments are welcome!</p> <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.22 2005-03-31 00:59:55 carregal Exp $ + $Id: index.html,v 1.23 2005-05-23 14:41:51 tuler Exp $ </small></p> </div> <!-- id="about" --> diff --git a/lualdap/doc/us/manual.html b/lualdap/doc/us/manual.html index 4560acc..5f0ef33 100755 --- a/lualdap/doc/us/manual.html +++ b/lualdap/doc/us/manual.html @@ -127,10 +127,10 @@ section <a href="#related_docs">Related documentation</a>.</p> <p>LuaLDAP provides a single way to connect to an LDAP server:</p> -<ul> - <li><strong><code>lualdap.open_simple (hostname, who, password, - usetls)</code></strong><br /> - Initializes a session with an LDAP server. This function requires a +<dl> + <dt><strong><code>lualdap.open_simple (hostname, who, password, + usetls)</code></strong></dt> + <dd>Initializes a session with an LDAP server. This function requires a hostname, accordingly to <a href="#related_docs">the C LDAP API</a> definition (<em>"hostname contains a space-separated list of hostnames or dotted strings representing the IP address of hosts @@ -141,10 +141,10 @@ section <a href="#related_docs">Related documentation</a>.</p> password to be checked against the third argument, <code>password</code>. The optional argument <code>usetls</code> is a Boolean flag indicating if Transport Layer Security (TLS) should be - used.<br /> + used.<br/> Returns a connection object or <code>nil</code> followed by an error - string.</li> -</ul> + string.</dd> +</dl> <h2><a name="connection"></a>Connection objects</h2> @@ -173,24 +173,25 @@ message provided by the OpenLDAP client.</p> <h4>Methods</h4> -<ul> - <li><strong><code>conn:add (distinguished_name, - table_of_attributes)</code></strong><br /> - Adds a new entry to the directory with the given attributes and - values. <a name="conn_close"></a> - </li> - <li><strong><code>conn:close()</code></strong><br /> - Closes the connection <code>conn</code>. - </li> - <li><strong><code>conn:compare (distinguished_name, attribute, - value)</code></strong><br /> - Compares a value against an entry.</li> - <li><strong><code>conn:delete (distinguished_name)</code></strong><br /> - Deletes an entry from the directory. - </li> - <li><strong><code>conn:modify (distinguished_name, - table_of_operations*)</code></strong><br /> - Changes values of attributes in the given entry. The tables of +<dl> + <dt><strong><code>conn:add (distinguished_name, + table_of_attributes)</code></strong></dt> + <dd>Adds a new entry to the directory with the given attributes and + values. <a name="conn_close"></a></dd> + + <dt><strong><code>conn:close()</code></strong></dt> + <dd>Closes the connection <code>conn</code>.</dd> + + <dt><strong><code>conn:compare (distinguished_name, attribute, + value)</code></strong></dt> + <dd>Compares a value against 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 with the value on index <code>1</code> indicating the operation to be performed. The valid operations are: @@ -200,42 +201,56 @@ message provided by the OpenLDAP client.</p> <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. - </li> - <li><strong><code>conn:rename (distinguished_name, new_relative_dn, - new_parent)</code></strong><br /> - Changes entry names (i.e. change its <a href="#dn">distinguished - name</a>). - </li> - <li><strong><code>conn:search (table_of_search_parameters)</code></strong><br /> - Performs a search operation on the directory. The parameters are - described below: - <ul> - <li><strong><code>attrs</code></strong>: a string or a list of attribute names to - be retrieved (default is to retrieve all attributes).</li> - <li><strong><code>attrsonly</code></strong>: a Boolean value that must be either + to perform 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> + + <dt><strong><code>conn:search (table_of_search_parameters)</code></strong></dt> + <dd>Performs a search operation on the directory. The parameters are + described below:<br/><br/> + <dl> + <dt><strong><code>attrs</code></strong></dt> + <dd>a string or a list of attribute names to + be retrieved (default is to retrieve all attributes).</dd> + + <dt><strong><code>attrsonly</code></strong></dt> + <dd>a Boolean value that must be either <em>false</em> (default) if both attribute names and values are to be - retrieved, or <em>true</em> if only names are wanted.</li> - <li><strong><code>base</code></strong>: The <a href="#dn">distinguished name</a> - of the entry at which to start the search.</li> - <li><strong><code>filter</code></strong>: A string representing the search filter + retrieved, or <em>true</em> if only names are wanted.</dd> + + <dt><strong><code>base</code></strong></dt> + <dd>The <a href="#dn">distinguished name</a> + of the entry at which to start the search.</d> + + <dt><strong><code>filter</code></strong></dt> + <dd>A string representing the search filter as described in <a href="http://www.ietf.org/rfc/rfc2254.txt">The - String Representation of LDAP Search Filters (RFC 2254)</a>.</li> - <li><strong><code>scope</code></strong>: A string indicating the scope of the + String Representation of LDAP Search Filters (RFC 2254)</a>.</dd> + + <dt><strong><code>scope</code></strong></dt> + <dd>A string indicating the scope of the search. The valid strings are: "base", "onelevel" and "subtree". The empty string ("") and <code>nil</code> will be treated as the - default scope.</li> - <li><strong><code>sizelimit</code></strong>: The maximum number of entries to - return (default is no limit).</li> - <li><strong><code>timeout</code></strong>: The timeout in seconds (default is no - timeout). The precision is microseconds.</li> - </ul> + default scope.</dd> + + <dt><strong><code>sizelimit</code></strong></dt> + <dd>The maximum number of entries to + return (default is no limit).</dd> + + <dt><strong><code>timeout</code></strong></dt> + <dd>The timeout in seconds (default is no + timeout). The precision is microseconds.</dd> + </dl> + <br/> The search method will return a <em>search iterator</em> which is a function that requires no arguments. The search iterator is used to get the search result and will return a string representing the <a href="#dn">distinguished name</a> and a <a href="#attributes">table - of attributes</a> as returned by the search request.</li> -</ul> + of attributes</a> as returned by the search request.</dd> +</dl> <h2><a name="examples"></a>Example</h2> @@ -307,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.20 2005-03-31 17:45:51 carregal Exp $ + $Id: manual.html,v 1.21 2005-05-23 14:41:51 tuler Exp $ </small></p> </div> <!-- id="about" --> |