Some gcc -W... cleanup

[openldap] / README

diff --git a/README b/README
index 02dc5def9a153c1b0b5809bc39fca6cce9cb7cba..750f5e5c9cc62e2c337dc02021d43b723ceca7e9 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,12 @@
+OpenLDAP Devel README
+       OpenLDAP -devel is for the development of OpenLDAP.  As such,
+       it changes often.  These changes include changes in functionality
+       and unproven bug fixes.  Many of these changes will cause
+       previous working programs to fail.
+
+       Client developers seeking a stable development platform
+       should use -stable.
+
 OpenLDAP 1.0 README
 
     This is the OpenLDAP version 1.0 distribution.
@@ -11,34 +20,59 @@ OpenLDAP 1.0 README
        For more information:
                http://www.OpenLDAP.org/
 
+REQUIRED SOFTWARE
+       Build OpenLDAP requires the following software components:
+
+       Base system (libraries and tools):
+               Standard C compiler, headers, and libraries
+               POSIX REGEX headers and libraries
+
+       SLAPD:
+               LDBM compatible datastore
+                       (Berkeley DB, Sleepycat DB2, or GDBM)
+       SLURPD:
+               LTHREAD compatible thread package
+                       (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
+
+       LDAPD:
+               ISODE compatible ldap distribution
+
+       CLIENTS/CONTRIBware:
+               Depends on package.  See per package READMEs.
+               
+
 MAKING AND INSTALLING THE DISTRIBUTION
 
-    You should be able to make and install the distribution with a pretty
-    standard default configuration by typing the following commands
+    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
+
+       % make depend
+               this will create dependency information
 
-       % make
-               this will copy Make-common.dist to Make-common.
-               Edit Make-common as desired.
        % make 
                this will build the system
+
        % su
        # make install
 
     in this directory.  This should produce something that basically
-    works.
+    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 two files you might want to edit:
-
-       Make-common
-               contains default definitions for where things will be
-               installed, where to find various things, etc.  These defaults
-               are used in absense of platform-specific defaults.  You may
-               hardcode settings in Make-common if you desire.  You will
-               need to edit this file to enable optional features.
-
-       build/*/Make-platform
-               contains platform-specific defaults.
+    site, though.  There are one file you might want to edit:
 
        include/ldapconfig.h.edit
                This file contains #defines used by many parts of the