# HG changeset patch
# User rdhoelz@gmail.com
# Date 1354706599 0
# Node ID 03633ab9afb6320b0c0ed634fe3039fcc9216578
# Parent  2c18ba3f99d9e07a88868415f12f818de6cc1d27
Created wiki page through web user interface.

diff -r 2c18ba3f99d9 -r 03633ab9afb6 mod_lib_ldap.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_lib_ldap.wiki	Wed Dec 05 11:23:19 2012 +0000
@@ -0,0 +1,29 @@
+#summary Library module for LDAP
+
+= Introduction =
+
+This module is used by other modules to access an LDAP server.  It's pretty useless on its own; you should use it if you want to write your own LDAP-related module, or if you want to use one of mine ([mod_auth_ldap2], [mod_storage_ldap]).
+
+== Configuration ==
+
+= API =
+
+== ldap.getconnection() ==
+
+Returns an LDAP connection object corresponding to the configuration in prosody.cfg.lua.  The connection object is a [http://www.keplerproject.org/lualdap/ LuaLDAP] connection.
+
+== ldap.getparams() ==
+
+Returns the LDAP configuration provided in prosody.cfg.lua.  Use this if you want to stick some configuration information for your module into the LDAP section in the configuration file.
+
+== ldap.bind(username, password) ==
+
+Verifies that _username_ and _password_ bind ok.  *NOTE*: This does not bind the current LDAP connection to the given username!
+
+== ldap.singlematch(query) ==
+
+Used to fetch a single LDAP record given an LDAP query.  A convenience function.
+
+== ldap.filter.combine_and(...) ==
+
+Takes a list of LDAP filter expressions and returns a filter expression that results in the intersection of each given expression (it ANDs them together).
\ No newline at end of file