X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=README;h=18dc27e56af63dcbee8d3fb93a63b849a638d757;hb=d40495eb741f8ebb3c051d1950f52fa43cd5783d;hp=58d9dd856b726459d7cfe6b51c2196ae30e6a176;hpb=f514d287f7ae4c8d778201d679e4898c63cecca9;p=openldap diff --git a/README b/README index 58d9dd856b..18dc27e56a 100644 --- a/README +++ b/README @@ -1,76 +1,86 @@ -OpenLDAP 1.0 README +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. - This is the OpenLDAP version 1.0 distribution. + Additional developer documents are available in doc/devel, + todo list + guidelines for developers + Client developers seeking a stable development platform + should use an OpenLDAP release. + + The OpenLDAP Developer's FAQ is available at: + http://www.openldap.org/faq/index.cgi?file=4 + + +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. + directory. - For more information: - http://www.OpenLDAP.org/ + 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 - 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. +REQUIRED SOFTWARE + Build OpenLDAP requires the following software components: -DOCUMENTATION + 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) - There are man pages for most programs in the distribution and - routines in the various libraries. See ldap(3) for details. + SLURPD: + LTHREAD compatible thread package + (POSIX threads, Mach Cthreads, Sun LWP, or GNU Pth) - 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: + CLIENTS/CONTRIB ware: + Depends on package. See per package README. + + +MAKING AND INSTALLING THE DISTRIBUTION + Please see the INSTALL file for details. + + +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 + + 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/ - http://www.OpenLDAP.org/ + The OpenLDAP Quick Start Guide is available at: + http://www.openldap.org/faq/index.cgi?file=172 -FEEDBACK / PROBLEM REPORTS / DISCUSSIONS + The OpenLDAP Software FAQ is available at: + http://www.openldap.org/faq/index.cgi?file=2 - We would appreciate any feedback you can provide. If you have - problems, report them to this address: - OpenLDAP-bugs@OpenLDAP.org +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.