]> git.sur5r.net Git - openldap/blobdiff - README
Reflect latest
[openldap] / README
diff --git a/README b/README
index 58d9dd856b726459d7cfe6b51c2196ae30e6a176..c071c83f3603d22ebbb844ed345fb8a7fbe7ae4a 100644 (file)
--- a/README
+++ b/README
@@ -1,76 +1,96 @@
-OpenLDAP 1.0 README
+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 the OpenLDAP version 1.0 distribution.
+    This is 2.2 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
+    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.
+
+    Base system (libraries and tools):
+        Standard C compiler (required)
+        Cyrus SASL 2.1.16+ (recommended)
+        OpenSSL 0.9 (recommended)
+        POSIX REGEX software (required)
+
+    SLAPD:
+        BDB backend requires Sleepycat Berkeley DB 4.2
+        LDBM backend requires a compatible database manager
+            [Berkeley DB, GDBM, etc.]
+
+    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
-
-       % cp Make-common.dist to Make-common
-               Note: if using gmake, instead copy Make-common.gmake 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.
-
-    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.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.gmake
-               contains distribution defaults (with GNU make compatibility).
-               This file can be 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.
-
-       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.
-
-    See the INSTALL file in this directory for more information.
 
 DOCUMENTATION
-
     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:
+    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/
+
+
+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.
+
+    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$
 
-       http://www.OpenLDAP.org/
+This work is part of OpenLDAP Software <http://www.openldap.org/>.
 
-FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
+Copyright 1998-2004 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.