ITS#2497 value-level ACLs

[openldap] / doc / guide / admin / dbtools.sdf

diff --git a/doc/guide/admin/dbtools.sdf b/doc/guide/admin/dbtools.sdf
index b7262c3952f34375d4698f7befc3a9cb8179d8f0..672ba0fdb87076915f318b93de004e1b9d4261a4 100644 (file)
--- a/doc/guide/admin/dbtools.sdf
+++ b/doc/guide/admin/dbtools.sdf
@@ -1,5 +1,5 @@
 # $OpenLDAP$
-# Copyright 1999-2000, The OpenLDAP Foundation, All Rights Reserved.
+# Copyright 1999-2003, The OpenLDAP Foundation, All Rights Reserved.
 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
 
 H1: Database Creation and Maintenance Tools
@@ -35,7 +35,7 @@ this option defines which entries are to be held by this database.
 You should set this to the DN of the root of the subtree you are
 trying to create.  For example:
 
->      suffix "dc=example, dc=com"
+>      suffix "dc=example,dc=com"
 
 You should be sure to specify a directory where the index files
 should be created:
@@ -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.
@@ -60,7 +60,7 @@ options in the database definition:
 
 For example:
 
->      rootdn "cn=Manager, dc=example, dc=com"
+>      rootdn "cn=Manager,dc=example,dc=com"
 >      rootpw secret
 
 These options specify a DN and password that can be used to
@@ -80,18 +80,24 @@ 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
+>      dn: dc=example,dc=com
 >      objectClass: dcObject
 >      objectClass: organization
 >      dc: example
@@ -99,7 +105,7 @@ called {{EX:entries.ldif}} with the contents:
 >      description: The Example Corporation
 >
 >      # Organizational Role for Directory Manager
->      dn: cn=Manager, dc=example, dc=com
+>      dn: cn=Manager,dc=example,dc=com
 >      objectClass: organizationalRole
 >      cn: Manager
 >      description: Directory Manager
@@ -131,7 +137,7 @@ this option defines which entries are to be held by this database.
 You should set this to the DN of the root of the subtree you are
 trying to create.  For example:
 
->      suffix "dc=example, dc=com"
+>      suffix "dc=example,dc=com"
 
 You should be sure to specify a directory where the index files
 should be created:
@@ -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
@@ -287,14 +295,14 @@ or {{EX:userCertificate;binary}}.
 A line may be continued by starting the next line with a {{single}}
 space or tab character.  For example:
 
->      dn: cn=Barbara J Jensen, dc=example, dc=
+>      dn: cn=Barbara J Jensen,dc=example,dc=
 >       com
 >      cn: Barbara J
 >        Jensen
 
 is equivalent to:
 
->      dn: cn=Barbara J Jensen, dc=example, dc=com
+>      dn: cn=Barbara J Jensen,dc=example,dc=com
 >      cn: Barbara J Jensen
 
 Multiple attribute values are specified on separate lines. e.g.,
@@ -320,14 +328,14 @@ Multiple entries within the same LDIF file are separated by blank
 lines. Here's an example of an LDIF file containing three entries.
 
 >      # Barbara's Entry
->      dn: cn=Barbara J Jensen, dc=example, dc=com
+>      dn: cn=Barbara J Jensen,dc=example,dc=com
 >      cn: Barbara J Jensen
 >      cn: Babs Jensen
 >      objectClass: person
 >      sn: Jensen
 >
 >      # Bjorn's Entry
->      dn: cn=Bjorn J Jensen, dc=example, dc=com
+>      dn: cn=Bjorn J Jensen,dc=example,dc=com
 >      cn: Bjorn J Jensen
 >      cn: Bjorn Jensen
 >      objectClass: person
@@ -338,7 +346,7 @@ lines. Here's an example of an LDIF file containing three entries.
 >       ERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVG
 >
 >      # Jennifer's Entry
->      dn: cn=Jennifer J Jensen, dc=example, dc=com
+>      dn: cn=Jennifer J Jensen,dc=example,dc=com
 >      cn: Jennifer J Jensen
 >      cn: Jennifer Jensen
 >      objectClass: person