From: Pierangelo Masarati <ando@openldap.org>
Date: Tue, 18 Aug 2009 21:44:11 +0000 (+0000)
Subject: document URI (ITS#6261)
X-Git-Tag: ACLCHECK_0~294
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=959fd98408ecf59564e662bcae5ef137c8875c4d;p=openldap

document URI (ITS#6261)
---

diff --git a/doc/man/man3/ldap_open.3 b/doc/man/man3/ldap_open.3
index 0636fc9255..d305ffc0a2 100644
--- 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),