Updated SLAPD args/pid file codes to use DEFAULT_RUNDIR and DEFAULT_DIRSEP.

[openldap] / README

diff --git a/README b/README
index 750f5e5c9cc62e2c337dc02021d43b723ceca7e9..04eb6cef7539abfa3aa772d51ad283153cacc774 100644 (file)
--- a/README
+++ b/README
@@ -4,21 +4,30 @@ OpenLDAP Devel README
        and unproven bug fixes.  Many of these changes will cause
        previous working programs to fail.
 
+       Additional developer documents are available in doc/devel,
+               todo list
+               guidelines for developers
+
        Client developers seeking a stable development platform
-       should use -stable.
+       should use -stable or the latest OpenLDAP release.
 
-OpenLDAP 1.0 README
 
-    This is the OpenLDAP version 1.0 distribution.
+OpenLDAP 1.1.1 README
+       This is the OpenLDAP Release 1.1.1.
 
        For a description of what this distribution contains, see the
        ANNOUNCEMENT file in this directory.  For a description of
        changes from previous releases, see the CHANGES file in this
-       directory.  For a more detailed description of how to make an
-       install the distribution, see the INSTALL file in this directory.
+       directory.
+
+       For a more detailed description of how to make an install the
+       distribution, see the INSTALL file in this directory.  Additional
+       installation information, such as per platform hints can be found
+       in the doc/install directory.
 
        For more information:
-               http://www.OpenLDAP.org/
+               http://www.OpenLDAP.org/software/
+
 
 REQUIRED SOFTWARE
        Build OpenLDAP requires the following software components:
@@ -29,35 +38,24 @@ REQUIRED SOFTWARE
 
        SLAPD:
                LDBM compatible datastore
-                       (Berkeley DB, Sleepycat DB2, or GDBM)
+                       (Berkeley DB, Sleepycat Berkeley DB 2.3.16, or GDBM)
+
        SLURPD:
                LTHREAD compatible thread package
                        (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
 
        LDAPD:
-               ISODE compatible ldap distribution
+               ISODE compatible X.500 distribution
 
-       CLIENTS/CONTRIBware:
-               Depends on package.  See per package READMEs.
+       CLIENTS/CONTRIB ware:
+               Depends on package.  See per package README.
                
 
 MAKING AND INSTALLING THE DISTRIBUTION
+       This is a quick guide.  For details, see the INSTALL file.
 
-    You should be able to make and install the distribution with a
-    default configuration by typing the following commands:
-
-       % ./configure --help
-               This will list the available options.
-               The configure script will also use your environmental
-               variables for determining compiler/linker options.
-               These environment variables are used:
-                       CC                      C compiler      (cc, ecgs)
-                       CFLAGS          C Flags         (-ansi)
-                       CPPFLAGS        CPP Flags       (-I -D)
-                       LDFLAGS         LDFLAGS         (-L -l)
-
-       % [env settings] ./configure [options]
-               this will configure the build system
+       % ./configure
+               configure OpenLDAP for current platform
 
        % make depend
                this will create dependency information
@@ -68,33 +66,41 @@ MAKING AND INSTALLING THE DISTRIBUTION
        % su
        # make install
 
-    in this directory.  This should produce something that basically
-    works.  You can "cd tests; make" to verify the build.
+       in this directory.  This should produce something that basically
+       works.  You can "cd tests; make" to verify the build.
 
-    You will probably want to do a little configuration to suit your
-    site, though.  There are one file you might want to edit:
+       See the INSTALL file in this directory for more information.
 
-       include/ldapconfig.h.edit
-               This file contains #defines used by many parts of the
-               distribution.  You'll at least want to change DEFAULT_BASE.
-
-    See the INSTALL file in this directory for more information.
 
 DOCUMENTATION
+       There are man pages for most programs in the distribution and
+       routines in the various libraries.  See ldap(3) for details.
 
-    There are man pages for most programs in the distribution and
-    routines in the various libraries.  See ldap(3) for details.
+       Additional documentation can be found in the doc directory.
+               doc/devel   Developer Information
+               doc/drafts  LDAP-related IETF drafts
+               doc/install Installation and Integration
+               doc/man  Raw man(1) pages
+               doc/rfcs        LDAP-related Request for Comments
 
-    There is an OpenLDAP homepage available that contains the latest
-    LDAP news, releases announcements, pointers to other LDAP resources,
-    etc. You can access it at this URL:
+       There is an OpenLDAP homepage available that contains the latest
+       LDAP news, releases announcements, pointers to other LDAP resources,
+       etc. You can access it at this URL:
 
        http://www.OpenLDAP.org/
 
+
 FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
+       We would appreciate any feedback you can provide.  If you have
+       problems, report them using our Issue Tracking System:
+
+               http://www.OpenLDAP.com/its/
+
+       or by sending e-mail to:
+
+               OpenLDAP-its@OpenLDAP.org
 
-    We would appreciate any feedback you can provide.  If you have
-    problems, report them to this address:
+       Additional mailing lists are available.  Please see:
 
-       OpenLDAP-bugs@OpenLDAP.org
+               http://www.OpenLDAP.com/lists/