]> git.sur5r.net Git - openldap/blob - README
Add link to developer's FAQ.
[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 -stable or the latest 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, such as per platform hints can be found
27         in the doc/install directory.
28
29         For more information:
30                 http://www.OpenLDAP.org/software/
31
32
33 REQUIRED SOFTWARE
34         Build OpenLDAP requires the following software components:
35
36         Base system (libraries and tools):
37                 Standard C compiler, headers, and libraries
38                 POSIX REGEX headers and libraries
39
40         SLAPD:
41                 LDBM compatible datastore
42                         (Sleepycat Berkeley DB 2.7.4 or GDBM)
43
44         SLURPD:
45                 LTHREAD compatible thread package
46                         (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
47
48         LDAPD:
49                 ISODE compatible X.500 distribution
50
51         CLIENTS/CONTRIB ware:
52                 Depends on package.  See per package README.
53                 
54
55 MAKING AND INSTALLING THE DISTRIBUTION
56         Please see the INSTALL file for details.
57
58
59 DOCUMENTATION
60         There are man pages for most programs in the distribution and
61         routines in the various libraries.  See ldap(3) for details.
62
63         Additional documentation can be found in the doc directory.
64                 doc/devel   Developer Information
65                 doc/drafts  LDAP-related IETF drafts
66                 doc/install Installation and Integration
67                 doc/man     Raw man(1) pages
68                 doc/rfcs    LDAP-related Request for Comments
69
70         There is an OpenLDAP home page available that contains the latest
71         LDAP news, releases announcements, pointers to other LDAP resources,
72         etc..  It is located at:
73                 http://www.OpenLDAP.org/
74
75         The OpenLDAP Software FAQ is available at:
76                 http://www.openldap.org/faq/index.cgi?file=2
77
78
79 FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
80         We would appreciate any feedback you can provide.  If you have
81         problems, report them using our Issue Tracking System:
82
83                 http://www.OpenLDAP.com/its/
84
85         or by sending e-mail to:
86
87                 OpenLDAP-its@OpenLDAP.org
88
89         Additional mailing lists are available.  Please see:
90
91                 http://www.OpenLDAP.com/lists/
92