X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=README;h=ae7880fa74e3ee3e61dcbc669192fdda02caa143;hb=52ecfc74d222b545be9da5269377768e593c6274;hp=1ac1b6b6e7565658b8e453c677d12a3429785fe9;hpb=48aab762d246c1b62ec38ff3c775906e79281856;p=openldap diff --git a/README b/README index 1ac1b6b6e7..ae7880fa74 100644 --- a/README +++ b/README @@ -1,15 +1,34 @@ -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 -stable or the latest 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 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/ + http://www.OpenLDAP.org/software/ + REQUIRED SOFTWARE Build OpenLDAP requires the following software components: @@ -20,72 +39,51 @@ REQUIRED SOFTWARE SLAPD: LDBM compatible datastore - (Berkeley DB, Sleepycat DB2, or GDBM) + (Sleepycat Berkeley DB 2.7.5 or GDBM) + SLURPD: LTHREAD compatible thread package (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP) - LDAPD: - ISODE compatible ldap distribution - - CLIENTS/CONTRIBware: - Depends on package. See per package READMEs. + CLIENTS/CONTRIB ware: + Depends on package. See per package README. MAKING AND INSTALLING THE DISTRIBUTION + Please see the INSTALL file for details. - You should be able to make and install the distribution with a - default configuration by typing the following commands: - - % ./configure --help - This will list the available options. - The configure script will also use your environmental - variables for determining compiler/linker options. - These environment variables are used: - CC C compiler (cc, ecgs) - CFLAGS C Flags (-ansi) - CPPFLAGS CPP Flags (-I -D) - LDFLAGS LDFLAGS (-L -l) - - % [env settings] ./configure [options] - this will configure the build system - % make depend - this will create dependency information - - % make - this will build the system - - % su - # make install - - in this directory. This should produce something that basically - works. You can "cd tests; make" to verify the build. - - You will probably want to do a little configuration to suit your - site, though. There are one file you might want to edit: - - include/ldapconfig.h.edit - This file contains #defines used by many parts of the - distribution. You'll at least want to change DEFAULT_BASE. +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/ - See the INSTALL file in this directory for more information. + The OpenLDAP Software FAQ is available at: + http://www.openldap.org/faq/index.cgi?file=2 -DOCUMENTATION - There are man pages for most programs in the distribution and - routines in the various libraries. See ldap(3) for details. +FEEDBACK / PROBLEM REPORTS / DISCUSSIONS + We would appreciate any feedback you can provide. If you have + problems, report them using our Issue Tracking System: - 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: + http://www.OpenLDAP.com/its/ - http://www.OpenLDAP.org/ + or by sending e-mail to: -FEEDBACK / PROBLEM REPORTS / DISCUSSIONS + OpenLDAP-its@OpenLDAP.org - We would appreciate any feedback you can provide. If you have - problems, report them to this address: + Additional mailing lists are available. Please see: - OpenLDAP-bugs@OpenLDAP.org + http://www.OpenLDAP.com/lists/