~ubuntu-branches/ubuntu/maverick/openldap/maverick-proposed

« back to all changes in this revision

Viewing changes to doc/man/man5/slapo-sssvlv.5

  • Committer: Bazaar Package Importer
  • Author(s): Mathias Gug
  • Date: 2009-09-07 13:41:10 UTC
  • mto: This revision was merged to the branch mainline in revision 19.
  • Revision ID: james.westby@ubuntu.com-20090907134110-jsdrvn0atu1fex4m
Tags: upstream-2.4.18
ImportĀ upstreamĀ versionĀ 2.4.18

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH SLAPO-SSSVLV 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 
2
.\" Copyright 2009 The OpenLDAP Foundation All Rights Reserved.
 
3
.\" Copyright 2009 Symas Corporation All Rights Reserved.
 
4
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 
5
.\" $OpenLDAP: pkg/ldap/doc/man/man5/slapo-sssvlv.5,v 1.1.2.2 2009/07/22 20:02:21 quanah Exp $
 
6
.SH NAME
 
7
slapo\-sssvlv \- Server Side Sorting and Virtual List View overlay to slapd
 
8
.SH SYNOPSIS
 
9
ETCDIR/slapd.conf
 
10
.SH DESCRIPTION
 
11
This overlay implements the LDAP Server Side Sorting (RFC2891) control
 
12
as well as the Virtual List View control. It also replaces the default
 
13
implementation of the LDAP PagedResults (RFC2696) control, to ensure
 
14
that it works with Sorting. The overlay can be used with any backend
 
15
or globally for all backends.
 
16
 
 
17
Since a complete result set must be generated in memory before sorting can
 
18
be performed, processing sort requests can have a large impact on the
 
19
server's memory use. As such, any connection is limited to having only
 
20
one sort request active at a time. Additional limits may be configured
 
21
as described below.
 
22
 
 
23
.SH CONFIGURATION
 
24
These
 
25
.B slapd.conf
 
26
options apply to the SSSVLV overlay.
 
27
They should appear after the
 
28
.B overlay
 
29
directive.
 
30
.TP
 
31
.B sssvlv\-max <num>
 
32
Set the maximum number of concurrent sort requests allowed across all
 
33
connections. The default is one half of the number of server threads.
 
34
.TP
 
35
.B sssvlv\-maxkeys <num>
 
36
Set the maximum number of keys allowed in a sort request. The default is 5.
 
37
.SH FILES
 
38
.TP
 
39
ETCDIR/slapd.conf
 
40
default slapd configuration file
 
41
.TP
 
42
ETCDIR/slapd.d
 
43
default slapd configuration directory
 
44
.SH SEE ALSO
 
45
.BR slapd.conf (5),
 
46
.BR slapd\-config (5).
 
47
.LP
 
48
"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 
49
.LP
 
50
IETF LDAP Virtual List View proposal by D. Boreham, J. Sermersheim,
 
51
and A. Kashi in IETF document "draft-ietf-ldapext-ldapv3-vlv-09.txt".
 
52
.SH AUTHOR
 
53
Howard Chu