From 0622bd222401d7a1a0c0aab67e59cfaab0533781 Mon Sep 17 00:00:00 2001
From: Danilo Tuler
Date: Mon, 23 May 2005 14:41:51 +0000
Subject: *** empty log message ***
---
lualdap/doc/us/index.html | 8 +--
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:
Status
-Current version is 1.0 beta. It was developed for Lua 5.0 and
+
Current version is 1.0. It was developed for Lua 5.0 and
OpenLDAP 2.1.
Version 1.0 follows the
Download
LuaLDAP can be downloaded in source code from the
-LuaForge
+LuaForge
page.
LuaLDAP CVS
@@ -90,7 +90,7 @@ can also be accessed at LuaForge
History
- - [?/Apr/2005] Version 1.0 Beta released
+ - [23/May/2005] Version 1.0 released
- [10/Dec/2003] Version 1.0 Alpha released
@@ -119,7 +119,7 @@ Comments are welcome!
- $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 $
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 Related documentation.
LuaLDAP provides a single way to connect to an LDAP server:
-
- lualdap.open_simple (hostname, who, password,
- usetls)
- Initializes a session with an LDAP server. This function requires a
+
+ lualdap.open_simple (hostname, who, password,
+ usetls)
+ - Initializes a session with an LDAP server. This function requires a
hostname, accordingly to the C LDAP API
definition ("hostname contains a space-separated list of
hostnames or dotted strings representing the IP address of hosts
@@ -141,10 +141,10 @@ section Related documentation.
password to be checked against the third argument,
password
. The optional argument usetls
is a
Boolean flag indicating if Transport Layer Security (TLS) should be
- used.
+ used.
Returns a connection object or nil
followed by an error
- string.
-
+ string.
+
Connection objects
@@ -173,24 +173,25 @@ message provided by the OpenLDAP client.
Methods
-
- conn:add (distinguished_name,
- table_of_attributes)
- Adds a new entry to the directory with the given attributes and
- values.
-
- conn:close()
- Closes the connection conn
.
-
- conn:compare (distinguished_name, attribute,
- value)
- Compares a value against an entry.
- conn:delete (distinguished_name)
- Deletes an entry from the directory.
-
- conn:modify (distinguished_name,
- table_of_operations*)
- Changes values of attributes in the given entry. The tables of
+
+ conn:add (distinguished_name,
+ table_of_attributes)
+ - Adds a new entry to the directory with the given attributes and
+ values.
+
+ conn:close()
+ - Closes the connection
conn
.
+
+ conn:compare (distinguished_name, attribute,
+ value)
+ - Compares a value against an entry.
+
+ conn:delete (distinguished_name)
+ - Deletes an entry from the directory.
+
+ conn:modify (distinguished_name,
+ table_of_operations*)
+ - Changes values of attributes in the given entry. The tables of
operations are table of attributes but
with the value on index
1
indicating the operation to be
performed. The valid operations are:
@@ -200,42 +201,56 @@ message provided by the OpenLDAP client.
'='
to replace the values of the attributes
All tables of operations given as arguments will be joined together
- to perform a single LDAP modify operation.
-
- conn:rename (distinguished_name, new_relative_dn,
- new_parent)
- Changes entry names (i.e. change its distinguished
- name).
-
- conn:search (table_of_search_parameters)
- Performs a search operation on the directory. The parameters are
- described below:
-
- attrs
: a string or a list of attribute names to
- be retrieved (default is to retrieve all attributes).
- attrsonly
: a Boolean value that must be either
+ to perform a single LDAP modify operation.
+
+ conn:rename (distinguished_name, new_relative_dn,
+ new_parent)
+ - Changes entry names (i.e. change its distinguished
+ name).
+
+ conn:search (table_of_search_parameters)
+ - Performs a search operation on the directory. The parameters are
+ described below:
+
+ attrs
+ - a string or a list of attribute names to
+ be retrieved (default is to retrieve all attributes).
+
+ attrsonly
+ - a Boolean value that must be either
false (default) if both attribute names and values are to be
- retrieved, or true if only names are wanted.
- base
: The distinguished name
- of the entry at which to start the search.
- filter
: A string representing the search filter
+ retrieved, or true if only names are wanted.
+
+ base
+ - The distinguished name
+ of the entry at which to start the search.
+
+
filter
+ - A string representing the search filter
as described in The
- String Representation of LDAP Search Filters (RFC 2254).
- scope
: A string indicating the scope of the
+ String Representation of LDAP Search Filters (RFC 2254).
+
+ scope
+ - A string indicating the scope of the
search. The valid strings are: "base", "onelevel" and "subtree".
The empty string ("") and
nil
will be treated as the
- default scope.
- sizelimit
: The maximum number of entries to
- return (default is no limit).
- timeout
: The timeout in seconds (default is no
- timeout). The precision is microseconds.
-
+ default scope.
+
+ sizelimit
+ The maximum number of entries to
+ return (default is no limit).
+
+ timeout
+ The timeout in seconds (default is no
+ timeout). The precision is microseconds.
+
+
The search method will return a search iterator 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 distinguished name and a table
- of attributes as returned by the search request.
-
+ of attributes as returned by the search request.
+
Example
@@ -307,7 +322,7 @@ ld:delete ("mydn=newuser,ou=people,dc=ldp,dc=world")()
- $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 $
--
cgit v1.2.3-59-g8ed1b