]> git.sur5r.net Git - openldap/blobdiff - README
More for 2.2beta
[openldap] / README
diff --git a/README b/README
index 1236676d417fc2aeeaa1c350cb0828e6c85f2778..41e31124f87c34a02625a074906a6a30a158f300 100644 (file)
--- a/README
+++ b/README
@@ -1,70 +1,83 @@
-OpenLDAP 1.0 README
+OpenLDAP 2.2 README
 
-    This is the OpenLDAP version 1.0 distribution.
+    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 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.
+    This is 2.2 release, it includes significant changes from
+       prior releases.
 
-       For more information:
-               http://www.OpenLDAP.org/
-
-MAKING AND INSTALLING THE DISTRIBUTION
+REQUIRED SOFTWARE
+       Build OpenLDAP requires a number of software packages to be
+       preinstalled.  Additional information regarding prerequisite
+       software can be found in the OpenLDAP Administrator's Guide.
 
-    You should be able to make and install the distribution with a pretty
-    standard default configuration by typing the following commands
+       Base system (libraries and tools):
+               Standard C compiler (required)
+               Cyrus SASL 2.1.3+ (recommended)
+               OpenSSL 0.9 (recommended)
+               POSIX REGEX software (required)
 
-       % ./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)
+       SLAPD:
+               BDB backend requires Sleepycat Berkeley DB 4.1
+               LDBM backend requires a compatible database manager
+                       [Berkeley DB, GDBM, etc.]
 
-       % [env settings] ./configure [options]
-               this will configure the build system
+       SLURPD:
+               LTHREAD compatible thread package
+                       [POSIX threads, Mach Cthreads, select others]
 
-       % make depend
-               this will create dependency information
+       CLIENTS/CONTRIB ware:
+               Depends on package.  See per package README.
 
-       % make 
-               this will build the system
 
-       % su
-       # make install
+MAKING AND INSTALLING THE DISTRIBUTION
+       Please see the INSTALL file for basic instructions.  More
+       detailed instructions can be found in the OpenLDAP
+       Admnistrator's Guide (see DOCUMENTATION section).
 
-    in this directory.  This should produce something that basically
-    works.
 
-    You will probably want to do a little configuration to suit your
-    site, though.  There are one file you might want to edit:
+DOCUMENTATION
+       There are man pages for most programs in the distribution and
+       routines in the various libraries.  See ldap(3) for details.
 
-       include/ldapconfig.h.edit
-               This file contains #defines used by many parts of the
-               distribution.  You'll at least want to change DEFAULT_BASE.
+       The OpenLDAP website is available and contains the latest LDAP
+       news, releases announcements, pointers to other LDAP resources,
+       etc..  It is located at:
+               http://www.OpenLDAP.org/
 
-    See the INSTALL file in this directory for more information.
+       The OpenLDAP Administrator's Guide and other documentation
+       is available at:
+               http://www.openldap.org/doc/
 
-DOCUMENTATION
+       The OpenLDAP Software FAQ is available at:
+               http://www.openldap.org/faq/index.cgi
 
-    There are man pages for most programs in the distribution and
-    routines in the various libraries.  See ldap(3) for details.
 
-    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:
+SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
+       OpenLDAP is user supported.  If you have problems, please
+       review the OpenLDAP FAQ <http://www.openldap.org/faq/> and
+       archives of the OpenLDAP-software and OpenLDAP-bugs mailing
+       lists <http://www.openldap.org/lists/>.  If you cannot find
+       the answer, please enquire on the OpenLDAP-software list.
 
-       http://www.OpenLDAP.org/
+       Issues, such as bug reports, should be reported using our
+       our Issue Tracking System <http://www.OpenLDAP.org/its/> or
+       by sending mail to <OpenLDAP-its@OpenLDAP.org>.  Do not use
+       this system for software enquiries.  Please direct these
+       to an appropriate mailing list.
 
-FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
 
-    We would appreciate any feedback you can provide.  If you have
-    problems, report them to this address:
+CONTRIBUTING
 
-       OpenLDAP-bugs@OpenLDAP.org
+       See http://www.openldap.org/devel/contributing.html for how to
+       contribute code or documentation to OpenLDAP.  Use the Issue Tracking
+       System <http://www.openldap.org/its/> to submit contributions.
+       While you are encouraged to coordinate and discuss the development
+       activities on the openldap-devel@openldap.org mailing list prior
+       to submission, it is noted that contributions must be submitted
+       using the Issue Tracking System to be considered.
 
+---
+$OpenLDAP$