Merge remote branch 'origin/mdb.master'

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

diff --git a/doc/man/man5/slapo-constraint.5 b/doc/man/man5/slapo-constraint.5
index 4df7d83c3ee074c5a4f429bcaea359136e78100f..2c87bacbee5b46c1a92ced1ebeff9944eb4b938a 100644 (file)
--- a/doc/man/man5/slapo-constraint.5
+++ b/doc/man/man5/slapo-constraint.5
@@ -1,10 +1,10 @@
 .TH SLAPO-CONSTRAINT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" Copyright 2005-2006 Hewlett-Packard Company
-.\" Copyright 2006-2008 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 2006-2011 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
-slapo-constraint \- Attribute Constraint Overlay to slapd
+slapo\-constraint \- Attribute Constraint Overlay to slapd
 .SH SYNOPSIS
 ETCDIR/slapd.conf
 .SH DESCRIPTION
@@ -20,6 +20,10 @@ like telephone numbers, post codes, FQDNs, etc.
 It constrains only LDAP \fIadd\fP, \fImodify\fP and \fIrename\fP commands
 and only seeks to control the \fIadd\fP and \fIreplace\fP values
 of \fImodify\fP and \fIrename\fP requests.
+.LP
+No constraints are applied for operations performed with the
+.I relax
+control set.
 .SH CONFIGURATION
 This
 .B slapd.conf
@@ -31,7 +35,7 @@ directive.
 .B constraint_attribute <attribute_name>[,...] <type> <value> [<extra> [...]]
 Specifies the constraint which should apply to the comma-separated
 attribute list named as the first parameter.
-Two types of constraint are currently supported -
+Five types of constraint are currently supported -
 .BR regex ,
 .BR size ,
 .BR count ,
@@ -99,7 +103,7 @@ LDAP_CONSTRAINT_VIOLATION error.
 overlay constraint
 constraint_attribute jpegPhoto size 131072
 constraint_attribute userPassword count 3
-constraint_attribute mail regex ^[:alnum:]+@mydomain.com$
+constraint_attribute mail regex ^[[:alnum:]]+@mydomain.com$
 constraint_attribute title uri
   ldap:///dc=catalog,dc=example,dc=com?title?sub?(objectClass=titleCatalog)
 constraint_attribute cn,sn,givenName set
@@ -118,7 +122,11 @@ attribute whose values were not listed in the
 .B title
 attribute of any
 .B titleCatalog
-entries in the given scope.
+entries in the given scope. (Note that the
+"dc=catalog,dc=example,dc=com" subtree ought to reside
+in a separate database, otherwise the initial set of
+titleCatalog entries could not be populated while the
+constraint is in effect.)
 Finally, it requires the values of the attribute
 .B cn
 to be constructed by pairing values of the attributes
@@ -133,7 +141,8 @@ separated by a space, but only for entries derived from the objectClass
 ETCDIR/slapd.conf
 default slapd configuration file
 .SH SEE ALSO
-.BR slapd.conf (5).
+.BR slapd.conf (5),
+.BR slapd\-config (5),
 .SH ACKNOWLEDGEMENTS
 This module was written in 2005 by Neil Dunbar of Hewlett-Packard and subsequently
 extended by Howard Chu and Emmanuel Dreyfus.