X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=README;h=febbe26822380c23ac81bee6ecf61c85b05d09c4;hb=5a87770793eb6e58dad7431ee30607f07a363705;hp=1529e000edbc3eb0a305069671231217e72051c4;hpb=05059be1908132d52da5a357427fb42a364fd2f1;p=openldap diff --git a/README b/README index 1529e000ed..febbe26822 100644 --- a/README +++ b/README @@ -1,104 +1,92 @@ -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. - - -OpenLDAP 1.1 Alpha README - This is the OpenLDAP version 1.1 Alpha. - - 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/ +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 - Build OpenLDAP requires the following software components: - - Base system (libraries and tools): - Standard C compiler, headers, and libraries - POSIX REGEX headers and libraries + 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. - SLAPD: - LDBM compatible datastore - (Berkeley DB, Sleepycat DB2, or GDBM) + 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) - SLURPD: - LTHREAD compatible thread package - (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP) + 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. - 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 - This is a quick guide. For details, see the INSTALL file. - - % ./configure - autoconf OpenLDAP for current platform + Please see the INSTALL file for basic instructions. More + detailed instructions can be found in the OpenLDAP Admnistrator's + Guide (see DOCUMENTATION section). - % make depend - this will create dependency information - % make - this will build the system +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 + . - % su - # make install + The distribution also includes manual pages for most programs + and library APIs. See ldap(3) for details. - in this directory. This should produce something that basically - works. You can "cd tests; make" to verify the build. + The OpenLDAP website is available and contains the latest LDAP + news, releases announcements, pointers to other LDAP resources, + etc.. It is located at . - You will probably want to do a little configuration to suit your - site, though. There are one file you might want to edit: + The OpenLDAP Software FAQ is available at + . - 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. +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. + Issues, such as bug reports, should be reported using our + Issue Tracking System . Do not + use this system for software enquiries. Please direct these + to an appropriate mailing list. -DOCUMENTATION - There are man pages for most programs in the distribution and - routines in the various libraries. See ldap(3) for details. - 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 +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. - 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: +--- +$OpenLDAP$ - http://www.OpenLDAP.org/ +This work is part of OpenLDAP Software . +Copyright 1998-2012 The OpenLDAP Foundation. +All rights reserved. -FEEDBACK / PROBLEM REPORTS / DISCUSSIONS - 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 +. +OpenLDAP is a registered trademark of the OpenLDAP Foundation.