]> git.sur5r.net Git - openldap/blobdiff - README
Fix prev commit
[openldap] / README
diff --git a/README b/README
index 405dcfbcc3fa49c87a9ee59cd5cbb0fc5ecdc683..db0b39c4417fb1b1ebe1ec0c17a256371ccd5c98 100644 (file)
--- a/README
+++ b/README
@@ -1,71 +1,96 @@
-OpenLDAP 1.0 README
+OpenLDAP 2.3 README
+    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.
 
-    This is the OpenLDAP version 1.0 distribution.
+    This is 2.3 release, it includes significant changes from prior
+    releases.
 
-       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.
+REQUIRED SOFTWARE
+    Building OpenLDAP Software requires a number of software packages
+    to be preinstalled.  Additional information regarding prerequisite
+    software can be found in the OpenLDAP Administrator's Guide.
+
+    Base system (libraries and tools):
+        Standard C compiler (required)
+        Cyrus SASL 2.1.18+ (recommended)
+        OpenSSL 0.9.7+ (recommended)
+        POSIX REGEX software (required)
+
+    SLAPD:
+        BDB and HDB backends require Oracle Berkeley DB 4.2, 4.4,
+        or 4.5.  It is highly recommended to apply the patches
+        from Oracle for a given release.
+
+    SLURPD:
+        LTHREAD compatible thread package
+            [POSIX threads, Mach Cthreads, select others]
+
+    CLIENTS/CONTRIB ware:
+        Depends on package.  See per package README.
 
-       For more information:
-               http://www.OpenLDAP.org/
 
 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).
 
-    You should be able to make and install the distribution with a pretty
-    standard default configuration by typing the following commands
 
-       % make
-               this will copy Make-common.dist to Make-common.
-               Edit Make-common as desired.
-       % make 
-               this will build the system
-       % su
-       # make install
+DOCUMENTATION
+    The OpenLDAP Administrator's Guide is available in the
+    guide.html file in the doc/guide/admin directory.  The
+    guide and a number of other documents are available at
+    <http://www.openldap.org/doc/admin/guide.html>.
 
-    in this directory.  This should produce something that basically
-    works.
+    The distribution also includes manual pages for most programs
+    and library APIs.  See ldap(3) for details.
 
-    You will probably want to do a little configuration to suit your
-    site, though.  There are two files you might want to edit:
+    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/>.
 
-       Make-common.dist
-               contains distribution defaults.  This file is used to
-               contruct Make-common and should not be edited except to
-               add new features/options to the distribution.
-       
-       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.
+    The OpenLDAP Software FAQ is available at
+    <http://www.openldap.org/faq/>.
 
-       build/*/Make-platform
-               contains platform-specific defaults.
 
-       include/ldapconfig.h.edit
-               This file contains #defines used by many parts of the
-               distribution.  You'll at least want to change DEFAULT_BASE.
+SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
+    OpenLDAP Software 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.
 
-    See the INSTALL file in this directory for more information.
+    Issues, such as bug reports, should be reported using our our
+    Issue Tracking System <http://www.OpenLDAP.org/its/>.  Do not
+    use this system for software enquiries.  Please direct these
+    to an appropriate mailing list.
 
-DOCUMENTATION
 
-    There are man pages for most programs in the distribution and
-    routines in the various libraries.  See ldap(3) for details.
+CONTRIBUTING
+    See <http://www.openldap.org/devel/contributing.html> for
+    information regarding how to contribute code or documentation
+    to the OpenLDAP Project for inclusion in OpenLDAP Software.
+    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
+    <http://www.openldap.org/its/> to be considered.
 
-    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:
+---
+$OpenLDAP$
 
-       http://www.OpenLDAP.org/
+This work is part of OpenLDAP Software <http://www.openldap.org/>.
 
-FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
+Copyright 1998-2008 The OpenLDAP Foundation.
+All rights reserved.
 
-    We would appreciate any feedback you can provide.  If you have
-    problems, report them to this address:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted only as authorized by the OpenLDAP
+Public License.
 
-       OpenLDAP-bugs@OpenLDAP.org
+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.