Import op -> slap_op , conn -> slap_conn change from rel eng 1.1.

[openldap] / README

diff --git a/README b/README
index fb8dd8ab366791e60ce7022fad46c7347166590a..1b7a42f2c3e478f59af8ccd31f1291ea6b627e4b 100644 (file)
--- a/README
+++ b/README
@@ -1,59 +1,92 @@
-UM-LDAP 3.3 README file
+OpenLDAP 1.1.1 README
+       This is the OpenLDAP Release 1.1.1.
 
-    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.
+       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/software/
+
+
+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
+
+       SLAPD:
+               LDBM compatible datastore
+                       (Sleepycat Berkeley DB 2.3.16 or GDBM)
+
+       SLURPD:
+               LTHREAD compatible thread package
+                       (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
+
+       LDAPD:
+               ISODE compatible X.500 distribution
+
+       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
+               configure OpenLDAP for current platform
 
-    You should be able to make and install the distribution with a pretty
-    standard default configuration by typing the following commands
+       % make depend
+               this will create dependency information
+
+       % make 
+               this will build the system
 
-       % make
        % su
        # make install
 
-    in this directory.  This should produce something that basically
-    works.
+       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 two files you might want to edit:
+       See the INSTALL file in this directory for more information.
 
-       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
 
-       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.
 
-    See the INSTALL file in this directory for more information.
+       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 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.org/
 
-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 a postscript version of an administrator's guide for
-    slapd in doc/guides/slapd.ps.
+               http://www.OpenLDAP.com/its/
 
-    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:
+       or by sending e-mail to:
 
-       http://www.umich.edu/~rsug/ldap/
+               OpenLDAP-its@OpenLDAP.org
 
-FEEDBACK / PROBLEM REPORTS
+       Additional mailing lists are available.  Please see:
 
-    We would appreciate any feedback you can provide.  If you have
-    problems, report them to this address:
+               http://www.OpenLDAP.com/lists/
 
-       ldap-support@umich.edu