]> git.sur5r.net Git - openldap/blob - README
Update a few misc docs
[openldap] / README
1 OpenLDAP Devel README
2         OpenLDAP -devel is for the development of OpenLDAP.  As such,
3         it changes often.  These changes include changes in functionality
4         and unproven bug fixes.  Many of these changes will cause
5         previous working programs to fail.
6
7         Additional developer documents are available in doc/devel,
8                 todo list
9                 guidelines for developers
10
11         Client developers seeking a stable development platform
12         should use an OpenLDAP release.
13
14         The OpenLDAP Developer's FAQ is available at:
15                 http://www.openldap.org/faq/index.cgi?file=4
16
17
18 OpenLDAP Release README
19         For a description of what this distribution contains, see the
20         ANNOUNCEMENT file in this directory.  For a description of
21         changes from previous releases, see the CHANGES file in this
22         directory.
23
24         For a more detailed description of how to make an install the
25         distribution, see the INSTALL file in this directory.  Additional
26         installation information can be found on the OpenLDAP website:
27                 http://www.openldap.org/
28
29
30 REQUIRED SOFTWARE
31         Build OpenLDAP requires the following software components:
32
33         Base system (libraries and tools):
34                 Standard C compiler, headers, and libraries
35                 POSIX REGEX headers and libraries
36
37         SLAPD:
38                 LDBM compatible datastore
39                         (Sleepycat Berkeley DB 2.7.5 or GDBM)
40
41         SLURPD:
42                 LTHREAD compatible thread package
43                         (POSIX threads, Mach Cthreads, Sun LWP, or GNU Pth)
44
45         CLIENTS/CONTRIB ware:
46                 Depends on package.  See per package README.
47                 
48
49 MAKING AND INSTALLING THE DISTRIBUTION
50         Please see the INSTALL file for details.
51
52
53 DOCUMENTATION
54         There are man pages for most programs in the distribution and
55         routines in the various libraries.  See ldap(3) for details.
56
57         Additional documentation can be found in the doc directory.
58                 doc/devel   Developer Information
59                 doc/drafts  LDAP-related IETF drafts
60                 doc/install Installation and Integration
61                 doc/man     Raw man(1) pages
62                 doc/rfcs    LDAP-related Request for Comments
63
64         There is an OpenLDAP home page available that contains the latest
65         LDAP news, releases announcements, pointers to other LDAP resources,
66         etc..  It is located at:
67                 http://www.OpenLDAP.org/
68
69         The OpenLDAP Quick Start Guide is available at:
70                 http://www.openldap.org/faq/index.cgi?file=172
71
72         The OpenLDAP Software FAQ is available at:
73                 http://www.openldap.org/faq/index.cgi?file=2
74
75
76 SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
77         OpenLDAP is user supported.  If you have problems, please
78         review the OpenLDAP FAQ <http://www.openldap.org/faq/> and
79         archives of the OpenLDAP-software and OpenLDAP-bugs mailing
80         lists <http://www.openldap.org/lists/>.
81
82         Issues, such as bug reports, should be reported using our
83         our Issue Tracking System <http://www.OpenLDAP.com/its/> or
84         by sending mail to OpenLDAP-its@OpenLDAP.org.  Do not use
85         this system for general or software equiries.  Please direct
86         these to the appropriate mailing list.