]> git.sur5r.net Git - openldap/blob - README
Update INSTALL/README files with references to new documents.
[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.
13
14
15 OpenLDAP 1.1 Alpha README
16         This is the OpenLDAP version 1.1 Alpha.
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.  For a more detailed description of how to make an
22         install the distribution, see the INSTALL file in this directory.
23
24         Additional installation information, such as per platform
25         hints can be found in the doc/install directory.
26
27         For more information:
28                 http://www.OpenLDAP.org/
29
30
31 REQUIRED SOFTWARE
32         Build OpenLDAP requires the following software components:
33
34         Base system (libraries and tools):
35                 Standard C compiler, headers, and libraries
36                 POSIX REGEX headers and libraries
37
38         SLAPD:
39                 LDBM compatible datastore
40                         (Berkeley DB, Sleepycat DB2, or GDBM)
41
42         SLURPD:
43                 LTHREAD compatible thread package
44                         (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
45
46         LDAPD:
47                 ISODE compatible X.500 distribution
48
49         CLIENTS/CONTRIB ware:
50                 Depends on package.  See per package README.
51                 
52
53 MAKING AND INSTALLING THE DISTRIBUTION
54         This is a quick guide.  For details, see the INSTALL file.
55
56         % ./configure
57                 autoconf OpenLDAP for current platform
58
59         % make depend
60                 this will create dependency information
61
62         % make 
63                 this will build the system
64
65         % su
66         # make install
67
68     in this directory.  This should produce something that basically
69     works.  You can "cd tests; make" to verify the build.
70
71     You will probably want to do a little configuration to suit your
72     site, though.  There are one file you might want to edit:
73
74         include/ldapconfig.h.edit
75                 This file contains #defines used by many parts of the
76                 distribution.  You'll at least want to change DEFAULT_BASE.
77
78     See the INSTALL file in this directory for more information.
79
80
81 DOCUMENTATION
82     There are man pages for most programs in the distribution and
83     routines in the various libraries.  See ldap(3) for details.
84
85         Additional documentation can be found in the doc directory.
86                 doc/devel       Developer Information
87                 doc/drafts      LDAP-related IETF drafts
88                 doc/install     Installation and Integration
89                 doc/man         Raw man(1) pages
90                 doc/rfcs        LDAP-related Request for Comments
91
92     There is an OpenLDAP homepage available that contains the latest
93     LDAP news, releases announcements, pointers to other LDAP resources,
94     etc. You can access it at this URL:
95
96         http://www.OpenLDAP.org/
97
98
99 FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
100     We would appreciate any feedback you can provide.  If you have
101     problems, report them to this address:
102
103         OpenLDAP-bugs@OpenLDAP.org
104