]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-collect.5
add slapo-collect(5) man page (ITS#5706)
[openldap] / doc / man / man5 / slapo-collect.5
1 .TH SLAPO-COLLECT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2003-2008 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
4 .\" $OpenLDAP$
5 .SH NAME
6 slapo-collect \- Collective attributes overlay to slapd
7 .SH SYNOPSIS
8 ETCDIR/slapd.conf
9 .SH DESCRIPTION
10 The collect overlay is used to provide a relatively coarse
11 implementation of RFC 3671 collective attributes.
12 In X.500, a collective attribute is "a user attribute whose
13 values are the same for each member of an entry collection".
14
15 Collective attributes are added to entries returned by a search operation
16 when the entry is within the scope of the related collectiveAttributeSubentry.
17 Collective attributes can only be modified when the modification affects
18 the related collectiveAttributeSubentry.
19
20 .SH CONFIGURATION
21 This
22 .B slapd.conf
23 option applies to the collect overlay.
24 It should appear after the
25 .B overlay
26 directive.
27 .TP
28 .B collectinfo <DN> <attrlist>
29 Specify the
30 .B DN
31 of a collectiveAttributeSubentry and the set
32 of related collective attributes, where
33 .B attrlist
34 is a comma-separated list of attributes.
35 The
36 .B DN 
37 should be within the naming context of the database.
38
39 .SH FILES
40 .TP
41 ETCDIR/slapd.conf
42 default slapd configuration file
43 .SH SEE ALSO
44 .BR slapd.conf (5).
45 .SH ACKNOWLEDGEMENTS
46 This module was written in 2003 by Howard Chu.
47 This man page was written in 2008 by Pierangelo Masarati.
48 .so ../Project