ITS#5409 fix from HEAD

[openldap] / INSTALL

diff --git a/INSTALL b/INSTALL
index 7bd6fa56fb461c874cf605ab071bdea48b2f8072..afc43e8bdd108dec741e2f65f6e23679f8c699b6 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,18 +4,17 @@ Making and Installing the OpenLDAP Distribution
 This file provides brief instructions on how to build and install
 OpenLDAP on UNIX (and UNIX-like) system.  More detailed information
 and instructions can be found in The OpenLDAP Administrator's Guide
 This file provides brief instructions on how to build and install
 OpenLDAP on UNIX (and UNIX-like) system.  More detailed information
 and instructions can be found in The OpenLDAP Administrator's Guide

-(http://www.openldap.org/doc/admin/).
+(available from http://www.openldap.org/doc/).

 
 It is recommended that you read, or at least skim through, ALL of the
 instructions in this file before attempting to build the software.
 
 
 It is recommended that you read, or at least skim through, ALL of the
 instructions in this file before attempting to build the software.
 

-It is also recommended you review Frequently Asked Questions
+It is also recommended you review the Frequently Asked Questions

 (http://www.openldap.org/faq/) pages, in particular the Installation
 section (http://www.openldap.org/faq/index.cgi?file=8) and Platform
 Hints (http://www.openldap.org/faq/index.cgi?file=9) should be
 examined.
 
 (http://www.openldap.org/faq/) pages, in particular the Installation
 section (http://www.openldap.org/faq/index.cgi?file=8) and Platform
 Hints (http://www.openldap.org/faq/index.cgi?file=9) should be
 examined.
 

-

 Making and Installing the OpenLDAP Distribution
 -----------------------------------------------
 
 Making and Installing the OpenLDAP Distribution
 -----------------------------------------------
 


@@ -31,33 +30,39 @@ Making and Installing the OpenLDAP Distribution
 
         % ./configure --help
 
 
         % ./configure --help
 

-     to list available configuration options.   A description of these
-     options is provided in the 'CONFIGURE OPTIONS' section below.
+     to list available configuration options.

 
 

-     The configure script uses environmental variables for determining
-     compiler/linker options including:
+     Note also that the configure script uses environmental variables
+     for determining compiler/linker options including:

 
         Variable        Description     Example
         CC              C compiler      gcc
         CFLAGS          C flags         -O -g
 
         Variable        Description     Example
         CC              C compiler      gcc
         CFLAGS          C flags         -O -g

-        CPPFLAGS        cpp flags       -I/path/include -Ddef
+        CPPFLAGS        cpp flags       -I/path/include -DFOO=42

         LDFLAGS         ld flags        -L/usr/local/lib
         LIBS            libraries       -llib
         PATH            command path    /usr/local/bin:/usr/bin:/bin
 
         LDFLAGS         ld flags        -L/usr/local/lib
         LIBS            libraries       -llib
         PATH            command path    /usr/local/bin:/usr/bin:/bin
 

-3.   Configure the build system
+     See doc/install/configure for generic configure documentation.
+
+3.   Configure the build system:

 
         % [env settings] ./configure [options]
 
 
         % [env settings] ./configure [options]
 

-     If all goes well, the configure script with automatically detect
-     the appropriate settings.  However, you may need to specify
-     options and/or environment variables to obtain desired results.
+     If all goes well, the configure script will automatically detect
+     the appropriate settings.  If the configure script fails, you
+     should read the config.log file that it generated to see what it
+     was trying to do and exactly what failed.  You may need to specify
+     additional options and/or environment variables besides those
+     listed above to obtain desired results, depending on your operating
+     system. The Platform Hints section of the FAQ provides help for
+     operating system related problems.

 
 

-4.   Build dependencies
+4.   Build dependencies:

 
         % make depend
 
 
         % make depend
 

-5.   Build the system
+5.   Build the system:

 
         % make
 
 
         % make
 


@@ -66,25 +71,25 @@ Making and Installing the OpenLDAP Distribution
      may want to consult the Platform Hints subsection of the FAQ if
      you have not done so already.
 
      may want to consult the Platform Hints subsection of the FAQ if
      you have not done so already.
 

-6.   Test the standalone system
+6.   Test the standalone system:

 
      This step requires the standalone LDAP server, slapd(8), with
 
      This step requires the standalone LDAP server, slapd(8), with

-     LDBM support.
+     BDB or HDB support.

 
         % make test
 
      If all goes well, the system has been built as configured.  If
 
         % make test
 
      If all goes well, the system has been built as configured.  If

-     not, return to step 4 after reviewing your configuration
+     not, return to step 2 after reviewing your configuration

      settings.  You may want to consult the Installation section of
      the FAQ if you have not done so already.
 
      settings.  You may want to consult the Installation section of
      the FAQ if you have not done so already.
 

-7.   install the binaries and man pages.  You may need to be come the
-     super-user (e.g. root) to do this (depending on where you are
-     installing things):
+7.   Install the software.  You may need to be come the super-user
+     (e.g. root) to do this (depending on where you are installing
+     things):

 
         % su root -c 'make install'
 
 
         % su root -c 'make install'
 

-8.   That's it!
+8.   That's it.  Enjoy!

 
 See the OpenLDAP Administrator's Guide and the manual pages for the
 individual applications for configuration and use information. You may
 
 See the OpenLDAP Administrator's Guide and the manual pages for the
 individual applications for configuration and use information. You may


@@ -96,9 +101,21 @@ configuration directory (normally /usr/local/etc/openldap).
         slapd.conf              Standalone LDAP daemon
         schema/*.schema         Schema Definitions
 
         slapd.conf              Standalone LDAP daemon
         schema/*.schema         Schema Definitions
 

+---
+$OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.16 2002/02/18
+17:09:26 kurt Exp $
+
+This work is part of OpenLDAP Software <http://www.openldap.org/>.
+
+Copyright 1998-2008 The OpenLDAP Foundation.
+All rights reserved.

 
 

-End of OpenLDAP INSTALL file.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted only as authorized by the OpenLDAP
+Public License.

 
 

-$OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.12 2000/09/09
-21:16:09 kurt Exp $
+A copy of this license is available in the file LICENSE in the
+top-level directory of the distribution or, alternatively, at
+<http://www.OpenLDAP.org/license.html>.

 
 

+OpenLDAP is a registered trademark of the OpenLDAP Foundation.