X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=README;h=db0b39c4417fb1b1ebe1ec0c17a256371ccd5c98;hb=refs%2Fheads%2FOPENLDAP_REL_ENG_2_3;hp=18dc27e56af63dcbee8d3fb93a63b849a638d757;hpb=9a8cc65162b67dc32a707ebd269b85cc477419a4;p=openldap diff --git a/README b/README index 18dc27e56a..db0b39c441 100644 --- a/README +++ b/README @@ -1,86 +1,96 @@ -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.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. - Additional developer documents are available in doc/devel, - todo list - guidelines for developers + This is 2.3 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.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. -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. + SLURPD: + LTHREAD compatible thread package + [POSIX threads, Mach Cthreads, select others] - 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/ + CLIENTS/CONTRIB ware: + Depends on package. See per package README. -REQUIRED SOFTWARE - Build OpenLDAP requires the following software components: +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). - Base system (libraries and tools): - Standard C compiler, headers, and libraries - POSIX REGEX headers and libraries - SLAPD: - LDBM compatible datastore - (Sleepycat Berkeley DB 2.7.5 or GDBM) +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 + . - SLURPD: - LTHREAD compatible thread package - (POSIX threads, Mach Cthreads, Sun LWP, or GNU Pth) + The distribution also includes manual pages for most programs + and library APIs. See ldap(3) for details. - CLIENTS/CONTRIB ware: - Depends on package. See per package README. - + The OpenLDAP website is available and contains the latest LDAP + news, releases announcements, pointers to other LDAP resources, + etc.. It is located at . -MAKING AND INSTALLING THE DISTRIBUTION - Please see the INSTALL file for details. + The OpenLDAP Software FAQ is available at + . -DOCUMENTATION - There are man pages for most programs in the distribution and - routines in the various libraries. See ldap(3) for details. +SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS + OpenLDAP Software is user supported. If you have problems, please + review the OpenLDAP FAQ and + archives of the OpenLDAP-software and OpenLDAP-bugs mailing lists + . If you cannot find the answer, + please enquire on the OpenLDAP-software 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 + Issues, such as bug reports, should be reported using our our + Issue Tracking System . Do not + use this system for software enquiries. Please direct these + to an appropriate mailing list. - 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/ - The OpenLDAP Quick Start Guide is available at: - http://www.openldap.org/faq/index.cgi?file=172 +CONTRIBUTING + See 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 mailing list + prior to submission, it is noted that contributions must be + submitted using the Issue Tracking System + to be considered. - The OpenLDAP Software FAQ is available at: - http://www.openldap.org/faq/index.cgi?file=2 +--- +$OpenLDAP$ +This work is part of OpenLDAP Software . -SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS - OpenLDAP is user supported. If you have problems, please - review the OpenLDAP FAQ and - archives of the OpenLDAP-software and OpenLDAP-bugs mailing - lists . - - Issues, such as bug reports, should be reported using our - our Issue Tracking System 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. +Copyright 1998-2008 The OpenLDAP Foundation. +All rights reserved. + +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 +. + +OpenLDAP is a registered trademark of the OpenLDAP Foundation.