X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman5%2Fslapo-memberof.5;h=5f3f5469b235ba0e5f67b2caad2e72a6de417eb5;hb=80526326891ed511e7842d46b8699e1037c5583e;hp=b9f6e06761bb9d25ffef02873e49c2b579710115;hpb=ee8431b22d396d658fd5509b1dfe86745b544974;p=openldap diff --git a/doc/man/man5/slapo-memberof.5 b/doc/man/man5/slapo-memberof.5 index b9f6e06761..5f3f5469b2 100644 --- 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" -.\" 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 -slapo-memberof \- Reverse Group Membership overlay to slapd +slapo\-memberof \- Reverse Group Membership overlay to slapd .SH SYNOPSIS ETCDIR/slapd.conf .SH DESCRIPTION @@ -36,59 +36,69 @@ The following configuration options are defined for the memberofoverlay. .TP -.B memberof-group-oc +.BI memberof\-group\-oc \ The value -.B +.I is the name of the objectClass that triggers the reverse group membership update. It defaults to \fIgroupOfNames\fP. .TP -.B memberof-member-ad +.BI memberof\-member\-ad \ The value -.B +.I 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 +.BI memberof\-memberof\-ad \ The value -.B +.I 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 +.BI memberof\-dn \ The value -.B +.I 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 -.BR ignore , +.IR ignore , which may leave dangling references. Other options are -.BR drop , +.IR drop , 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 -.B memberof-refint {true|FALSE} +.BI memberof\-dangling\-error \ +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 -.BR TRUE , +.IR TRUE , 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), +.BR slapd\-config (5), .BR slapd (8). The -.BR slapo-memberof (5) +.BR slapo\-memberof (5) overlay supports dynamic configuration via .BR back-config . .SH ACKNOWLEDGEMENTS