Statement concerning appropriate use of I-D.

[openldap] / INSTALL

diff --git a/INSTALL b/INSTALL
index 1aaec4a207b968efecc1e2e4f1659bed046bd064..8f3685d0857610aeeb8a3b74c2e49ee2f53b732b 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,11 +4,15 @@ Making and Installing the OpenLDAP Distribution
 ** It is recommended that you read or at least skim through ALL of the
 ** instructions in this file before attempting to build the software.
 **
+** A Quick Start Guide, which may be used in conjunction with this
+** document, is available at:
+**    http://www.openldap.org/faq/index.cgi?file=172
+**
 ** The OpenLDAP Installation FAQ is available at:
 **    http://www.openldap.org/faq/index.cgi?file=8
 **
-** You should also check for platform specific hints.
-** These are located in doc/install/hints or:
+** You should also check for platform specific hints located on
+** on our web site.
 **    http://www.openldap.org/faq/index.cgi?file=9
 **
 
@@ -22,9 +26,10 @@ these steps:
  1. untar the distribution and cd to the top:
 
        % tar xfz openldap-VERSION.tgz
-       % cd ldap
+       % cd openldap-VERSION
 
-    If you are reading this file, you probably have already done this!
+       replacing VERSION to match the version you downloaded.  If you are
+       reading this file, you probably have already done this!
 
  2. Type:
        % ./configure --help
@@ -47,12 +52,7 @@ these steps:
        See the 'USING ENVIRONMENT VARIABLES' section for information
        on how to use the variables. 
 
- 3. edit the file include/ldapconfig.h.edit to configure
-    the software for your site (the files are well-commented):
-
-       % vi include/ldapconfig.h.edit
-
- 4. Configure the build system
+ 3. Configure the build system
 
        % [env settings] ./configure [options]
 
@@ -60,11 +60,11 @@ these steps:
        appropriate settings.  Use configure enable/with options and/or
        environment variables to obtain desired results.
 
- 5. Build dependencies
+ 4. Build dependencies
 
        % make depend
 
- 6. Build the system
+ 5. Build the system
 
        % make
 
@@ -74,13 +74,13 @@ these steps:
        You may want to consult the doc/install/hints file for your
        platform.
 
- 7. Test the standalone system
+ 6. Test the standalone system
 
        This step requires the standalone LDAP server (slapd) with
        LDBM support.
 
        % cd tests
-       % make
+       % make test
 
        If all goes well, the system has been built as configured.  If not,
        return to step 4 after reviewing your configuration settings.
@@ -88,7 +88,7 @@ these steps:
        You may want to consult the doc/install/hints file for your
        platform.
 
- 8. install the binaries and man pages.  You may need to be superuser to
+ 7. install the binaries and man pages.  You may need to be superuser to
     do this (depending on where you are installing things):
 
        % su
@@ -102,19 +102,17 @@ these steps:
        These configuration files are located in the OpenLDAP
        configuration directory (normally /usr/local/etc/openldap).
 
-       ldap.conf            - LDAP defaults
-       ldapfilter.conf      - search filter configuration
-       ldapsearchprefs.conf - search object definitions
-       ldaptemplates.conf   - display template definitions
-
-    There are section 5 man pages for all of these files.
+       Client configuration files:
+         ldap.conf            - client defaults
+         ldapfilter.conf      - search filter configuration
+         ldapsearchprefs.conf - search object definitions
+         ldaptemplates.conf   - display template definitions
 
- 9. edit client configuration files as needed.
-       See ldap.conf(5) for details.
+       Server configuration files:
+         ldapd.conf           - LDAP - X.500 daemon
+         slapd.conf           - Standalone LDAP daemon
 
-10. edit server configuration files as needed.
-       See slapd.conf(5) if running slapd.
-       See ldapd.conf(5) if running ldapd.
+    There are section 5 man pages for all of these files.
 
 
 Building LDAP For More Than One Platform
@@ -172,10 +170,11 @@ Supported Environmental Variables
 
 * Including alternative compilers
        Use the CC environment variable to tell configure to
-       use a specific compiler.  For example, to use ecgs
-       instead of the compiler configure choose, use:
+       use a specific compiler.  For example, to use GNU
+       C Compiler instead of the compiler configure choose,
+       use:
 
-       [env] CC=egcc ./configure 
+       [env] CC=gcc ./configure 
 
        You can also use CC use specific flags with the
        specified compiler.  For example, to require strict