]> git.sur5r.net Git - openldap/blob - README
Remove release version number from README in -devel.
[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
15 OpenLDAP Release README
16         For a description of what this distribution contains, see the
17         ANNOUNCEMENT file in this directory.  For a description of
18         changes from previous releases, see the CHANGES file in this
19         directory.
20
21         For a more detailed description of how to make an install the
22         distribution, see the INSTALL file in this directory.  Additional
23         installation information, such as per platform hints can be found
24         in the doc/install directory.
25
26         For more information:
27                 http://www.OpenLDAP.org/software/
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.3.16 or GDBM)
40
41         SLURPD:
42                 LTHREAD compatible thread package
43                         (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
44
45         LDAPD:
46                 ISODE compatible X.500 distribution
47
48         CLIENTS/CONTRIB ware:
49                 Depends on package.  See per package README.
50                 
51
52 MAKING AND INSTALLING THE DISTRIBUTION
53         This is a quick guide.  For details, see the INSTALL file.
54
55         % ./configure
56                 configure OpenLDAP for current platform
57
58         % make depend
59                 this will create dependency information
60
61         % make 
62                 this will build the system
63
64         % su
65         # make install
66
67         in this directory.  This should produce something that basically
68         works.  You can "cd tests; make" to verify the build.
69
70         See the INSTALL file in this directory for more information.
71
72
73 DOCUMENTATION
74         There are man pages for most programs in the distribution and
75         routines in the various libraries.  See ldap(3) for details.
76
77         Additional documentation can be found in the doc directory.
78                 doc/devel   Developer Information
79                 doc/drafts  LDAP-related IETF drafts
80                 doc/install Installation and Integration
81                 doc/man     Raw man(1) pages
82                 doc/rfcs    LDAP-related Request for Comments
83
84         There is an OpenLDAP home page available that contains the latest
85         LDAP news, releases announcements, pointers to other LDAP resources,
86         etc..  It is located at:
87                 http://www.OpenLDAP.org/
88
89         The OpenLDAP Software FAQ is available at:
90                 http://www.openldap.org/faq/index.cgi?file=2
91
92
93 FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
94         We would appreciate any feedback you can provide.  If you have
95         problems, report them using our Issue Tracking System:
96
97                 http://www.OpenLDAP.com/its/
98
99         or by sending e-mail to:
100
101                 OpenLDAP-its@OpenLDAP.org
102
103         Additional mailing lists are available.  Please see:
104
105                 http://www.OpenLDAP.com/lists/
106