Axe abandon support (ITS#2564)

[openldap] / doc / man / man5 / slapd-bdb.5

diff --git a/doc/man/man5/slapd-bdb.5 b/doc/man/man5/slapd-bdb.5
index 519b1311e9f9e25a29a02f1b1708622d718d1c84..bef49fd4d75ef9607cadd7ba23556f79643b04e2 100644 (file)
--- a/doc/man/man5/slapd-bdb.5
+++ b/doc/man/man5/slapd-bdb.5
@@ -1,5 +1,5 @@
-.TH SLAPD-BDB 5 "28 April 2002" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
+.TH SLAPD-BDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
@@ -10,14 +10,27 @@ ETCDIR/slapd.conf
 The BDB backend to
 .BR slapd (8)
 is the recommended backend for a normal slapd database.
-It uses the Sleepycat BerkelyDB package to store data.
+It uses the Sleepycat Berkeley DB (BDB) package to store data.
 It makes extensive use of indexing and caching to speed data access.
+.TP
+It is noted that these options are intended to complement
+Berkeley DB configuration options set in the environment's
+.B DB_CONFIG
+file.  See Berkeley DB documentation for
+details on
+.B DB_CONFIG
+configuration options.  Where there is overlap, settings in
+.B DB_CONFIG
+take precedence.
 .SH CONFIGURATION
-The
-.BR slapd.conf (5)
-options in this category apply to the BDB databases.
+These
+.B slapd.conf
+options apply to the BDB backend database.
 That is, they must follow a "database bdb" line and come before any
 subsequent "backend" or "database" lines.
+Other database options are described in the
+.BR slapd.conf (5)
+manual page.
 .TP
 .B cachesize <integer>
 Specify the size in entries of the in-memory cache maintained 
@@ -91,9 +104,30 @@ The default is the same as
 Specify the file protection mode that newly created database 
 index files should have.
 The default is 0600.
+.TP
+.B searchstack <depth>
+Specify the depth of the stack used for search filter evaluation.
+Search filters are evaluated on a stack to accomodate nested AND / OR
+clauses. An individual stack is assigned to each server thread.
+The depth of the stack determines how complex a filter can be
+evaluated without requiring any additional memory allocation. Filters that
+are nested deeper than the search stack depth will cause a separate
+stack to be allocated for that particular search operation. These
+allocations can have a major negative impact on server performance,
+but specifying too much stack will also consume a great deal of memory.
+Each search stack uses 512K bytes per level. The default stack depth
+is 16, thus 8MB per thread is used.
+.SH FILES
+.TP
+ETCDIR/slapd.conf
+default slapd configuration file
+.TP
+DB_CONFIG
+Berkeley DB configuration file
 .SH SEE ALSO
 .BR slapd.conf (5),
 .BR slapd (8),
 .BR slapadd (8),
 .BR slapcat (8),
-.BR slapindex (8).
+.BR slapindex (8),
+.BR Berkeley DB documentation .