1 Making and Installing the OpenLDAP Distribution
4 ** It is recommended that you read or at least skim through ALL of the
5 ** instructions in this file before attempting to build the software.
7 ** You should also check for platform specific hints.
8 ** These are located in doc/install/hints.
11 If you want to build binaries for more than one platform from a single
12 source tree, skip ahead to the "Building LDAP For More Than One Platform"
13 section near the end of this file.
15 If you simply want to build LDAP for a single machine platform, follow
18 1. untar the distribution and cd to the top:
20 % tar xfz openldap-VERSION.tgz
23 If you are reading this file, you probably have already done this!
28 to list available configuration options. A description of
29 these options is provided in the 'CONFIGURE OPTIONS' section
32 The configure script uses environmental variables for
33 determining compiler/linker options. See the HINTS
34 section for commonly used settings.
36 These environment variables are used:
37 CC C Compiler (cc, ecgs)
38 CFLAGS C Flags (-ansi)
39 CPPFLAGS CPP Flags (-I/path/include -Ddef)
40 LDFLAGS LDFLAGS (-L/path/lib)
43 See the 'USING ENVIRONMENT VARIABLES' section for information
44 on how to use the variables.
46 3. edit the file include/ldapconfig.h.edit to configure
47 the software for your site (the files are well-commented):
49 % vi include/ldapconfig.h.edit
51 4. Configure the build system
53 % [env settings] ./configure [options]
55 If all goes well, the configure script with auto-detect the
56 appropriate settings. Use configure enable/with options and/or
57 environment variables to obtain desired results.
67 If all goes well, the system will build as configured. If not,
68 return to step 4 after reviewing the configuration settings.
70 You may want to consult the doc/install/hints file for your
73 7. Test the standalone system
75 This step requires the standalone LDAP server (slapd) with
81 If all goes well, the system has been built as configured. If not,
82 return to step 4 after reviewing your configuration settings.
84 You may want to consult the doc/install/hints file for your
87 8. install the binaries and man pages. You may need to be superuser to
88 do this (depending on where you are installing things):
95 See the man pages for the individual applications for
96 information on configuring and using them. You may also want
97 to edit the configuration files used by the various clients.
98 These configuration files are located in the OpenLDAP
99 configuration directory (normally /usr/local/etc/openldap).
101 ldap.conf - LDAP defaults
102 ldapfilter.conf - search filter configuration
103 ldapsearchprefs.conf - search object definitions
104 ldaptemplates.conf - display template definitions
106 There are section 5 man pages for all of these files.
109 Building LDAP For More Than One Platform
111 It is now possible to build LDAP for more than one platform from the same
112 source tree. This is accomplished by using make(1) VPATH support. If
113 your make(1) program is old and doesn't have VPATH support, install GNU
116 Follow these steps for each different platform:
118 1. Create a directory for the platform object files.
122 2. Change your working directory to the platform object directory.
126 3. Configure the build system
128 % [env settings] ../configure --src-dir=.. [options]
130 ( replace ".." with the appropriate path )
132 4. Continue as above (starting at step 6).
134 Note: make depend in VPATH environment is not yet supported.
139 Regrettably, this section has not been written (yet). See
140 "./configure --help" for current list of options. For general
141 information about how to use "configure", please read:
142 doc/install/configure
145 USING ENVIRONMENT VARIABLES
147 The configure script will also use your environmental
148 variables for determining compiler/linker options. This can
149 be used to manual specify features and compilation options.
151 NOTE: If you change environment setting, be sure to remove
152 any config.cache before running ./configure.
154 Supported Environmental Variables
155 CC C compiler (cc, egcc)
156 CFLAGS C flags (-ansi)
157 CPPFLAGS cpp flags (-I/path/include -Ddef)
158 LDFLAGS ld flags (-L/usr/local/lib)
159 LIBS libraries (-llib)
160 PATH command path /usr/local/bin:/usr/bin:/bin
162 * Including alternative compilers
163 Use the CC environment variable to tell configure to
164 use a specific compiler. For example, to use ecgs
165 instead of the compiler configure choose, use:
167 [env] CC=egcc ./configure
169 You can also use CC use specific flags with the
170 specified compiler. For example, to require strict
171 ANSI C using the GNU C Compiler, use:
173 [env] CC="gcc -ansi -pedantic" ./configure
175 (you can use CFLAGS to specify compiler flags)
178 You may specify additional preprocessor flags by setting
179 CPPFLAGS. For example, if you would like to use headers
180 installed in /usr/local/include, use:
182 [env] CPPFLAGS="-I/usr/local/include" ./configure
184 You can also use CPPFLAGS to specify preprocessor macros.
186 [env] CPPFLAGS="-D__SPECIAL_FLAG__" ./configure
189 You may specify additional linker flags by setting LDFLAGS.
190 For example, if you would like to use libraries installed
191 in /usr/local/lib, use:
193 [env] LDFLAGS="-L/usr/local/lib" ./configure
195 You can also use CPPFLAGS to specify linker flags:
197 [env] LDFLAGS="-Bstatic" ./configure
200 You may alter your path to affect configure ability to
201 find (or not find) commands. For example, to have configure
202 additionally look in /usr/css/bin for commands, use:
204 [env] PATH="/usr/css/bin:$PATH" ./configure
209 * Platform specific hints are available in doc/install/hints.
211 * Use software under installed in /usr/local/{include,lib}
213 CPPFLAGS="-I/usr/local/include" \
214 LDFLAGS="-L/usr/local/lib" \
218 End of OpenLDAP INSTALL file.