]> git.sur5r.net Git - openldap/blobdiff - doc/guide/admin/dbtools.sdf
Clarify that manageDsaIT is not to specified when managing
[openldap] / doc / guide / admin / dbtools.sdf
index 3ab47896e6c4eaf9fe71026063fa52bcdbfd8764..b4dfb8674790b82d88d6af6629e95a0b226b3685 100644 (file)
@@ -44,7 +44,7 @@ should be created:
 
 For example:
 
->      directory /usr/local/var/openldap-ldbm
+>      directory /usr/local/var/openldap-data
 
 You need to create this directory with appropriate permissions such
 that slapd can write to it.
@@ -80,15 +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.
 
-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
@@ -140,27 +146,29 @@ should be created:
 
 For example:
 
->      directory /usr/local/var/openldap-ldbm
+>      directory /usr/local/var/openldap-data
 
-Finally, you need to specify which indexes you want to build.  This
+Finally, you need to specify which indices you want to build.  This
 is done by one or more index options.
 
 >      index {<attrlist> | default} [pres,eq,approx,sub,none]
 
 For example:
 
->      index cn,sn,uid pres,eq,approx
+>      index cn,sn,uid pres,eq,approx,sub
 >      index objectClass eq
 
-This would create presence, equality and approximate indexes for
-the {{EX:cn}}, {{EX:sn}}, and {{EX:uid}} attributes and an equality
-index for the {{EX:objectClass}} attribute. See the 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
 
 Once you've configured things to your liking, you create the primary
-database and associated indexes by running the {{slapadd}}(8)
+database and associated indices by running the {{slapadd}}(8)
 program:
 
 >      slapadd -l <inputfile> -f <slapdconfigfile>
@@ -170,14 +178,14 @@ 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>
 
 Specifies the slapd configuration file that tells where to create
-the indexes, what indexes to create, etc.
+the indices, what indices to create, etc.
 
 >      -d <debuglevel>
 
@@ -189,7 +197,7 @@ Options}} section in {{SECT:Running slapd}}.
 
 An optional argument that specifies which database to modify.  The
 first database listed in the configuration file is {{EX:1}}, the
-second {{EX:2}}, etc. By default, the first ldbm database in the
+second {{EX:2}}, etc. By default, the first database in the
 configuration file is used. Should not be used in conjunction with
 {{EX:-b}}.
 
@@ -227,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