X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=README;h=18dc27e56af63dcbee8d3fb93a63b849a638d757;hb=3cad129608cda1c80acc15c364537f017fa454c7;hp=fb8dd8ab366791e60ce7022fad46c7347166590a;hpb=42e0d83cb3a1a1c5b25183f1ab74ce7edbe25de7;p=openldap diff --git a/README b/README index fb8dd8ab36..18dc27e56a 100644 --- a/README +++ b/README @@ -1,59 +1,86 @@ -UM-LDAP 3.3 README file +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 UM-LDAP version 3.3 distribution. 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 and install the distribution, see the - INSTALL file in this directory. For more information on making and - installing slapd, see the "SLAPD and SLURPD Administrator's Guide" - in the doc/guides/ directory. + Additional developer documents are available in doc/devel, + todo list + guidelines for developers -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 - - % make - % su - # make install + Client developers seeking a stable development platform + should use an OpenLDAP release. - in this directory. This should produce something that basically - works. + The OpenLDAP Developer's FAQ is available at: + http://www.openldap.org/faq/index.cgi?file=4 - 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 This file contains definitions for - where things will be installed, where - to find various things, etc. If you - want to build an ldap server, you'll - definitely need to edit this file +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. - include/ldapconfig.h.edit This file contains #defines used - by many parts of the distribution. - You'll at least want to change - DEFAULT_BASE. + 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/ - See the INSTALL file in this directory for more information. -DOCUMENTATION +REQUIRED SOFTWARE + Build OpenLDAP requires the following software components: - There are man pages for most programs in the distribution and - routines in the various libraries. See ldap(3) for details. + Base system (libraries and tools): + Standard C compiler, headers, and libraries + POSIX REGEX headers and libraries - There is a postscript version of an administrator's guide for - slapd in doc/guides/slapd.ps. + SLAPD: + LDBM compatible datastore + (Sleepycat Berkeley DB 2.7.5 or GDBM) - There is an LDAP homepage available that contains the latest - LDAP news, releases announcements, pointers to other LDAP resources, - etc. You can access it at this URL: + SLURPD: + LTHREAD compatible thread package + (POSIX threads, Mach Cthreads, Sun LWP, or GNU Pth) - http://www.umich.edu/~rsug/ldap/ + CLIENTS/CONTRIB ware: + Depends on package. See per package README. + -FEEDBACK / PROBLEM REPORTS +MAKING AND INSTALLING THE DISTRIBUTION + Please see the INSTALL file for details. - We would appreciate any feedback you can provide. If you have - problems, report them to this address: - ldap-support@umich.edu +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/ + + The OpenLDAP Quick Start Guide is available at: + http://www.openldap.org/faq/index.cgi?file=172 + + The OpenLDAP Software FAQ is available at: + http://www.openldap.org/faq/index.cgi?file=2 + + +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.