Reference slapd-bdb and slapd-ldbm man pages.

Update index examples

diff --git a/doc/guide/admin/dbtools.sdf b/doc/guide/admin/dbtools.sdf
index a829a9bb8b0308e332b36f7d7e57c8874c8feacc..b4dfb8674790b82d88d6af6629e95a0b226b3685 100644 (file)
--- a/doc/guide/admin/dbtools.sdf
+++ b/doc/guide/admin/dbtools.sdf
@@ -80,16 +80,21 @@ For example, to index the {{EX:cn}}, {{EX:sn}}, {{EX:uid}} and
 {{EX:objectclass}} attributes, the following {{EX:index}} directives
 could be used:
 
->      index cn,sn,uid
->      index objectClass pres,eq
+>      index cn,sn,uid pres,eq,approx,sub
+>      index objectClass eq
+
+This would create presence, equality, approximate, and substring
+indices for the {{EX:cn}}, {{EX:sn}}, and {{EX:uid}} attributes and
+an equality index for the {{EX:objectClass}} attribute.  Note that
+not all index types are available with all attribute types.  See
+{{SECT:The slapd Configuration File}} section for more information
+on this option.
 
-Note that not all index types are available with all attribute types.
-See {{SECT:The slapd Configuration File}} section for more details on
-this option. Once you have configured things to your liking, start up
-slapd, connect with your LDAP client, and start adding entries.  For
-example, to add an organization entry and an organizational role entry
-using the {{I:ldapadd}} tool, you could create an {{TERM:LDIF}} file
-called {{EX:entries.ldif}} with the contents:
+Once you have configured things to your liking, start up slapd,
+connect with your LDAP client, and start adding entries.  For
+example, to add an organization entry and an organizational role
+entry using the {{I:ldapadd}} tool, you could create an {{TERM:LDIF}}
+file called {{EX:entries.ldif}} with the contents:
 
 >      # Organization for Example Corporation
 >      dn: dc=example,dc=com
@@ -150,14 +155,15 @@ is done by one or more index options.
 
 For example:
 
->      index cn,sn,uid pres,eq,sub
+>      index cn,sn,uid pres,eq,approx,sub
 >      index objectClass eq
 
-This would create presence, equality and substring indices for
-the {{EX:cn}}, {{EX:sn}}, and {{EX:uid}} attributes and an equality
-index for the {{EX:objectClass}} attribute. See 
-{{SECT:The slapd Configuration File}} section
-for more information on this option.
+This would create presence, equality, approximate, and substring
+indices for the {{EX:cn}}, {{EX:sn}}, and {{EX:uid}} attributes and
+an equality index for the {{EX:objectClass}} attribute.  Note that
+not all index types are available with all attribute types.  See
+{{SECT:The slapd Configuration File}} section for more information
+on this option.
 
 H3: The {{EX:slapadd}} program
 
@@ -172,9 +178,9 @@ The arguments have the following meanings:
 
 >      -l <inputfile>
 
-Specifies the LDIF input file containing the entries to add in text
-form (described below in the {{SECT:The LDIF text entry format}}
-section).
+Specifies the {{TERM:LDIF}} input file containing the entries to
+add in text form (described below in the {{SECT:The LDIF text entry
+format}} section).
 
 >      -f <slapdconfigfile>
 
@@ -229,8 +235,8 @@ your database off-line.  The program is invoked like this:
 
 where {{EX:-n}} or {{EX:-b}} is used to select the database in the
 {{slapd.conf}}(5) specified using {{EX:-f}}.  The corresponding
-LDIF output is written to standard output or to the file specified
-using the {{EX:-l}} option.
+{{TERM:LDIF}} output is written to standard output or to the file
+specified using the {{EX:-l}} option.
 
 
 !if 0

diff --git a/doc/guide/admin/intro.sdf b/doc/guide/admin/intro.sdf
index 6a232bdcb140be032e49f6c545140a1e31dd7f9e..3c93bac7341bed7f6d0061d4aeaaceae779866a8 100644 (file)
--- a/doc/guide/admin/intro.sdf
+++ b/doc/guide/admin/intro.sdf
@@ -13,7 +13,6 @@ to directory services and, in particular, the directory services
 provided by {{slapd}}(8).
 
 
-
 H2: What is a directory service?
 
 A directory is a specialized database optimized for reading, browsing

diff --git a/doc/guide/admin/quickstart.sdf b/doc/guide/admin/quickstart.sdf
index bf9e6c1526bea1609e315eec0c5c6c639e2c24ac..ea196da4eebf7aa853c8960fa2bbf6806509afce 100644 (file)
--- a/doc/guide/admin/quickstart.sdf
+++ b/doc/guide/admin/quickstart.sdf
@@ -12,7 +12,7 @@ and configure OpenLDAP software. It should be used in conjunction
 with the other chapters of this document, manual pages, and
 other materials provided with the distribution (e.g. the {{F:INSTALL}}
 document) or on the OpenLDAP web site (in particular, the
-OpenLDAP Software FAQ).
+OpenLDAP Software {{TERM:FAQ}}).
 
 If you intend to run OpenLDAP seriously, you should review all
 of this document before attempting to install the software.

diff --git a/doc/guide/admin/slapdconfig.sdf b/doc/guide/admin/slapdconfig.sdf
index 90ed42ba73658572cfaffb315a0755a05f74d41c..594ae283ed0df03bea2e2a68ce499a40d593f541 100644 (file)
--- a/doc/guide/admin/slapdconfig.sdf
+++ b/doc/guide/admin/slapdconfig.sdf
@@ -440,9 +440,10 @@ If specified multiple times, each {{TERM:URL}} is provided.
 
 H3: BDB Database Directives
 
-Directives in this category only apply to a BDB database. That is,
-they must follow a "database bdb" line and come before any
-subsequent "backend" or "database" line.
+Directives in this category only apply to a {{TERM:BDB}} database.
+That is, they must follow a "database bdb" line and come before any
+subsequent "backend" or "database" line.  For a complete reference
+of BDB configuration directives, see {{slapd-bdb}}(5).
 
 H4: directory <directory>
 
@@ -456,9 +457,10 @@ containing the database and associated indices live.
 
 H3: LDBM Database Directives
 
-Directives in this category only apply to a LDBM database. That is,
-they must follow a "database ldbm" line and come before any
-subsequent "backend" or "database" line.
+Directives in this category only apply to a {{TERM:LDBM}} database.
+That is, they must follow a "database ldbm" line and come before
+any subsequent "backend" or "database" line.  For a complete reference
+of LDBM configuration directives, see {{slapd-ldbm}}(5).
 
 H4: cachesize <integer>