]> git.sur5r.net Git - openldap/blobdiff - README
fix indentation
[openldap] / README
diff --git a/README b/README
index bbaf0a89876247af16321c012012c7234e24afaf..d03cd424029f829a4019eff67496be5dfaa22483 100644 (file)
--- a/README
+++ b/README
@@ -1,34 +1,85 @@
-OpenLDAP Devel README
-       This software was obtained from the development branch (HEAD) of
-       the OpenLDAP Software Repository.  This copy is likely already
-       not current, the development branch changes frequently.  These
-       changes include code implementing experimental features and
-       unproven bug fixes.  Please do NOT redistribute copies of the
-       development branch.
-
-       The OpenLDAP Developer's FAQ is available at:
-               http://www.openldap.org/faq/index.cgi?file=4
-
-       Client developers seeking a suitable development platform
-       should use "release" or "stable" versions.
-               http://www.openldap.org/software/
-
-Contributing
-
-       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 2.4 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 2.4 release, it includes significant changes from prior
+    releases.
+
+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.21+ (recommended)
+        OpenSSL 0.9.7+ (recommended)
+        POSIX REGEX software (required)
+
+    SLAPD:
+        BDB and HDB backends require Oracle Berkeley DB 4.4, 4.5,
+        4.6, or 4.7.  It is highly recommended to apply the patches
+        from Oracle for a given release.  In addition, for BDB 4.7,
+        it is advised to also use the supplied build/db.4.7.25.patch.
+
+    CLIENTS/CONTRIB ware:
+        Depends on package.  See per package README.
+
+
+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).
+
+
+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>.
+
+    The distribution also includes manual pages for most programs
+    and library APIs.  See ldap(3) for details.
+
+    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/>.
+
+    The OpenLDAP Software FAQ is available at
+    <http://www.openldap.org/faq/>.
+
+
+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.
+
+    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.
+
+
+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.
 
 ---
 $OpenLDAP$
 
 This work is part of OpenLDAP Software <http://www.openldap.org/>.
 
 
 ---
 $OpenLDAP$
 
 This work is part of OpenLDAP Software <http://www.openldap.org/>.
 
-Copyright 1998-2004 The OpenLDAP Foundation.
+Copyright 1998-2008 The OpenLDAP Foundation.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without