Merge remote-tracking branch 'origin/mdb.master'

[openldap] / doc / man / man5 / slapd-perl.5

diff --git a/doc/man/man5/slapd-perl.5 b/doc/man/man5/slapd-perl.5
index 36a87b3a4eec37a1e7c663e35fc8952b6a2c92a2..f0fddd5b12519dc86580a7e28261282fa3a89905 100644 (file)
--- a/doc/man/man5/slapd-perl.5
+++ b/doc/man/man5/slapd-perl.5
@@ -1,7 +1,7 @@
-.TH SLAPD-PERL 5 "30 April 2002" "OpenLDAP LDVERSION"
+.TH SLAPD-PERL 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
 .SH NAME
-slapd-perl \- Perl backend to slapd
+slapd\-perl \- Perl backend to slapd
 .SH SYNOPSIS
 ETCDIR/slapd.conf
 .SH DESCRIPTION
@@ -29,7 +29,7 @@ following actions:
   * add        # adds an entry to backend,
   * modrdn     # modifies an entry's rdn,
   * delete     # deletes an ldap entry,
-  * config     # process unknown config file lines,
+  * config     # module-specific config directives,
   * init       # called after backend is initialized.
 .fi
 .LP
@@ -58,12 +58,12 @@ It arguments are as follows:
   * object reference
   * base DN
   * scope
-  * alias deferencing policy
+  * alias dereferencing policy
   * size limit
   * time limit
   * filter string
   * attributes only flag (1 for yes)
-  * list of attributes that are to be returned (may be empty).
+  * list of attributes to return (may be empty)
 .fi
 .LP
 Return value: (resultcode, ldif-entry, ldif-entry, ...)
@@ -85,7 +85,8 @@ Its arguments are as follows.
   * object reference
   * dn
   * a list formatted as follows
-    { "ADD" | "DELETE" | "REPLACE" }, attributetype, value..., ...
+    ({ "ADD" | "DELETE" | "REPLACE" },
+     attributetype, value...)...
 .fi
 .LP
 .TP
@@ -94,7 +95,7 @@ This method is called when a add request comes from a client.
 Its arguments are as follows.
 .nf
   * object reference
-  * entry in string format.
+  * entry in string format
 .fi
 .LP
 .TP
@@ -119,9 +120,9 @@ Its arguments are as follows.
 .LP
 .TP
 .B config
-This method is called with unknown
+This method is called once for each perlModuleConfig line in the
 .BR slapd.conf (5)
-configuration file lines.
+configuration file.
 Its arguments are as follows.
 .nf
   * object reference
@@ -158,14 +159,40 @@ Add the path to the @INC variable.
 Search results are candidates that need to be filtered (with the
 filter in the search request), rather than search results to be
 returned directly to the client.
+.TP
+.B perlModuleConfig <arguments>
+Invoke the module's config method with the given arguments.
 .SH EXAMPLE
-There is an example Perl module `SampleLDAP' in the slapd/back-perl/
-direcetory in the OpenLDAP source tree.
+There is an example Perl module `SampleLDAP' in the slapd/back\-perl/
+directory in the OpenLDAP source tree.
+.SH ACCESS CONTROL
+The
+.B perl
+backend does not honor any of the access control semantics described in
+.BR slapd.access (5);
+all access control is delegated to the underlying PERL scripting.
+Only
+.B read (=r)
+access to the
+.B entry
+pseudo-attribute and to the other attribute values of the entries
+returned by the
+.B search
+operation is honored, which is performed by the frontend.
 .SH WARNING
 The interface of this backend to the perl module MAY change.
 Any suggestions would greatly be appreciated.
+
+Note: in previous versions, any unrecognized lines in the slapd.conf
+file were passed to the perl module's config method. This behavior is
+deprecated (but still allowed for backward compatibility), and the
+perlModuleConfig directive should instead be used to invoke the
+module's config method. This compatibility feature will be removed at
+some future date.
 .SH FILES
+.TP
 ETCDIR/slapd.conf
+default slapd configuration file
 .SH SEE ALSO
 .BR slapd.conf (5),
 .BR slapd (8),