Merge branch 'mdb.master' of ssh://git-master.openldap.org/~git/git/openldap

[openldap] / doc / man / man5 / slapd.backends.5

diff --git a/doc/man/man5/slapd.backends.5 b/doc/man/man5/slapd.backends.5
index 887c499c144ec7adc7e1dd5481a58c47e9e3fc14..e69e043330266c984312ab6d37e812dd0ba6fbf3 100644 (file)
--- a/doc/man/man5/slapd.backends.5
+++ b/doc/man/man5/slapd.backends.5
@@ -1,5 +1,5 @@
 .TH SLAPD.BACKENDS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 2006-2007 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 2006-2011 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
@@ -16,12 +16,14 @@ slapd server.
 
 Configuration options for each backend are documented separately in the
 corresponding
-.BR slapd-<backend> (5)
+.BR slapd\-<backend> (5)
 manual pages.
 .TP
 .B bdb
-This is the recommended primary backend for a normal slapd database.
-It takes care to configure it properly.
+This was the recommended primary backend through OpenLDAP 2.3, but it has
+since been superseded by the
+.BR hdb
+backend.  It takes care to configure it properly.
 It uses the transactional database interface of the Oracle Berkeley
 DB (BDB) package to store data.
 .TP
@@ -40,14 +42,18 @@ It serves up referrals based upon SRV resource records held in the
 Domain Name System.
 .TP
 .B hdb
-This is a variant of the
+This is the recommended primary backend for a normal slapd database.
+.B hdb
+is a variant of the
 .B bdb
 backend that uses a hierarchical database
-layout. This layout stores entry DNs more efficiently than the
+layout.
+This layout stores entry DNs more efficiently than the
 .B bdb
 backend,
 using less space and requiring less work to create, delete, and rename
 entries. It is also one of the few backends to support subtree renames.
+.BR
 .TP
 .B ldap
 This backend acts as a proxy to forward incoming requests to another
@@ -71,6 +77,11 @@ daemon. Only a single instance of the
 .B monitor
 backend may be defined.
 .TP
+.B ndb
+This backend is experimental.
+It uses the transactional database interface of the MySQL Cluster Engine
+(NDB) to store data.
+.TP
 .B null
 Operations in this backend succeed but do nothing.
 .TP
@@ -93,7 +104,7 @@ in the same server, based on the naming context of the request.
 Its use requires the 
 .B rwm
 overlay (see
-.BR slapo-rwm (5)
+.BR slapo\-rwm (5)
 for details) to rewrite the naming context of the request.
 It is primarily intended to implement virtual views on databases
 that actually store data.