]> git.sur5r.net Git - openldap/blob - doc/guide/release/install.sdf
Updates to based upon latest INSTALL document. Needs a bit
[openldap] / doc / guide / release / install.sdf
1 # $OpenLDAP$
2 # Copyright 1999-2000, The OpenLDAP Foundation, All Rights Reserved.
3 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
4
5 P1: Making and Installing the OpenLDAP Distribution
6
7 It is recommended that you read or at least skim through ALL of the
8 instructions in this file before attempting to build the software.
9
10 The OpenLDAP Installation FAQ is available at:
11
12 .{{URL:http://www.openldap.org/faq/index.cgi?file=8}}
13
14 You should also check for platform specific hints.
15
16 .{{URL:http://www.openldap.org/faq/index.cgi?file=9}}
17
18
19 P2: Making and Installing the OpenLDAP Distribution
20
21 ^ untar the distribution and cd to the top:
22
23 E:      % tar xfz openldap-VERSION.tgz
24 E:      % cd openldap-VERSION
25
26 .If you are reading this file, you probably have already done this!
27
28
29 + Type:
30
31 E:      % ./configure --help
32
33 .to list available configuration options.   A description of
34 these options is provided in the 'CONFIGURE OPTIONS' section
35 below.
36
37 .The configure script uses environmental variables for
38 determining compiler/linker options.  See the HINTS
39 section for commonly used settings. 
40
41 .These environment variables are used: 
42
43 >       CC              C compiler      gcc
44 >       CFLAGS          C flags         -ansi
45 >       CPPFLAGS        cpp flags       -I/path/include -Ddef
46 >       LDFLAGS         ld flags        -L/usr/local/lib
47 >       LIBS            libraries       -llib
48 >       PATH            command path    /usr/local/bin:/usr/bin:/bin
49
50 .See the 'USING ENVIRONMENT VARIABLES' section for information
51 on how to use the variables. 
52
53 + Configure the build system
54
55 E:      % [env settings] ./configure [options]
56
57 .If all goes well, the configure script with auto-detect the
58 appropriate settings.  Use configure enable/with options and/or
59 environment variables to obtain desired results.
60
61 + Build dependencies
62
63 E:      % make depend
64
65 + Build the system
66
67 E:      % make
68
69 .If all goes well, the system will build as configured.  If not,
70 return to step 3 after reviewing the configuration settings.
71
72 .You may want to consult the Platform Hints section of the FAQ .
73
74 + Test the standalone system
75
76 .This step requires the standalone LDAP server (slapd) with
77 LDBM support.
78
79 E:      % make test
80
81 .If all goes well, the system has been built as configured.  If not,
82 return to step 4 after reviewing your configuration settings.
83
84 .You may want to consult the Platform Hints section of the FAQ.
85
86 + install the binaries and man pages.  You may need to be superuser to
87 do this (depending on where you are installing things):
88
89 E:      % su root -c 'make install'
90
91 + That's it!
92
93 .See the man pages for the individual applications for
94 information on configuring and using them.  You may also want
95 to edit the configuration files used by the various components.
96 These configuration files are located in the OpenLDAP
97 configuration directory (normally /usr/local/etc/openldap).
98
99 >       ldap.conf               client defaults
100 >       ldapfilter.conf         search filter configuration
101 >       ldapsearchprefs.conf    search object definitions
102 >       ldaptemplates.conf      display template definitions
103 >       slapd.conf              Standalone LDAP daemon
104 >       schema/*.schema         Schema Definitions
105
106 .There are section 5 man pages for these configuration files.
107
108
109 P2: Building OpenLDAP For More Than One Platform
110
111 .You can build OpenLDAP for more than one platform from the
112 same source tree.
113 This is accomplished by using {{make}}(1) VPATH support.
114 If your {{make}}(1) program is old and doesn't have VPATH
115 support, install {{BSD Make}} or {{GNU Make}}.
116
117 .Follow these steps for each different platform:
118
119 ^ Create a directory for the platform object files.
120
121 E:      % mkdir obj-platform
122
123 + Change your working directory to the platform object directory.
124
125 E:      % cd obj-platform
126
127 + Configure the build system
128
129 E:      % [env settings] ../configure --src-dir=.. [options]
130
131 ( replace ".." with the appropriate path )
132
133 + Continue as above (starting at step 6).
134
135 Note: make depend in VPATH environment is not yet supported.
136
137
138 P2: CONFIGURE OPTIONS
139
140 Regrettably, this section has not been written (yet).  See
141 "./configure --help" for current list of options.  For general
142 information about how to use "configure", please read:
143         doc/install/configure
144
145
146 P2: USING ENVIRONMENT VARIABLES
147
148 The configure script will also use your environmental
149 variables for determining compiler/linker options.   This can
150 be used to manual specify features and compilation options.
151
152 .WARNING: Executables built in your environment may not run
153 in your users' environments.  The portability of executables
154 between environments is {{your responsibility}}.
155
156 Supported Environmental Variables:
157
158 >       CC              C compiler      cc
159 >       CFLAGS          C flags         -ansi
160 >       CPPFLAGS        cpp flags       -I/path/include -Ddef
161 >       LDFLAGS         ld flags        -L/usr/local/lib
162 >       LIBS            libraries       -llib
163 >       PATH            command path    /usr/local/bin:/usr/bin:/bin
164
165 * Including alternative compilers
166
167 .Use the CC environment variable to tell configure to
168 use a specific compiler.  For example, to use {{GNU C
169 Compiler}} instead of the default compiler, use:
170
171 E:      % [env] CC=gcc ./configure 
172
173 .You can also use CC use specific flags with the
174 specified compiler.  For example, to require strict
175 ANSI C using the GNU C Compiler, use:
176
177 E:      % [env] CC="gcc -ansi -pedantic" ./configure
178
179 .(you can use CFLAGS to specify compiler flags)
180
181 * Preprocessor Flags
182
183 .You may specify additional preprocessor flags by setting
184 CPPFLAGS.  For example, if you would like to use headers
185 installed in {{F:/usr/local/include}}, use:
186
187 E:      % [env] CPPFLAGS="-I/usr/local/include" ./configure
188
189 .You can also use CPPFLAGS to specify preprocessor macros.
190
191 E:      % [env] CPPFLAGS="-D__SPECIAL_FLAG__" ./configure
192
193 * Linker Flags
194
195 .You may specify additional linker flags by setting LDFLAGS.
196 For example, if you would like to use libraries installed
197 in {{F:/usr/local/lib}}, use:
198
199 E:      % [env] LDFLAGS="-L/usr/local/lib" ./configure
200
201 .You can also use CPPFLAGS to specify linker flags:
202
203 E:      % [env] LDFLAGS="-Bstatic" ./configure
204
205 * Path
206
207 .You may alter your path to affect configure ability to
208 find (or not find) commands.  For example, to have configure
209 additionally look in {{F:/usr/css/bin}} for commands, use:
210
211 E:      % [env] PATH="/usr/css/bin:$PATH" ./configure
212         
213
214 * Use local software
215
216 E:      % [env] \
217 E:              CPPFLAGS="-I/usr/local/include" \
218 E:              LDFLAGS="-L/usr/local/lib" \
219 E:              ./configure
220
221
222 HINTS
223
224 * Use software under installed under {{F:/usr/local}}.
225
226 E:      [env] \
227 E:              CPPFLAGS="-I/usr/local/include" \
228 E:              LDFLAGS="-L/usr/local/lib" \
229 E:              ./configure
230
231
232 End of OpenLDAP INSTALL file.
233
234 {{$OpenLDAP$}}