Happy new year! (belated)

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

diff --git a/doc/man/man5/slapd-ldbm.5 b/doc/man/man5/slapd-ldbm.5
index 95ca923d0ad336db43505ce8490ce6da8c56e286..6686af95244800b0705375880b46ae50b2874141 100644 (file)
--- a/doc/man/man5/slapd-ldbm.5
+++ b/doc/man/man5/slapd-ldbm.5
@@ -1,5 +1,5 @@
-.TH SLAPD-LDBM 5 "28 April 2002" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
+.TH SLAPD-LDBM 5 "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
@@ -9,18 +9,21 @@ ETCDIR/slapd.conf
 .SH DESCRIPTION
 The LDBM backend to
 .BR slapd (8)
-is a database that makes
-extensive use of indexing and caching to speed data access.
-.\" .SH LDBM BACKEND-SPECIFIC OPTIONS
-.\" Options in this category only apply to the LDBM backend.
-.\" That is, they must follow "backend ldbm" line and come before
-.\" any subsequent "backend" or "database" lines.
+is an easy\-to\-configure but obsolete database backend.  It does not
+offer the data durability features of the BDB and HDB backends and
+hence is considered deprecated in favor of these robust backends.
+LDBM uses lightweight non\-transactional data interfaces, such as those
+provided by GDBM or Berkeley DB, to store data.  It makes extensive
+use of indexing and caching to speed data access.
 .SH CONFIGURATION
-The
-.BR slapd.conf (5)
-options in this category apply to the LDBM databases.
+These
+.B slapd.conf
+options apply to the LDBM backend database.
 That is, they must follow a "database ldbm" 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 
@@ -51,7 +54,7 @@ Flush dirty database buffers to disk every
 seconds.
 Implies
 .B dbnosync
-(ie. indvidual updates are no longer written to disk).
+(ie. individual updates are no longer written to disk).
 It attempts to avoid syncs during periods of peak activity by waiting
 .B <delayinterval>
 seconds if the server is busy, repeating this delay up to
@@ -91,7 +94,11 @@ Some attributes only support a subset of indexes.
 If only an <attr> is given, the indices specified for \fBdefault\fR
 are maintained.
 Note that setting a default does not imply that all attributes will be
-indexed.
+indexed. Also, for best performance, an
+.B eq
+index should always be configured for the
+.B objectClass
+attribute.
 
 A number of special index parameters may be specified.
 The index type
@@ -102,8 +109,11 @@ can be decomposed into
 .B subfinal
 indices.
 The special type
-.B nolang
-may be specified to disallow use of this index by language subtypes.
+.B notags
+(or
+.BR nolang )
+may be specified to disallow use of this index by subtypes with tagging
+options (such as language options).
 The special type
 .B nosubtypes
 may be specified to disallow use of this index by named subtypes.
@@ -114,6 +124,15 @@ Note: changing index settings requires rebuilding indices, see
 Specify the file protection mode that newly created database 
 index files should have.
 The default is 0600.
+.SH ACCESS CONTROL
+The 
+.B ldbm
+backend honors access control semantics as indicated in
+.BR slapd.access (5).
+.SH FILES
+.TP
+ETCDIR/slapd.conf
+default slapd configuration file
 .SH SEE ALSO
 .BR slapd.conf (5),
 .BR slapd (8),