Cleanup prev commit

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

diff --git a/doc/man/man5/slapo-memberof.5 b/doc/man/man5/slapo-memberof.5
index b9f6e06761bb9d25ffef02873e49c2b579710115..5f3f5469b235ba0e5f67b2caad2e72a6de417eb5 100644 (file)
--- a/doc/man/man5/slapo-memberof.5
+++ b/doc/man/man5/slapo-memberof.5
@@ -1,9 +1,9 @@
 .TH SLAPO-MEMBEROF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 .TH SLAPO-MEMBEROF 5 "RELEASEDATE" "OpenLDAP LDVERSION"

-.\" Copyright 1998-2007 The OpenLDAP Foundation, All Rights Reserved.
+.\" Copyright 1998-2009 The OpenLDAP Foundation, All Rights Reserved.

 .\" Copying restrictions apply.  See the COPYRIGHT file.
 .\" $OpenLDAP$
 .SH NAME
 .\" Copying restrictions apply.  See the COPYRIGHT file.
 .\" $OpenLDAP$
 .SH NAME

-slapo-memberof \- Reverse Group Membership overlay to slapd
+slapo\-memberof \- Reverse Group Membership overlay to slapd

 .SH SYNOPSIS
 ETCDIR/slapd.conf
 .SH DESCRIPTION
 .SH SYNOPSIS
 ETCDIR/slapd.conf
 .SH DESCRIPTION


@@ -36,59 +36,69 @@ The following
 configuration options are defined for the memberofoverlay.
 
 .TP
 configuration options are defined for the memberofoverlay.
 
 .TP

-.B memberof-group-oc <group-oc>
+.BI memberof\-group\-oc \ <group-oc>

 The value 
 The value 

-.B <group-oc> 
+.I <group-oc> 

 is the name of the objectClass that triggers the reverse group membership
 update.
 It defaults to \fIgroupOfNames\fP.
 
 .TP
 is the name of the objectClass that triggers the reverse group membership
 update.
 It defaults to \fIgroupOfNames\fP.
 
 .TP

-.B memberof-member-ad <member-ad>
+.BI memberof\-member\-ad \ <member-ad>

 The value 
 The value 

-.B <member-ad> 
+.I <member-ad> 

 is the name of the attribute that contains the names of the members
 in the group objects; it must be DN-valued.
 It defaults to \fImember\fP.
 
 .TP
 is the name of the attribute that contains the names of the members
 in the group objects; it must be DN-valued.
 It defaults to \fImember\fP.
 
 .TP

-.B memberof-memberof-ad <memberof-ad>
+.BI memberof\-memberof\-ad \ <memberof-ad>

 The value 
 The value 

-.B <memberof-ad> 
+.I <memberof-ad> 

 is the name of the attribute that contains the names of the groups
 an entry is member of; it must be DN-valued.  Its contents are 
 automatically updated by the overlay.
 It defaults to \fImemberOf\fP.
 
 .TP
 is the name of the attribute that contains the names of the groups
 an entry is member of; it must be DN-valued.  Its contents are 
 automatically updated by the overlay.
 It defaults to \fImemberOf\fP.
 
 .TP

-.B memberof-dn <dn>
+.BI memberof\-dn \ <dn>

 The value 
 The value 

-.B <dn> 
+.I <dn> 

 contains the DN that is used as \fImodifiersName\fP for internal 
 modifications performed to update the reverse group membership.
 It defaults to the \fIrootdn\fP of the underlying database.
 
 .TP
 contains the DN that is used as \fImodifiersName\fP for internal 
 modifications performed to update the reverse group membership.
 It defaults to the \fIrootdn\fP of the underlying database.
 
 .TP

-.B memberof-dangling {ignore, drop, error}
+.BI "memberof\-dangling {" ignore ", " drop ", " error "}"

 This option determines the behavior of the overlay when, during 
 a modification, it encounters dangling references.
 The default is
 This option determines the behavior of the overlay when, during 
 a modification, it encounters dangling references.
 The default is

-.BR ignore ,
+.IR ignore ,

 which may leave dangling references.
 Other options are
 which may leave dangling references.
 Other options are

-.BR drop ,
+.IR drop ,

 which discards those modifications that would result in dangling
 references, and
 which discards those modifications that would result in dangling
 references, and

-.BR error ,
+.IR error ,

 which causes modifications that would result in dangling references
 to fail.
 
 .TP
 which causes modifications that would result in dangling references
 to fail.
 
 .TP

-.B memberof-refint {true|FALSE}
+.BI memberof\-dangling\-error \ <error-code>
+If
+.BR memberof\-dangling
+is set to
+.IR error ,
+this configuration parameter can be used to modify the response code
+returned in case of violation.  It defaults to "constraint violation",
+but other implementations are known to return "no such object" instead.
+
+.TP
+.BI "memberof\-refint {" true "|" FALSE "}"

 This option determines whether the overlay will try to preserve
 referential integrity or not.
 If set to
 This option determines whether the overlay will try to preserve
 referential integrity or not.
 If set to

-.BR TRUE ,
+.IR TRUE ,

 when an entry containing values of the "is member of" attribute is modified,
 the corresponding groups are modified as well.
 
 when an entry containing values of the "is member of" attribute is modified,
 the corresponding groups are modified as well.
 


@@ -103,9 +113,10 @@ ETCDIR/slapd.conf
 default slapd configuration file
 .SH SEE ALSO
 .BR slapd.conf (5),
 default slapd configuration file
 .SH SEE ALSO
 .BR slapd.conf (5),

+.BR slapd\-config (5),

 .BR slapd (8).
 The
 .BR slapd (8).
 The

-.BR slapo-memberof (5)
+.BR slapo\-memberof (5)

 overlay supports dynamic configuration via
 .BR back-config .
 .SH ACKNOWLEDGEMENTS
 overlay supports dynamic configuration via
 .BR back-config .
 .SH ACKNOWLEDGEMENTS