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