Cleanup grammar, etc.

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

diff --git a/doc/guide/admin/dbtools.sdf b/doc/guide/admin/dbtools.sdf
index 02cb58130c2a36e6dfdb13284c0a8ef7878fc54d..a829a9bb8b0308e332b36f7d7e57c8874c8feacc 100644 (file)
--- a/doc/guide/admin/dbtools.sdf
+++ b/doc/guide/admin/dbtools.sdf
@@ -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
@@ -83,6 +83,7 @@ could be used:
 >      index cn,sn,uid
 >      index objectClass pres,eq
 
+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
@@ -91,18 +92,18 @@ using the {{I:ldapadd}} tool, you could create an {{TERM:LDIF}} file
 called {{EX:entries.ldif}} with the contents:
 
 >      # Organization for Example Corporation
->      dc=example, dc=com
->      objectClass=dcObject
->      objectClass=organization
->      dc=example
->      o=Example Corporation
->      description=The Example Corporation
+>      dn: dc=example,dc=com
+>      objectClass: dcObject
+>      objectClass: organization
+>      dc: example
+>      o: Example Corporation
+>      description: The Example Corporation
 >
 >      # Organizational Role for Directory Manager
->      cn=Manager, dc=example, dc=com
->      objectClass=organizationalRole
->      cn=Manager
->      description=Directory Manager
+>      dn: cn=Manager,dc=example,dc=com
+>      objectClass: organizationalRole
+>      cn: Manager
+>      description: Directory Manager
 
 and then use a command like this to actually create the entry:
 
@@ -131,7 +132,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 +141,28 @@ 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,sub
 >      index objectClass eq
 
-This would create presence, equality and approximate indexes for
+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 the configuration
-file section for more information on this option.
+index for the {{EX:objectClass}} attribute. 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>
@@ -177,7 +179,7 @@ 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 +191,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}}.
 
@@ -287,14 +289,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.,
@@ -314,20 +316,20 @@ You can also specify a {{TERM:URL}} containing the attribute value.
 For example, the following specifies the {{EX:jpegPhoto}} value
 should be obtained from the file {{F:/path/to/file.jpeg}}.
 
->      cn:< file://path/to/file.jpeg
+>      cn:< file:///path/to/file.jpeg
 
 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,13 +340,13 @@ 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
 >      sn: Jensen
 >      # JPEG photo from file
->      jpegPhoto:< file://path/to/file.jpeg
+>      jpegPhoto:< file:///path/to/file.jpeg
 
 Notice that the {{EX:jpegPhoto}} in Bjorn's entry is base 64 encoded
 and the {{EX:jpegPhoto}} in Jennifer's entry is obtained from the