]> git.sur5r.net Git - openldap/blobdiff - README
return to releng
[openldap] / README
diff --git a/README b/README
index 736821d8485050bf0bd5e0a842dc725623e21611..1c89759ae189c21502e54baaece0e9033be39f75 100644 (file)
--- a/README
+++ b/README
@@ -1,89 +1,93 @@
-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.
-
-       Additional developer documents are available in doc/devel,
-               todo list
-               guidelines for developers
-
-       Client developers seeking a stable development platform
-       should use -stable or the latest OpenLDAP release.
-
-
-OpenLDAP Release 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.
-
-       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/software/
+OpenLDAP 2.2 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.2 release, it includes significant changes from prior
+    releases.
 
 REQUIRED SOFTWARE
-       Build OpenLDAP requires the following software components:
+    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, headers, and libraries
-               POSIX REGEX headers and libraries
+    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:
-               LDBM compatible datastore
-                       (Sleepycat Berkeley DB 2.7.4 or GDBM)
+    SLAPD:
+        BDB backend requires (latest) Sleepycat Berkeley DB 4.2
+        LDBM backend requires a compatible database manager
+            [Berkeley DB, GDBM, etc.]
 
-       SLURPD:
-               LTHREAD compatible thread package
-                       (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
+    SLURPD:
+        LTHREAD compatible thread package
+            [POSIX threads, Mach Cthreads, select others]
 
-       LDAPD:
-               ISODE compatible X.500 distribution
+    CLIENTS/CONTRIB ware:
+        Depends on package.  See per package README.
 
-       CLIENTS/CONTRIB ware:
-               Depends on package.  See per package README.
-               
 
 MAKING AND INSTALLING THE DISTRIBUTION
-       Please see the INSTALL file for details.
+    Please see the INSTALL file for basic instructions.  More
+    detailed instructions can be found in the OpenLDAP Admnistrator's
+    Guide (see DOCUMENTATION section).
 
 
 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.
+
+    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 Administrator's Guide and other documentation is
+    available at <http://www.openldap.org/doc/>.
+
+    The OpenLDAP Software FAQ is available at
+    <http://www.openldap.org/faq/>.
 
-       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 home page available that contains the latest
-       LDAP news, releases announcements, pointers to other LDAP resources,
-       etc..  It is located at:
-               http://www.OpenLDAP.org/
+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.
 
-       The OpenLDAP Software FAQ is available at:
-               http://www.openldap.org/faq/index.cgi?file=2
+    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.
 
 
-FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
-       We would appreciate any feedback you can provide.  If you have
-       problems, report them using our Issue Tracking System:
+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.
 
-               http://www.OpenLDAP.com/its/
+---
+$OpenLDAP$
 
-       or by sending e-mail to:
+This work is part of OpenLDAP Software <http://www.openldap.org/>.
 
-               OpenLDAP-its@OpenLDAP.org
+Copyright 1998-2005 The OpenLDAP Foundation.  All rights reserved.
 
-       Additional mailing lists are available.  Please see:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted only as authorized by the OpenLDAP
+Public License.
 
-               http://www.OpenLDAP.com/lists/
+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.