Summarize in description field and add details in header

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

diff --git a/doc/man/man5/slapo-refint.5 b/doc/man/man5/slapo-refint.5
index 84fc3705be9853fe5d6607296e200ac3516cb5d7..fc8c3c94b45b6fb20b532d8f05597620f4f3d7f6 100644 (file)
--- a/doc/man/man5/slapo-refint.5
+++ b/doc/man/man5/slapo-refint.5
@@ -1,9 +1,9 @@
 .TH SLAPO-REFINT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 2004-2006 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 2004-2008 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
-slapo-refint \- Referential Integrity overlay
+slapo-refint \- Referential Integrity overlay to slapd
 .SH SYNOPSIS
 ETCDIR/slapd.conf
 .SH DESCRIPTION
@@ -18,23 +18,28 @@ or
 .B delete
 operation. For example, if the integrity attribute were configured as
 .BR manager ,
-deletion of the record "uid=robert,ou=people,o=openldap.org" would trigger a
+deletion of the record "uid=robert,ou=people,dc=example,dc=com" would trigger a
 search for all other records which have a
 .B manager
 attribute containing that DN. Entries matching that search would have their
 .B manager
 attribute removed.
+Or, renaming the same record into "uid=george,ou=people,dc=example,dc=com" 
+would trigger a search for all other records which have a
+.B manager
+attribute containing that DN.
+Entries matching that search would have their
+.B manager
+attribute deleted and replaced by the new DN.
 .SH CONFIGURATION
 These
 .B slapd.conf
 options apply to the Referential Integrity overlay.
 They should appear after the
 .B overlay
-directive and before any subsequent
-.B database
 directive.
 .TP
-.B refint_attributes <attribute...>
+.B refint_attributes <attribute> [...]
 Specify one or more attributes for which integrity will be maintained
 as described above.
 .TP
@@ -44,6 +49,12 @@ would otherwise be deleted from an attribute. This can be useful in cases
 where the schema requires the existence of an attribute for which referential
 integrity is enforced. The attempted deletion of a required attribute will
 otherwise result in an Object Class Violation, causing the request to fail.
+The string must be a valid DN.
+.TP
+.B refint_modifiersname <DN>
+Specify the DN to be used as the modifiersName of the internal modifications
+performed by the overlay.
+It defaults to "\fIcn=Referential Integrity Overlay\fP".
 .B
 .SH FILES
 .TP
@@ -51,3 +62,5 @@ ETCDIR/slapd.conf
 default slapd configuration file
 .SH SEE ALSO
 .BR slapd.conf (5).
+.SH ACKNOWLEDGEMENTS
+.so ../Project