Re: (ITS#5499) slapd-perl man page

[h.b.furuseth@usit.uio.no]

Alexander.lelyakin@googlemail.com writes:
> Man page slapd-perl does not contain ANY information on 'bind' method.

Wow.  That doc is 9 years old and you are the first to notice.
Thanks for the report.

> Also it is not clear: Is there any possibility for perl backend to get
> connection information, for example IP addres of client (for
> implementation own access control schemes).

No.  Except for Bind, what you see in the manpage is what you get.
Also the manpage should mention LDIF format for Search entries.

Like this, I think - but I (or someone) needs to test before committing.

Index: doc/man/man5/slapd-perl.5
===================================================================
RCS file: /repo/OpenLDAP/pkg/ldap/doc/man/man5/slapd-perl.5,v
retrieving revision 1.7
diff -u -2 -r1.7 doc/man/man5/slapd-perl.5
--- doc/man/man5/slapd-perl.5	4 Jul 2005 04:57:11 -0000	1.7
+++ doc/man/man5/slapd-perl.5	7 May 2008 17:01:30 -0000
@@ -24,4 +24,5 @@
 .nf
   * new        # creates a new object,
+  * bind       # does a simple bind,
   * search     # performs the ldap search,
   * compare    # does a compare,
@@ -52,4 +53,15 @@
 method receives the class name as argument.
 .TP
+.B bind
+This method is called when the client requests a Simple Bind,
+except Simple Bind as the rootdn when rootpw is set in slapd.conf.
+Its arguments are as follows.
+.nf
+  * object reference
+  * bind DN, or "" for anonymous bind
+  * password, or "" for no password
+.fi
+.LP
+.TP
 .B search
 This method is called when a search request comes from a client.
@@ -68,4 +80,8 @@
 .LP
 Return value: (resultcode, ldif-entry, ldif-entry, ...)
+
+Each ldif-entry is a string starting with "dn:" in
+.BR ldif (5)
+format.
 .TP
 .B compare
@@ -96,5 +112,5 @@
 .nf
   * object reference
-  * entry in string format
+  * entry record in \fBldif\fP(5) string format
 .fi
 .LP
@@ -187,3 +203,4 @@
 .BR slapd.conf (5),
 .BR slapd (8),
-.BR perl (1).
+.BR perl (1),
+.BR ldif (5).

-- 
Hallvard