]> git.sur5r.net Git - openldap/blob - INSTALL
Add comment about broken VPATH make depend.
[openldap] / INSTALL
1 Making and Installing the OpenLDAP Distribution
2
3 ** It is recommended that you read or at least skim through ALL of the
4 ** instructions in this file before attempting to build the software.
5
6 If you want to build binaries for more than one platform from a single
7 source tree, skip ahead to the "Building LDAP For More Than One Platform"
8 section near the end of this file.
9
10 If you simply want to build LDAP for a single machine platform, follow
11 these steps:
12
13  1. untar the distribution and cd to the top:
14
15         % tar xfz ldap-stable.tgz
16         % cd ldap
17
18     If you are reading this file, you probably have already done this!
19
20  2. Type:
21         % ./configure --help
22
23         to list available configuration options.
24
25         The configure script will also use your environmental
26         variables for determining compiler/linker options.
27
28         These environment variables are used: 
29                 CC                      C Compiler      (cc, ecgs)
30                 CFLAGS          C Flags         (-ansi)
31                 CPPFLAGS        CPP Flags       (-I/path/include -Ddef)
32                 LDFLAGS         LDFLAGS         (-L/path/lib -llib)
33
34  3. edit the file include/ldapconfig.h.edit to configure
35     the software for your site (the files are well-commented):
36
37         % vi include/ldapconfig.h.edit
38
39  4. Configure the build system
40
41         % [env settings] ./configure [options]
42
43         If all goes well, the configure script with auto-detect the
44         appropriate settings.  Use configure enable/with options and/or
45         environment variables to obtain desired results.
46
47  5. Build dependencies
48
49         % make depend
50
51  6. Build the system
52
53         % make
54
55     If all goes well, the system will build as configured.  If not,
56         return to step 4 after reviewing the enable/with options settings.
57         
58  7. install the binaries and man pages.  You may need to be superuser to
59     do this (depending on where you are installing things):
60
61         % su
62         # make install
63
64     That's it!  See the man pages for the individual clients for information
65     on configuring and using them.  Eventually you will probably want to
66     edit the configuration files used by the various clients (installed in
67     the LDAP etc directory).  The files are:
68
69         ldapfilter.conf      - search filter configuration
70         ldapfriendly         - mapping of X.500 names to human-friendly names
71         ldapsearchprefs.conf - search object definitions
72         ldaptemplates.conf   - display template definitions
73
74     There are section 5 man pages for all of these files.
75
76
77 Building LDAP For More Than One Platform
78
79 It is now possible to build LDAP for more than one platform from the same
80 source tree.  This is accomplished by using make(1) VPATH support.  If
81 your make(1) program is old and doesn't have VPATH support, install GNU
82 Make.
83
84 Follow these steps for each different platform:
85
86  1.     Create a directory for the platform object files.
87
88         % mkdir obj-platform
89
90  2. Change your working directory to the platform object directory.
91
92         % cd obj-platform
93
94  3. Configure the build system
95
96         % [env settings] ../configure --src-dir=.. [options]
97
98                 ( replace ".." with the appropriate path )
99
100  4. Continue as above (starting at step 6).
101
102         Note: make depend in VPATH environment is not yet supported.
103
104 End of OpenLDAP INSTALL file.