ITS#6261

diff --git a/CHANGES b/CHANGES
index 08209d40697cf1df3717e3d22186cd15c7175461..d9ab6fa64d5ccdad6f61d90b02efde852241b98f 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -38,6 +38,8 @@ OpenLDAP 2.4.18 Engineering
        Build Environment
                Tests note which backend is being tested (ITS#5810)
                Fixed test056-monitor with custom ports (ITS#6213)
+       Documentation
+               ldap_open(3) document URI (ITS#6261)
 
 OpenLDAP 2.4.17 Release (2009/07/13)
        Fixed liblber to use ber_strnlen (ITS#6080)

diff --git a/doc/man/man3/ldap_open.3 b/doc/man/man3/ldap_open.3
index 0636fc925539bc920c9c6b6c2349cfd08d0aa7ac..d305ffc0a2cf7468f76e288031e7fa0ed9eb42c9 100644 (file)
--- a/doc/man/man3/ldap_open.3
+++ b/doc/man/man3/ldap_open.3
@@ -93,6 +93,29 @@ acts like
 but it returns an integer indicating either success or the failure reason,
 and it allows to specify details for the connection in the schema portion
 of the URI.
+The
+.I uri
+parameter may be a comma- or whitespace-separated list of URIs
+containing only the
+.IR schema ,
+the
+.IR host ,
+and the
+.I port
+fields.
+Apart from
+.BR ldap ,
+other (non-standard) recognized values of the
+.I schema
+field are
+.B ldaps
+(LDAP over TLS),
+.B ldapi
+(LDAP over IPC),
+and
+.B cldap
+(connectionless LDAP).
+If other fields are present, the behavior is undefined.
 .LP
 At this time,
 .B ldap_open()
@@ -134,14 +157,17 @@ If an error occurs,
 .B ldap_open()
 and
 .B ldap_init()
-will return NULL and errno should be set appropriately.
+will return NULL and 
+.I errno
+should be set appropriately.
 .B ldap_initialize()
 and
 .B ldap_init_fd()
 will directly return the LDAP code associated to the error (or
 .I LDAP_SUCCESS
 in case of success);
-errno should be set as well whenever appropriate.
+.I errno
+should be set as well whenever appropriate.
 .SH SEE ALSO
 .BR ldap (3),
 .BR ldap_bind (3),