ITS#1958 from Andrew Findlay with minor adjustments

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

diff --git a/doc/guide/admin/quickstart.sdf b/doc/guide/admin/quickstart.sdf
index 635e7775d611c734ab6431332e206fae8437000a..ea196da4eebf7aa853c8960fa2bbf6806509afce 100644 (file)
--- a/doc/guide/admin/quickstart.sdf
+++ b/doc/guide/admin/quickstart.sdf
@@ -7,12 +7,12 @@ H1: A Quick-Start Guide
 The following is a quick start guide to OpenLDAP 2.1 software,
 including the stand-alone LDAP daemon, {{slapd}}(8).
 
-It is meant to step you through the basic steps needed to install
+It is meant to walk you through the basic steps needed to install
 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.
@@ -70,7 +70,7 @@ software and installation procedures.
 +{{B: Run {{EX:configure}}}}
 
 . You will need to run the provided {{EX:configure}} script to
-{{configure}} to the distribution for building on your system.  The
+{{configure}} the distribution for building on your system.  The
 {{EX:configure}} script accepts many command line options that enable or
 disable optional software features.  Usually the defaults are okay,
 but you may want to change them.  To get a complete list of options
@@ -78,8 +78,8 @@ that {{EX:configure}} accepts, use the {{EX:--help}} option:
 
 ..{{EX:./configure --help}}
 
-. However, given that you using this guide, we'll assume you'll
-are brave enough to just let {{EX:configure}} to determine
+. However, given that you are using this guide, we'll assume you
+are brave enough to just let {{EX:configure}} determine
 what's best:
 
 ..{{EX:./configure}}
@@ -122,8 +122,8 @@ be skipped.
 .{{S: }}
 +{{B:Install the software}}.
 
-. You are now ready to install the software, this usually requires
-{{super-user}} privledges: 
+. You are now ready to install the software; this usually requires
+{{super-user}} privileges: 
 
 ..{{EX:su root -c 'make install'}}
 
@@ -136,38 +136,41 @@ whatever installation prefix was used by {{EX:configure}}).
 
 . Use your favorite editor to edit the provided {{slapd.conf}}(5)
 example (usually installed as {{F:/usr/local/etc/openldap/slapd.conf}})
-to contain an LDBM database definition of the form:
+to contain a BDB database definition of the form:
 
-..{{EX:database        ldbm}}
+..{{EX:database        bdb}}
 ..{{EX:suffix          "dc=<MY-DOMAIN>,dc=<COM>"}}
 ..{{EX:rootdn          "cn=Manager,dc=<MY-DOMAIN>,dc=<COM>"}}
 ..{{EX:rootpw          secret}}
-..{{EX:directory       /usr/local/var/openldap-ldbm}}
+..{{EX:directory       /usr/local/var/openldap-data}}
 
 . Be sure to replace {{EX:<MY-DOMAIN>}} and {{EX:<COM>}} with
 the appropriate domain components of your domain name.  For
 example, for {{EX:example.com}}, use:
 
-..{{EX:database        ldbm}}
+..{{EX:database        bdb}}
 ..{{EX:suffix          "dc=example,dc=com"}}
 ..{{EX:rootdn          "cn=Manager,dc=example,dc=com"}}
 ..{{EX:rootpw          secret}}
-..{{EX:directory       /usr/local/var/openldap-ldbm}}
+..{{EX:directory       /usr/local/var/openldap-data}}
 
 .If your domain contains additional components, such as
 {{EX:eng.uni.edu.eu}}, use:
 
-..{{EX:database        ldbm}}
+..{{EX:database        bdb}}
 ..{{EX:suffix          "dc=eng,dc=uni,dc=edu,dc=eu"}}
 ..{{EX:rootdn          "cn=Manager,dc=eng,dc=uni,dc=edu,dc=eu"}}
 ..{{EX:rootpw          secret}}
-..{{EX:directory       /usr/local/var/openldap-ldbm}}
+..{{EX:directory       /usr/local/var/openldap-data}}
 
 . Details regarding configuring {{slapd}}(8) can be found
 in the {{slapd.conf}}(5) manual page and the
 {{SECT:The slapd Configuration File}} chapter of this
 document.
 
+Note: the directory specified must exist prior to starting slapd(8).
+
+
 .{{S: }}
 +{{B:Start SLAPD}}.
 
@@ -244,7 +247,7 @@ For example, for {{EX:example.com}}, use:
 
 . where {{F:example.ldif}} is the file you created above.
 ..{{EX: }}
-. Additional informaton regarding directory creation can be found
+. Additional information regarding directory creation can be found
 in the {{SECT:Database Creation and Maintenance Tools}} chapter of
 this document.
 
@@ -269,8 +272,8 @@ to everybody}} excepting the {{super-user}} (as specified by the
 {{EX:rootdn}} configuration directive).  It is highly recommended
 that you establish controls to restrict access to authorized users.
 Access controls are discussed in the {{SECT:Access Control}} section
-of the {{SECT:The slapd Configuration File}} chapter.  You are also
-encouraged to read {{SECT:Security Considerations}}, {{SECT:Using
+of {{SECT:The slapd Configuration File}} chapter.  You are also
+encouraged to read the {{SECT:Security Considerations}}, {{SECT:Using
 SASL}} and {{SECT:Using TLS}} sections.
 
 The following chapters provide more detailed information on making,