From: Pierangelo Masarati <ando@openldap.org>
Date: Thu, 18 Sep 2008 22:11:52 +0000 (+0000)
Subject: add slapo-collect(5) man page (ITS#5706)
X-Git-Tag: ACLCHECK_0~1331
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=9f3bf5bb8517f340b9b8421fd9bab7078a202f7c;p=openldap

add slapo-collect(5) man page (ITS#5706)
---

diff --git a/doc/man/man5/slapo-collect.5 b/doc/man/man5/slapo-collect.5
new file mode 100644
index 0000000000..304ebc7e7d
--- /dev/null
+++ b/doc/man/man5/slapo-collect.5
@@ -0,0 +1,48 @@
+.TH SLAPO-COLLECT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" Copyright 2003-2008 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
+.\" $OpenLDAP$
+.SH NAME
+slapo-collect \- Collective attributes overlay to slapd
+.SH SYNOPSIS
+ETCDIR/slapd.conf
+.SH DESCRIPTION
+The collect overlay is used to provide a relatively coarse
+implementation of RFC 3671 collective attributes.
+In X.500, a collective attribute is "a user attribute whose
+values are the same for each member of an entry collection".
+
+Collective attributes are added to entries returned by a search operation
+when the entry is within the scope of the related collectiveAttributeSubentry.
+Collective attributes can only be modified when the modification affects
+the related collectiveAttributeSubentry.
+
+.SH CONFIGURATION
+This
+.B slapd.conf
+option applies to the collect overlay.
+It should appear after the
+.B overlay
+directive.
+.TP
+.B collectinfo <DN> <attrlist>
+Specify the
+.B DN
+of a collectiveAttributeSubentry and the set
+of related collective attributes, where
+.B attrlist
+is a comma-separated list of attributes.
+The
+.B DN 
+should be within the naming context of the database.
+
+.SH FILES
+.TP
+ETCDIR/slapd.conf
+default slapd configuration file
+.SH SEE ALSO
+.BR slapd.conf (5).
+.SH ACKNOWLEDGEMENTS
+This module was written in 2003 by Howard Chu.
+This man page was written in 2008 by Pierangelo Masarati.
+.so ../Project