1 <?xml version='1.0' encoding='UTF-8' ?>
2 <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
4 <!-- $Revision: 1.12 $ -->
7 Copyright 2003-2004 The Apache Software Foundation
9 Licensed under the Apache License, Version 2.0 (the "License");
10 you may not use this file except in compliance with the License.
11 You may obtain a copy of the License at
13 http://www.apache.org/licenses/LICENSE-2.0
15 Unless required by applicable law or agreed to in writing, software
16 distributed under the License is distributed on an "AS IS" BASIS,
17 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 See the License for the specific language governing permissions and
19 limitations under the License.
22 <manualpage metafile="configure.xml.meta">
23 <parentdocument href="./">Programs</parentdocument>
25 <title>configure - Configure the source tree</title>
28 <p>The <code>configure</code> script configures the source tree
29 for compiling and installing the Apache HTTP Server on your
30 particular platform. Various options allow the compilation of a
31 server corresponding to your personal requirements.</p>
33 <p>This script, included in the root directory of the source
34 distribution, is for compilation on Unix and Unix-like systems
35 only. For other platforms, see the <a
36 href="../platform/">platform</a> documentation.</p>
39 <seealso><a href="../install.html">Compiling and Installing</a></seealso>
41 <section id="synopsis"><title>Synopsis</title>
42 <p>You should call the <code>configure</code> script from within the
43 root directory of the distribution.</p>
45 <p><code><strong>./configure</strong> [<var>OPTION</var>]...
46 [<var>VAR</var>=<var>VALUE</var>]...</code></p>
48 <p>To assign environment variables (e.g. <code>CC</code>,
49 <code>CFLAGS</code> ...), specify them as
50 <code><var>VAR</var>=<var>VALUE</var></code>. See <a href="#env">below</a>
51 for descriptions of some of the useful variables.</p>
54 <section id="options"><title>Options</title>
56 <li><a href="#configurationoptions">Configuration options</a></li>
57 <li><a href="#installationdirectories">Installation directories</a></li>
58 <li><a href="#systemtypes">System types</a></li>
59 <li><a href="#optionalfeatures">Optional features</a></li>
60 <li><a href="#supportopt">Options for support programs</a></li>
63 <section id="configurationoptions"><title>Configuration options</title>
65 <p>The following options influence the behavior of
66 <code>configure</code> itself.</p>
69 <dt><code>-C</code></dt>
70 <dt><code>--config-cache</code></dt>
71 <dd>This is an alias for <code>--cache-file=config.cache</code></dd>
73 <dt><code>--cache-file=<var>FILE</var></code></dt>
74 <dd>The test results will be cached in file <var>FILE</var>.
75 This option is disabled by default.</dd>
77 <dt><code>-h</code></dt>
78 <dt><code>--help [short|recursive]</code></dt>
79 <dd>Output the help and exit. With the argument <code>short</code> only
80 options specific to this package will displayed. The argument
81 <code>recursive</code> displays the short help of all the included
84 <dt><code>-n</code></dt>
85 <dt><code>--no-create</code></dt>
86 <dd>The <code>configure</code> script is run normally but does
87 not create output files. This is useful to check the test results
88 before generating makefiles for compilation.</dd>
90 <dt><code>-q</code></dt>
91 <dt><code>--quiet</code></dt>
92 <dd>Do not print <code>checking ...</code> messages during the
93 configure process.</dd>
95 <dt><code>--srcdir=<var>DIR</var></code></dt>
96 <dd>Defines directory <var>DIR</var> to be the source file directory.
97 Default is the directory, where configure is located, or the parent
98 directory <code>..</code>.</dd>
100 <dt><code>--silent</code></dt>
101 <dd>Same as <code>--quiet</code></dd>
105 <dd>Display copyright information and exit.</dd>
109 <section id="installationdirectories"><title>Installation
112 <p>These options define the installation directory. The installation
113 tree depends on the selected layout.</p>
116 <dt><code>--prefix=<var>PREFIX</var></code></dt>
117 <dd>Install architecture-independent files in <var>PREFIX</var>.
118 By default the installation directory is set to
119 <code>/usr/local/apache2</code>.</dd>
121 <dt><code>--exec-prefix=<var>EPREFIX</var></code></dt>
122 <dd>Install architecture-dependent files in <var>EPREFIX</var>.
123 By default the installation directory is set to the
124 <var>PREFIX</var> directory.</dd>
127 <p>By default, <code>make install</code> will install all the files in
128 <code>/usr/local/apache2/bin</code>, <code>/usr/local/apache2/lib</code>
129 etc. You can specify an installation prefix other than
130 <code>/usr/local/apache2</code> using <code>--prefix</code>,
131 for instance <code>--prefix=$HOME</code>.</p>
133 <section id="layout"><title>Define a directory layout</title>
135 <dt><code>--enable-layout=<var>LAYOUT</var></code></dt>
136 <dd>Configure the source code and build scripts to assume an
137 installation tree based on the layout <var>LAYOUT</var>. This allows
138 you to separately specify the locations for each type of file within
139 the Apache HTTP Server installation. The <code>config.layout</code>
140 file contains several example configurations, and you can also create
141 your own custom configuration following the examples. The different
142 layouts in this file are grouped into <code><Layout
143 FOO>...</Layout></code> sections and referred to by name as
144 in <code>FOO</code>. The default layout is <code>Apache</code>.</dd>
148 <section id="directoryfinetuning"><title>Fine tuning of the installation
151 <p>For better control of the installation directories, use the options
152 below. Please note that the directory defaults are set by
153 <code>autoconf</code> and be overwritten by the corresponding layout
157 <!-- only apr-config and apu-config are installed at bindir.
158 everything else is stored at sbindir. ==> clarify/change this -->
159 <dt><code>--bindir=<var>DIR</var></code></dt>
160 <dd>Install user executables in <var>DIR</var>. The user executables
161 are supporting programs like <code>htpasswd</code>,
162 <code>dbmmanage</code>, etc. which are useful for site
163 administrators. By default <var>DIR</var> is set to
164 <code><var>EPREFIX</var>/bin</code>.</dd>
166 <dt><code>--datadir=<var>DIR</var></code></dt>
167 <dd>Install read-only architecture-independent data in <var>DIR</var>.
168 By default <code>datadir</code> is set to
169 <code><var>PREFIX</var>/share</code>. This option is offered by
170 <code>autoconf</code> and currently unused.</dd>
172 <dt><code>--includedir=<var>DIR</var></code></dt>
173 <dd>Install C header files in <var>DIR</var>. By default
174 <code>includedir</code> is set to
175 <code><var>EPREFIX</var>/include</code>.</dd>
177 <dt><code>--infodir=<var>DIR</var></code></dt>
178 <dd>Install info documentation in <var>DIR</var>.
179 By default <code>infodir</code> is set to
180 <code><var>PREFIX</var>/info</code>. This option is currently
183 <dt><code>--libdir=<var>DIR</var></code></dt>
184 <dd>Install object code libraries in <var>DIR</var>. By default
185 <code>libdir</code> is set to
186 <code><var>EPREFIX</var>/lib</code>.</dd>
188 <dt><code>--libexecdir=<var>DIR</var></code></dt>
189 <dd>Install the program executables (i.e., shared modules) in
190 <var>DIR</var>. By default <code>libexecdir</code> is set to
191 <code><var>EPREFIX</var>/libexec</code>.</dd>
193 <dt><code>--localstatedir=<var>DIR</var></code></dt>
194 <dd>Install modifiable single-machine data in <var>DIR</var>.
195 By default <code>localstatedir</code> is set to
196 <code><var>PREFIX</var>/var</code>. This option is offered by
197 <code>autoconf</code> and currently unused.</dd>
199 <dt><code>--mandir=<var>DIR</var></code></dt>
200 <dd>Install the man documentation in <var>DIR</var>. By default
201 <code>mandir</code> is set to
202 <code><var>EPREFIX</var>/man</code>.</dd>
204 <dt><code>--oldincludedir=<var>DIR</var></code></dt>
205 <dd>Install C header files for non-gcc in <var>DIR</var>.
206 By default <code>oldincludedir</code> is set to
207 <code>/usr/include</code>. This option is offered by
208 <code>autoconf</code> and currently unused.</dd>
210 <dt><code>--sbindir=<var>DIR</var></code></dt>
211 <dd>Install the system administrator executables in <var>DIR</var>.
212 Those are server programs like <code>httpd</code>,
213 <code>apachectl</code>, <code>suexec</code>, etc. which are neccessary
214 to run the Apache HTTP Server. By default <code>sbindir</code> is
215 set to <code><var>EPREFIX</var>/sbin</code>.</dd>
217 <dt><code>--sharedstatedir=<var>DIR</var></code></dt>
218 <dd>Install modifiable architecture-independent data in <var>DIR</var>.
219 By default <code>sharedstatedir</code> is set to
220 <code><var>PREFIX</var>/com</code>. This option is offered by
221 <code>autoconf</code> and currently unused.</dd>
223 <dt><code>--sysconfdir=<var>DIR</var></code></dt>
224 <dd>Install read-only single-machine data like the server configuration
225 files <code>httpd.conf</code>, <code>mime.types</code>, etc. in
226 <var>DIR</var>. By default <code>sysconfdir</code> is set to
227 <code><var>PREFIX</var>/etc</code>.</dd>
232 <section id="systemtypes"><title>System types</title>
234 <p>These options are used to cross-compile the Apache HTTP Server to run on
235 another system. In normal cases, when building and running the server on
236 the same system, these options are not used.</p>
239 <dt><code>--build=<var>BUILD</var></code></dt>
240 <dd>Defines the system type of the system on which the tools are being
241 built. It defaults to the result of the script
242 <code>config.guess</code>.</dd>
244 <dt><code>--host=<var>HOST</var></code></dt>
245 <dd>Defines the system type of the system on which the server will run.
246 <var>HOST</var> defaults to <var>BUILD</var>.</dd>
248 <dt><code>--target=<var>TARGET</var></code></dt>
249 <dd>Configure for building compilers for the system type
250 <var>TARGET</var>. It defaults to <var>HOST</var>. This option is
251 offered by <code>autoconf</code> and not necessary for the Apache HTTP
256 <section id="optionalfeatures"><title>Optional Features</title>
258 <p>These options are used to fine tune the features your HTTP server will
261 <section id="generaloptfeat"><title>General syntax</title>
262 <p>Generally you can use the following syntax to enable or disable a
266 <dt><code>--disable-<var>FEATURE</var></code></dt>
267 <dd>Do not include <var>FEATURE</var>. This is the same as
268 <code>--enable-<var>FEATURE</var>=no</code>.</dd>
270 <dt><code>--enable-<var>FEATURE</var>[=<var>ARG</var>]</code></dt>
271 <dd>Include <var>FEATURE</var>. The default value for <var>ARG</var>
272 is <code>yes</code>.</dd>
274 <dt><code>--enable-<var>MODULE</var>=shared</code></dt>
275 <dd>The corresponding module will be build as DSO module.</dd>
277 <dt><code>--enable-<var>MODULE</var>=static</code></dt>
278 <dd>By default enabled modules are linked statically. You can force
279 this explicitly.</dd>
282 <note><title>Note</title>
283 <code>configure</code> will not complain about
284 <code>--enable-<var>foo</var></code> even if <var>foo</var> doesn't
285 exist, so you need to type carefully.
289 <!-- to do: add better enable-module descriptions and recommendations -->
290 <section id="enabledmodules"><title>Modules enabled by default</title>
291 <p>Some modules are compiled by default and have to be disabled
292 explicitly. Use the following options to remove discrete modules from
293 the compilation process.</p>
296 <dt><code>--disable-actions</code></dt>
297 <dd>Disable action triggering on requests, which is provided by
298 <module>mod_actions</module>.</dd>
300 <dt><code>--disable-alias</code></dt>
301 <dd>Disable the mapping of requests to different parts of the
302 filesystem, which is provided by <module>mod_alias</module>.</dd>
304 <dt><code>--disable-asis</code></dt>
305 <dd>Disable support for as-is filetypes, which is provided by
306 <module>mod_asis</module>.</dd>
308 <dt><code>--disable-auth</code></dt>
309 <dd>Disable user-based access control provided by
310 <module>mod_auth</module>. This module provides for HTTP Basic
311 Authentication, where the usernames and passwords are stored in
312 plain text files.</dd>
314 <dt><code>--disable-autoindex</code></dt>
315 <dd>Disable the directory listing functionality provided by
316 <module>mod_autoindex</module>.</dd>
318 <dt><code>--disable-access</code></dt>
319 <dd>Disable host-based access control provided by
320 <module>mod_access</module>.</dd>
322 <dt><code>--disable-cgi</code></dt>
323 <dd><module>mod_cgi</module>, which provides support for CGI scripts,
324 is enabled by default when using a non-threaded MPM. Use this
325 option to disable CGI support.</dd>
327 <dt><code>--disable-cgid</code></dt>
328 <dd>When using the threaded MPMs <module>worker</module> or
329 <module>perchild</module> support for CGI scripts is provided by
330 <module>mod_cgid</module> by default. To disable CGI support use
333 <dt><code>--disable-charset-lite</code></dt>
334 <dd>Disable character set translation provided by
335 <module>mod_charset_lite</module>. This module will be installed by
336 default only on EBCDIC systems.</dd>
338 <dt><code>--disable-dir</code></dt>
339 <dd>Disable directory request handling provided by
340 <module>mod_dir</module>.</dd>
342 <dt><code>--disable-env</code></dt>
343 <dd>Enable setting and clearing of environment variables, which is
344 provided by <module>mod_env</module>.</dd>
346 <!-- configure mentions enable-http, but disable-http would make much
348 <dt><code>--disable-http</code></dt>
349 <dd>Disable the HTTP protocol handling. The <code>http</code>
350 module is a basic one, enabling the server to function as an
351 HTTP server. It is only useful to disable it if you want to use
352 another protocol module instead. <strong>Don't disable this
353 module unless you are really sure what you are doing.</strong>
355 Note: This module will always be linked statically.</dd>
357 <dt><code>--disable-imap</code></dt>
358 <dd>Disable support for server based imagemaps, which provided by
359 <module>mod_imap</module>.</dd>
361 <dt><code>--disable-include</code></dt>
362 <dd>Disable Server Side Includes provided by
363 <module>mod_include</module>.</dd>
365 <dt><code>--disable-log-config</code></dt>
366 <dd>Disable the logging configuration provided by
367 <module>mod_log_config</module>. You won't be able to log requests
368 to the server without this module.</dd>
370 <dt><code>--disable-mime</code></dt>
371 <dd><module>mod_mime</module> associates the requested filename's
372 extensions with the file's behavior and content (mime-type,
373 language, character set and encoding). Disabling the mapping of
374 file-extensions to MIME is normally not recommended.</dd>
376 <dt><code>--disable-negotiation</code></dt>
377 <dd>Disable content negotiation provided by
378 <module>mod_negotiation</module>.</dd>
380 <dt><code>--disable-setenvif</code></dt>
381 <dd>Disable support for basing environment variables on headers,
382 which is provided by <module>mod_setenvif</module>.</dd>
384 <dt><code>--disable-status</code></dt>
385 <dd>Enable the process/thread monitoring, which is provided by
386 <module>mod_status</module>.</dd>
388 <dt><code>--disable-userdir</code></dt>
389 <dd>Disable the mapping of requests to user-specific directories,
390 which is provided by <module>mod_userdir</module>.</dd>
394 <section id="disabledmodules"><title>Modules, disabled by default</title>
395 <p>Some modules are compiled by default and have to be enabled
396 explicitly or by using the keywords <code>most</code> or
397 <code>all</code> (see <code>--enable-mods-shared</code> below for
398 further explanation) to be available. Therefore use the options
402 <dt><code>--enable-auth-anon</code></dt>
403 <dd>Enable anonymous user access provided by
404 <module>mod_auth_anon</module>.</dd>
406 <dt><code>--enable-auth-dbm</code></dt>
407 <dd><module>mod_auth_dbm</module> provides for HTTP Basic
408 Authentication, where the usernames and passwords are stored in DBM
409 type database files. Use this option to enable the module.</dd>
411 <dt><code>--enable-auth-digest</code></dt>
412 <dd>Enable RFC2617 Digest authentication provided by
413 <module>mod_auth_digest</module>. This module uses plain text files
414 to store the credentials.</dd>
416 <dt><code>--enable-auth-ldap</code></dt>
417 <dd>Enable LDAP based authentication provided by
418 <module>mod_auth_ldap</module>.</dd>
420 <dt><code>--enable-cache</code></dt>
421 <dd>Enable dynamic file caching provided by
422 <module>mod_cache</module>. This experimental module may be
423 interesting for servers with high load or caching proxy servers. At
424 least one storage management module (e.g.
425 <module>mod_disk_cache</module> or <module>mod_mem_cache</module>)
426 is also necessary.</dd>
428 <dt><code>--enable-cern-meta</code></dt>
429 <dd>Enable the CERN-type meta files support provided by
430 <module>mod_cern_meta</module>.</dd>
432 <dt><code>--enable-charset-lite</code></dt>
433 <dd>Enable character set translation provided by
434 <module>mod_charset_lite</module>. This module will be installed by
435 default only on EBCDIC systems. On other systems, you have to enable
438 <dt><code>--enable-dav</code></dt>
439 <dd>Enable the WebDAV protocol handling provided by
440 <module>mod_dav</module>. Support for filesystem resources is
441 provided by the seperate module <module>mod_dav_fs</module>. This
442 module is also automatically enabled with
443 <code>--enable-dav</code>.<br/>
444 Note: <module>mod_dav</module> can only be used together with the
445 <code>http</code> protocol module.</dd>
447 <dt><code>--enable-dav-fs</code></dt>
448 <dd>Enable DAV support for filesystem resources, which is provided by
449 <module>mod_dav_fs</module>. This module is a provider for the
450 <module>mod_dav</module> module, so you should also use
451 <code>--enable-dav</code>.</dd>
453 <dt><code>--enable-dav-lock</code></dt>
454 <dd>Enable <module>mod_dav_lock</module> which provides generic DAV
455 locking support for backend modules. This module needs at least
456 <module>mod_dav</module> to function, so you should also use
457 <code>--enable-dav</code>.</dd>
459 <dt><code>--enable-deflate</code></dt>
460 <dd>Enable deflate transfer encoding provided by
461 <module>mod_deflate</module>.</dd>
463 <dt><code>--enable-disk-cache</code></dt>
464 <dd>Enable disk caching provided by
465 <module>mod_disk_cache</module>.</dd>
467 <dt><code>--enable-expires</code></dt>
468 <dd>Enable Expires header control provided by
469 <module>mod_expires</module>.</dd>
471 <dt><code>--enable-ext-filter</code></dt>
472 <dd>Enable the external filter support provided by
473 <module>mod_ext_filter</module>.</dd>
475 <dt><code>--enable-file-cache</code></dt>
476 <dd>Enable the file cache provided by
477 <module>mod_file_cache</module>.</dd>
479 <dt><code>--enable-headers</code></dt>
480 <dd>Enable control of HTTP headers provided by
481 <module>mod_headers</module>.</dd>
483 <dt><code>--enable-info</code></dt>
484 <dd>Enable the server information provided by
485 <module>mod_info</module>.</dd>
487 <dt><code>--enable-ldap</code></dt>
488 <dd>Enable LDAP caching and connection pooling services provided by
489 <module>mod_ldap</module>.</dd>
491 <dt><code>--enable-logio</code></dt>
492 <dd>Enable logging of input and output bytes including headers provided
493 by <module>mod_logio</module>.</dd>
495 <dt><code>--enable-mem-cache</code></dt>
496 <dd>Enable memory caching provided by
497 <module>mod_mem_cache</module>.</dd>
499 <dt><code>--enable-mime-magic</code></dt>
500 <dd>Enable automatical determining of MIME types, which is provided by
501 <module>mod_mime_magic</module>.</dd>
503 <dt><code>--enable-isapi</code></dt>
504 <dd>Enable the isapi extension support provided by
505 <module>mod_isapi</module>.</dd>
507 <dt><code>--enable-proxy</code></dt>
508 <dd>Enable the proxy/gateway functionality provided by
509 <module>mod_proxy</module>. The proxying capabilities for
510 <code>CONNECT</code>, <code>FTP</code> and <code>HTTP</code> are
511 provided by the seperate modules <module>mod_proxy_connect</module>,
512 <module>mod_proxy_ftp</module> and <module>mod_proxy_http</module>.
513 These three modules are also automatically enabled with
514 <code>--enable-proxy</code>.</dd>
516 <dt><code>--enable-proxy-connect</code></dt>
517 <dd>Enable proxy support for <code>CONNECT</code> request handling,
518 which is provided by <module>mod_proxy_connect</module>. This module
519 is an extension for the <module>mod_proxy</module> module, so you
520 should also use <code>--enable-proxy</code>.</dd>
522 <dt><code>--enable-proxy-ftp</code></dt>
523 <dd>Enable proxy support for <code>FTP</code> requests, which is
524 provided by <module>mod_proxy_ftp</module>.. This module
525 is an extension for the <module>mod_proxy</module> module, so you
526 should also use <code>--enable-proxy</code>.</dd>
528 <dt><code>--enable-proxy-http</code></dt>
529 <dd>Enable proxy support for <code>HTTP</code> requests, which is
530 provided by <module>mod_proxy_http</module>. This module
531 is an extension for the <module>mod_proxy</module> module, so you
532 should also use <code>--enable-proxy</code>.</dd>
534 <dt><code>--enable-rewrite</code></dt>
535 <dd>Enable rule based URL manipulation provided by
536 <module>mod_rewrite</module>.</dd>
538 <dt><code>--enable-so</code></dt>
539 <dd>Enable DSO capability provided by <module>mod_so</module>. This
540 module will be automatically enabled if you use the
541 <code>--enable-mods-shared</code> option.</dd>
543 <dt><code>--enable-speling</code></dt>
544 <dd>Enable the functionality to correct common URL misspellings, which
545 is provided by <module>mod_spelling</module>.</dd>
547 <dt><code>--enable-ssl</code></dt>
548 <dd>Enable support for SSL/TLS provided by
549 <module>mod_ssl</module>.</dd>
551 <dt><code>--enable-unique-id</code></dt>
552 <dd>Enable the generation of per-request unique ids, which is provided
553 by <module>mod_unique_id</module>.</dd>
555 <dt><code>--enable-usertrack</code></dt>
556 <dd>Enable user-session tracking provided by
557 <module>mod_usertrack</module>.</dd>
559 <dt><code>--enable-vhost-alias</code></dt>
560 <dd>Enable mass virtual hosting provided by
561 <module>mod_vhost_alias</module>.</dd>
565 <section id="developermodules"><title>Modules for developers</title>
566 <p>The following modules are useful only for developers and testing
567 purposes and are disabled by default. Use the following options to
568 enable them. If you are not sure whether you need one of these
569 modules, omit them.</p>
572 <!-- module doc needed -->
573 <dt><code>--enable-bucketeer</code></dt>
574 <dd>Enable the manipulation filter for buckets, which is provided by
575 <code>mod_bucketeer</code>.</dd>
577 <!-- module doc needed -->
578 <dt><code>--enable-case-filter</code></dt>
579 <dd>Enable the example uppercase conversion output filter support of
580 <code>mod_case_filter</code>.</dd>
582 <!-- module doc needed -->
583 <dt><code>--enable-case-filter-in</code></dt>
584 <dd>Enable the example uppercase conversion input filter support of
585 <code>mod_case_filter_in</code>.</dd>
587 <dt><code>--enable-echo</code></dt>
588 <dd>Enable the ECHO server provided by
589 <module>mod_echo</module>.</dd>
591 <dt><code>--enable-example</code></dt>
592 <dd>Enable the example and demo module
593 <module>mod_example</module>.</dd>
595 <!-- module doc needed -->
596 <dt><code>--enable-optional-fn-export</code></dt>
597 <dd>Enable the example for an optional function exporter, which is
598 provided by <code>mod_optional_fn_export</code>.</dd>
600 <!-- module doc needed -->
601 <dt><code>--enable-optional-fn-import</code></dt>
602 <dd>Enable the example for an optional function importer, which is
603 provided by <code>mod_optional_fn_import</code>.</dd>
605 <!-- module doc needed -->
606 <dt><code>--enable-optional-hook-export</code></dt>
607 <dd>Enable the example for an optional hook exporter, which is provided
608 by <code>mod_optional_hook_export</code>.</dd>
610 <!-- module doc needed -->
611 <dt><code>--enable-optional-hook-import</code></dt>
612 <dd>Enable the example optional hook importer, which is provided by
613 <code>mod_optional_hook_import</code>.</dd>
617 <section id="modules"><title>MPMs and third-party modules</title>
618 <p>To add the necessary Multi Processing Module and additional third-party
619 modules use the following options:</p>
622 <dt><code>--with-module=<var>module-type</var>:<var>module-file</var>
624 <dd><p>Add a third-party module to the list of statically linked
625 modules. The module source file <code><var>module-file</var></code>
626 will be searched in the <code>modules/<var>module-type</var></code>
627 subdirectory of your Apache HTTP server source tree so it has to be
628 placed there before. If it is not found here
629 <code>configure</code> is considering <var>module-file</var> to be
630 an absolute file path and tries to copy the source file into the
631 <var>module-type</var> subdirectory.</p>
632 <p>This option is useful to add small external modules consisting of
633 one source file. For more complex modules you should read the
634 vendor's documentation.</p>
635 <note><title>Note</title>
636 If you want to build a DSO module instead of a statically linked
637 use <a href="apxs.html">apxs</a>.</note>
640 <dt><code>--with-mpm=MPM</code></dt>
641 <dd>Choose the process model for your server. You have to select
642 exactly one <a href="../mpm.html">Multi-Processing Module</a>.
643 Otherwise the <a href="../mpm.html#defaults">default MPM</a> for
644 your operating system will be taken. Possible MPMs are
645 <module>beos</module>, <module>leader</module>,
646 <module>mpmt_os2</module>, <module>perchild</module>,
647 <module>prefork</module>, <module>threadpool</module> and
648 <module>worker</module>.</dd>
652 <section id="otheroptfeat"><title>Cumulative and other options</title>
654 <dt><code>--enable-maintainer-mode</code></dt>
655 <dd>Turn on debugging and compile time warnings.</dd>
657 <dt><code>--enable-mods-shared=<var>MODULE-LIST</var></code></dt>
659 <p>Defines a list of modules to be enabled and build as dynamic
660 shared modules. This mean, these module have to be loaded
661 dynamically by using the <directive
662 module="mod_so">LoadModule</directive> directive.</p>
663 <p><var>MODULE-LIST</var> is a space separated list of modulenames
664 enclosed by quotation marks. The module names are given without the
665 preceding <code>mod_</code>. For example:</p>
667 --enable-mods-shared='headers rewrite dav'
669 <p>Additionally you can use the special keywords <code>all</code> and
670 <code>most</code>. For example,</p>
672 --enable-mods-shared=most
674 <p>will compile most modules and build them as DSO modules.
675 <!-- See <a href="../install/enabledmodules.html">Overview of
676 enabled modules</a> for further information. --></p>
679 <dt><code>--enable-modules=<var>MODULE-LIST</var></code></dt>
680 <dd>This option behaves similar to <code>--enable-mods-shared</code>,
681 but will link the given modules statically. This mean, these modules
682 will always be present while running <code>httpd</code>. They need
683 not be loaded with <directive
684 module="mod_so">LoadModule</directive>.</dd>
686 <dt><code>--enable-v4-mapped</code></dt>
687 <dd>Allow IPv6 sockets to handle IPv4 connections.</dd>
689 <dt><code>--with-port=<var>PORT</var></code></dt>
690 <dd>This defines the port on which <code>httpd</code> will listen. This
691 port number is used when generating the configuration file
692 <code>httpd.conf</code>. The default is 80.</dd>
694 <dt><code>--with-program-name</code></dt>
695 <dd>Define an alternative executable name. The default is
696 <code>httpd</code>.</dd>
701 <section id="packages"><title>Optional packages</title>
702 <p>These options are used to define optional packages.</p>
704 <section id="generalpackages"><title>General syntax</title>
705 <p>Generally you can use the following syntax to define an optional
709 <dt><code>--with-<var>PACKAGE</var>[=<var>ARG</var>]</code></dt>
710 <dd>Use the package <var>PACKAGE</var>. The default value for
711 <var>ARG</var> is<code>yes</code>.</dd>
713 <dt><code>--without-<var>PACKAGE</var></code></dt>
714 <dd>Do not use the package <var>PACKAGE</var>. This is the same as
715 <code>--with-<var>PACKAGE</var>=no</code>. This option is provided by
716 <code>autoconf</code> but not very useful for the Apache HTTP
721 <!-- options not known are passed to packasges?
722 are there other important options for packages? -->
724 <section id="packageopt"><title>Specific packages</title>
726 <dt><code>--with-apr=<var>DIR</var>|<var>FILE</var></code></dt>
727 <dd>The Apache Portable Runtime (APR) is part of the <code>httpd</code>
728 source distribution and will automatically be build together with the
729 HTTP server. If you want to use an already installed APR instead you
730 have to tell <code>configure</code> the path to the
731 <code>apr-config</code> script. You may set the absolute path and name
732 or the directory to the installed APR. <code>apr-config</code> must
733 exists within this directory or the subdirectory
734 <code>bin</code>.</dd>
736 <dt><code>--with-apr-util=<var>DIR</var>|<var>FILE</var></code></dt>
737 <dd>The Apache Portable Runtime Utilities (APU) are part of the
738 <code>httpd</code> source distribution and will automatically be build
739 together with the HTTP server. If you want to use an already installed
740 APU instead you have to tell <code>configure</code> the path to the
741 <code>apu-config</code> script. You may set the absolute path and name
742 or the directory to the installed APU. <code>apu-config</code> must
743 exists within this directory or the subdirectory
744 <code>bin</code>.</dd>
746 <dt><code>--with-ssl=<var>DIR</var></code></dt>
747 <dd>If <module>mod_ssl</module> has been enabled <code>configure</code>
748 searches for an installed OpenSSL. You can set the directory path
749 to the SSL/TLS toolkit instead.</dd>
751 <dt><code>--with-z=<var>DIR</var></code></dt>
752 <dd><code>configure</code> searches automatically for an installed
753 <code>zlib</code> library if your source configuration requires one
754 (e.g., when <module>mod_deflate</module> is enabled). You can set the
755 directory path to the compression library instead.</dd>
758 <p>Several features of the Apache HTTP Server, including
759 <module>mod_authn_dbm</module> and <module>mod_rewrite</module>'s DBM
760 <directive module="mod_rewrite">RewriteMap</directive> use simple
761 key/value databases for quick lookups of information. SDBM is included
762 in the APU, so this database is always available. If you would like to
763 use other database types, use the following options to enable
767 <dt><code>--with-gdbm[=<var>path</var>]</code></dt>
768 <dd>If no <var>path</var> is specified, <code>configure</code> will
769 search for the include files and libraries of a GNU DBM
770 installation in the usual search paths. An explicit
771 <var>path</var> will cause <code>configure</code> to look in
772 <code><var>path</var>/lib</code> and
773 <code><var>path</var>/include</code> for the relevant files.
774 Finally, the <var>path</var> may specify specific include and
775 library paths separated by a colon.</dd>
777 <dt><code>--with-ndbm[=<var>path</var>]</code></dt>
778 <dd>Like <code>--with-gdbm</code>, bur searches for a New DBM
781 <dt><code>--with-berkeley-db[=<var>path</var>]</code></dt>
782 <dd>Like <code>--with-gdbm</code>, but searches for a Berkeley DB
786 <note><title>Note</title>
787 <p>The DBM options are provided by the APU and passed through to its
788 configuration script. They are useless when using an already
789 installed APU defined by <code>--with-apr-util</code>.</p>
790 <p>You may use more then one DBM implementation together with your
791 HTTP server. The appropriated DBM type will be configured within
792 the runtime configuration at each time.</p>
797 <section id="supportopt"><title>Options for support programs</title>
799 <dt><code>--enable-static-support</code></dt>
800 <dd>Build a statically linked version of the support binaries. This
801 means, a stand-alone executable will be built with all the necessary
802 libraries integrated. Otherwise the support binaries are linked
803 dynamically by default.</dd>
805 <dt><code>--enable-suexec</code></dt>
806 <dd>Use this option to enable <code><a
807 href="suexec.html">suexec</a></code>, which allows you to set
808 uid and gid for spawned processes. <strong>Do not use this
809 option unless you understand all the security implications of
810 running a suid binary on your server.</strong> Further options
811 to configure <code>suexec</code> are described <a
812 href="#suexec">below</a>.</dd> </dl>
814 <p>It is possible to create a statically linked binary of a single
815 support program by using the following options:</p>
818 <dt><code>--enable-static-ab</code></dt>
819 <dd>Build a statically linked version of <code><a
820 href="ab.html">ab</a></code>.</dd>
822 <!-- missing documentation for chechgid -->
823 <dt><code>--enable-static-checkgid</code></dt>
824 <dd>Build a statically linked version of <code>checkgid</code>.</dd>
826 <!-- missing documentation for htdbm -->
827 <dt><code>--enable-static-htdbm</code></dt>
828 <dd>Build a statically linked version of <code>htdbm</code>.</dd>
830 <dt><code>--enable-static-htdigest</code></dt>
831 <dd>Build a statically linked version of <code><a
832 href="htdigest.html">htdigest</a></code>.</dd>
834 <dt><code>--enable-static-htpasswd</code></dt>
835 <dd>Build a statically linked version of <code><a
836 href="htpasswd.html">htpasswd</a></code>.</dd>
838 <dt><code>--enable-static-logresolve</code></dt>
839 <dd>Build a statically linked version of <code><a
840 href="logresolve.html">logresolve</a></code>.</dd>
842 <dt><code>--enable-static-rotatelogs</code></dt>
843 <dd>Build a statically linked version of <code><a
844 href="rotatelogs.html">rotatelogs</a></code>.</dd>
847 <section id="suexec"><title>suexec configuration options</title>
848 <p>The following options are used to fine tune the behavior of <code><a
849 href="suexec.html">suexec</a></code>. See <a
850 href="suexec.html#install">Configuring and installing suEXEC</a>
851 for further information.</p>
854 <dt><code>--with-suexec-bin</code></dt>
855 <dd>This defines the path to suexec binary. Default is
856 <code>--sbindir</code> (see <a href="directoryfinetuning">Fine
857 tuning of installation directories</a>).</dd>
859 <dt><code>--with-suexec-caller</code></dt>
860 <dd>This defines the user allowed to call <code>suexec</code>. It should
861 be the same as the user under which <code>httpd</code> normally
864 <dt><code>--with-suexec-docroot</code></dt>
865 <dd>This defines the directory tree under which <code>suexec</code>
866 access is allowed for executables. Default value is
867 <code>--datadir/htdocs</code>.</dd>
869 <dt><code>--with-suexec-gidmin</code></dt>
870 <dd>Define this as the lowest GID allowed to be a target user for
871 <code>suexec</code>. The default value is 100.</dd>
873 <dt><code>--with-suexec-logfile</code></dt>
874 <dd>This defines the filename of the <code>suexec</code> logfile. By
875 default the logfile is named <code>suexec_log</code> and located in
876 <code>--logfiledir</code>.</dd>
878 <dt><code>--with-suexec-safepath</code></dt>
879 <dd>Define the value of the environment variable <code>PATH</code> to
880 be set for processes started by <code>suexec</code>. Default value is
881 <code>/usr/local/bin:/usr/bin:/bin</code>.</dd>
883 <dt><code>--with-suexec-userdir</code></dt>
884 <dd>This defines the subdirectory under the user's directory that
885 contains all executables for which <code>suexec</code> access is
886 allowed. This setting is necessary when you want to use
887 <code>suexec</code> together with user-specific directories (as
888 provided by <module>mod_userdir</module>). The default is
889 <code>public_html</code>.</dd>
891 <dt><code>--with-suexec-uidmin</code></dt>
892 <dd>Define this as the lowest UID allowed to be a target user for
893 <code>suexec</code>. The default value is 100.</dd>
895 <dt><code>--with-suexec-umask</code></dt>
896 <dd>Set <code>umask</code> for processes started by <code>suexec</code>.
897 It defaults to your system settings.</dd>
903 <section id="env"><title>Environment variables</title>
904 <p>There are some useful environment variables to override the choices made by
905 <code>configure</code> or to help it to find libraries and programs with
906 nonstandard names or locations.</p>
908 <!-- are these all useful variables? -->
910 <dt><code>CC</code></dt>
911 <dd>Define the C compiler command to be used for compilation.</dd>
913 <dt><code>CFLAGS</code></dt>
914 <dd>Set C compiler flags you want to use for compilation.</dd>
916 <dt><code>CPP</code></dt>
917 <dd>Define the C preprocessor command to be used.</dd>
919 <dt><code>CPPFLAGS</code></dt>
920 <dd>Set C/C++ preprocessor flags, e.g. <code>-I<var>includedir</var></code>
921 if you have headers in a nonstandard directory <var>includedir</var>.</dd>
923 <dt><code>LDFLAGS</code></dt>
924 <dd>Set linker flags, e.g. <code>-L<var>libdir</var></code> if you have
925 libraries in a nonstandard directory <var>libdir</var>.</dd>