Fix copyright year

[openldap] / doc / man / man5 / slapo-dynlist.5

diff --git a/doc/man/man5/slapo-dynlist.5 b/doc/man/man5/slapo-dynlist.5
index f967d9617d5a66a521bac43a91a1b02980bfab0f..74d597860c77f5e903ac6e805a385e3e05904e39 100644 (file)
--- a/doc/man/man5/slapo-dynlist.5
+++ b/doc/man/man5/slapo-dynlist.5
@@ -1,9 +1,9 @@
 .TH SLAPO-DYNLIST 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2005 The OpenLDAP Foundation, All Rights Reserved.
+.\" Copyright 1998-2006 The OpenLDAP Foundation, All Rights Reserved.
 .\" Copying restrictions apply.  See the COPYRIGHT file.
 .\" $OpenLDAP$
 .SH NAME
-slapo-dynlist \- dynnamic list overlay
+slapo-dynlist \- Dynamic List overlay
 .SH SYNOPSIS
 ETCDIR/slapd.conf
 .SH DESCRIPTION
@@ -17,7 +17,11 @@ the LDAP URI-valued occurrences of a specific attribute are
 expanded into the corresponding entries, and the values
 of the attributes listed in the URI are added to the original
 entry.
-No recursion is currently allowed, to avoid potential infinite loops.
+No recursion is allowed, to avoid potential infinite loops.
+The resulting entry must comply with the LDAP data model, so constraints
+are enforced.
+For example, if a \fISINGLE-VALUE\fP attribute is listed,
+only the first value results in the final entry.
 
 .SH CONFIGURATION
 The config directives that are specific to the
@@ -35,32 +39,45 @@ or to the frontend, if used before any database instantiation; see
 for details.
 
 .LP
-These 
+This
 .B slapd.conf
-configuration options apply to the dynlist overlay. They must appear
-after the
+configuration option is define for the dynlist overlay. It may have multiple 
+occurrences, and it must appear after the
 .B overlay
 directive.
 .TP
-.B dynlist-oc <objectClass>
-The name of the objectClass that triggers the dynamic expansion of the
-data.  This statement is required.
-.TP
-.B dynlist-ad <attributeName>
-The name of the attributeDescription that holds the LDAP URI values that
-will expand; if none is present, no expansion occurs.  If the intersection
-of the attributes requested by the search operation (or the asserted attribute
-for compares) and the attributes listed in the URI is empty, no expansion 
-occurs for that specific URI.  This statement is required.
-.TP
-.B dynlist-member-ad <attributeName>
-The name of the attributeDescription that will list the DN of the entries
-resulting from the internal search.  This statement is optional and, if
-present, changes the behvior of the overlay into that of a dynamic group.
-The <attrs> portion of the URI is ignored, and the DNs of all the entries 
-resulting from the expansion of the URI are listed as values of this 
-attribute.
+.B dynlist-attrset <group-oc> <URL-ad> [<member-ad>]
+The value 
+.B <group-oc> 
+is the name of the objectClass that triggers the dynamic expansion of the
+data.
 
+The value
+.B <URL-ad>
+is the name of the attributeDescription that cointains the URI that is 
+expanded by the overlay; if none is present, no expansion occurs.
+If the intersection of the attributes requested by the search operation 
+(or the asserted attribute for compares) and the attributes listed 
+in the URI is empty, no expansion occurs for that specific URI.
+It must be a subtype of \fIlabeledURI\fP.
+
+The value
+.B <member-ad>
+is optional; if present, the overlay behaves as a dynamic group: this
+attribute will list the DN of the entries resulting from the internal search.
+In this case, the <attrs> portion of the URI must be absent, and the DNs 
+of all the entries resulting from the expansion of the URI are listed
+as values of this attribute.
+Compares that assert the value of the
+.B <member-ad>
+attribute of entries with 
+.B <group-oc>
+objectClass apply as if the DN of the entries resulting from the expansion 
+of the URI were present in the 
+.B <group-oc> 
+entry as values of the
+.B <member-ad>
+attribute.
 .LP
 The dynlist overlay may be used with any backend, but it is mainly 
 intended for use with local storage backends.
@@ -81,8 +98,7 @@ entry; first of all, make sure that slapd.conf contains the directives:
     # ...
 
     overlay dynlist
-    dynlist-oc groupOfURLs
-    dynlist-ad memberURL
+    dynlist-attrset groupOfURLs memberURL
 .fi
 .LP
 and that slapd loads dynlist.la, if compiled as a run-time module;
@@ -98,6 +114,22 @@ then add to the database an entry like
 If no <attrs> are provided in the URI, all (non-operational) attributes are
 collected.
 
+This example implements the dynamic group feature on the 
+.B member
+attribute:
+
+.LP
+.nf
+    include /path/to/dyngroup.schema
+    # ...
+
+    database <database>
+    # ...
+
+    overlay dynlist
+    dynlist-attrset groupOfURLs memberURL member
+.fi
+.LP
 
 .SH FILES
 .TP
@@ -106,5 +138,10 @@ default slapd configuration file
 .SH SEE ALSO
 .BR slapd.conf (5),
 .BR slapd (8).
-.SH AUTHOR
-Originally implemented by Pierangelo Masarati.
+The
+.BR slapo-dynlist (5)
+overlay supports dynamic configuration via
+.BR back-config .
+.SH ACKNOWLEDGEMENTS
+.P
+This module was written in 2004 by Pierangelo Masarati for SysNet s.n.c.