-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.
+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.
- Additional developer documents are available in doc/devel,
- todo list
- guidelines for developers
+ This is 2.4 release, it includes significant changes from prior
+ releases.
- Client developers seeking a stable development platform
- should use an OpenLDAP release.
+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.
- The OpenLDAP Developer's FAQ is available at:
- http://www.openldap.org/faq/index.cgi?file=4
+ Base system (libraries and tools):
+ Standard C compiler (required)
+ Cyrus SASL 2.1.21+ (recommended)
+ OpenSSL 0.9.7+ (recommended)
+ Reentrant POSIX REGEX software (required)
+ SLAPD:
+ BDB and HDB backends require Oracle Berkeley DB 4.4 - 4.8,
+ or 5.0 - 5.1. It is highly recommended to apply the
+ patches from Oracle for a given 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.
+ CLIENTS/CONTRIB ware:
+ Depends on package. See per package README.
- For a more detailed description of how to make an install the
- distribution, see the INSTALL file in this directory. Additional
- installation information can be found on the OpenLDAP website:
- 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).
-REQUIRED SOFTWARE
- Build OpenLDAP requires the following software components:
- Base system (libraries and tools):
- Standard C compiler, headers, and libraries
- POSIX REGEX headers and libraries
+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>.
- SLAPD:
- LDBM compatible datastore
- (Sleepycat Berkeley DB 2.7.5 or GDBM)
+ The distribution also includes manual pages for most programs
+ and library APIs. See ldap(3) for details.
- SLURPD:
- LTHREAD compatible thread package
- (POSIX threads, Mach Cthreads, Sun LWP, or GNU Pth)
+ 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/>.
- CLIENTS/CONTRIB ware:
- Depends on package. See per package README.
-
+ The OpenLDAP Software FAQ is available at
+ <http://www.openldap.org/faq/>.
-MAKING AND INSTALLING THE DISTRIBUTION
- Please see the INSTALL file for details.
+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.
-DOCUMENTATION
- There are man pages for most programs in the distribution and
- routines in the various libraries. See ldap(3) for details.
+ Issues, such as bug reports, should be reported using 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.
- 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/
+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.
- The OpenLDAP Quick Start Guide is available at:
- http://www.openldap.org/faq/index.cgi?file=172
+---
+$OpenLDAP$
- The OpenLDAP Software FAQ is available at:
- http://www.openldap.org/faq/index.cgi?file=2
+This work is part of OpenLDAP Software <http://www.openldap.org/>.
+Copyright 1998-2013 The OpenLDAP Foundation.
+All rights reserved.
-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/>.
-
- Issues, such as bug reports, should be reported using our
- our Issue Tracking System <http://www.OpenLDAP.com/its/> or
- by sending mail to OpenLDAP-its@OpenLDAP.org. Do not use
- this system for general or software equiries. Please direct
- these to the appropriate mailing list.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted only as authorized by the OpenLDAP
+Public License.
+
+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.