]> git.sur5r.net Git - openldap/blob - README
Added REQUIRED SOFTWARE section. Added additional comments.
[openldap] / README
1 OpenLDAP 1.0 README
2
3     This is the OpenLDAP version 1.0 distribution.
4
5         For a description of what this distribution contains, see the
6         ANNOUNCEMENT file in this directory.  For a description of
7         changes from previous releases, see the CHANGES file in this
8         directory.  For a more detailed description of how to make an
9         install the distribution, see the INSTALL file in this directory.
10
11         For more information:
12                 http://www.OpenLDAP.org/
13
14 REQUIRED SOFTWARE
15         Build OpenLDAP requires the following software components:
16
17         Base system (libraries and tools):
18                 Standard C compiler, headers, and libraries
19                 POSIX REGEX headers and libraries
20
21         SLAPD:
22                 LDBM compatible datastore
23                         (Berkeley DB, Sleepycat DB2, or GDBM)
24         SLURPD:
25                 LTHREAD compatible thread package
26                         (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
27
28         LDAPD:
29                 ISODE compatible ldap distribution
30
31         CLIENTS/CONTRIBware:
32                 Depends on package.  See per package READMEs.
33                 
34
35 MAKING AND INSTALLING THE DISTRIBUTION
36
37     You should be able to make and install the distribution with a
38     default configuration by typing the following commands:
39
40         % ./configure --help
41                 This will list the available options.
42                 The configure script will also use your environmental
43                 variables for determining compiler/linker options.
44                 These environment variables are used:
45                         CC                      C compiler      (cc, ecgs)
46                         CFLAGS          C Flags         (-ansi)
47                         CPPFLAGS        CPP Flags       (-I -D)
48                         LDFLAGS         LDFLAGS         (-L -l)
49
50         % [env settings] ./configure [options]
51                 this will configure the build system
52
53         % make depend
54                 this will create dependency information
55
56         % make 
57                 this will build the system
58
59         % su
60         # make install
61
62     in this directory.  This should produce something that basically
63     works.  You can "cd tests; make" to verify the build.
64
65     You will probably want to do a little configuration to suit your
66     site, though.  There are one file you might want to edit:
67
68         include/ldapconfig.h.edit
69                 This file contains #defines used by many parts of the
70                 distribution.  You'll at least want to change DEFAULT_BASE.
71
72     See the INSTALL file in this directory for more information.
73
74 DOCUMENTATION
75
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     There is an OpenLDAP homepage available that contains the latest
80     LDAP news, releases announcements, pointers to other LDAP resources,
81     etc. You can access it at this URL:
82
83         http://www.OpenLDAP.org/
84
85 FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
86
87     We would appreciate any feedback you can provide.  If you have
88     problems, report them to this address:
89
90         OpenLDAP-bugs@OpenLDAP.org
91