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 <!-- $LastChangedRevision$ -->
7 Licensed to the Apache Software Foundation (ASF) under one or more
8 contributor license agreements. See the NOTICE file distributed with
9 this work for additional information regarding copyright ownership.
10 The ASF licenses this file to You under the Apache License, Version 2.0
11 (the "License"); you may not use this file except in compliance with
12 the License. You may obtain a copy of the License at
14 http://www.apache.org/licenses/LICENSE-2.0
16 Unless required by applicable law or agreed to in writing, software
17 distributed under the License is distributed on an "AS IS" BASIS,
18 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 See the License for the specific language governing permissions and
20 limitations under the License.
23 <manualpage metafile="configure.xml.meta">
24 <parentdocument href="./">Programs</parentdocument>
26 <title>configure - Configure the source tree</title>
29 <p>The <code>configure</code> script configures the source tree
30 for compiling and installing the Apache HTTP Server on your
31 particular platform. Various options allow the compilation of a
32 server corresponding to your personal requirements.</p>
34 <p>This script, included in the root directory of the source
35 distribution, is for compilation on Unix and Unix-like systems
36 only. For other platforms, see the <a
37 href="../platform/">platform</a> documentation.</p>
40 <seealso><a href="../install.html">Compiling and Installing</a></seealso>
42 <section id="synopsis"><title>Synopsis</title>
43 <p>You should call the <code>configure</code> script from within the
44 root directory of the distribution.</p>
46 <p><code><strong>./configure</strong> [<var>OPTION</var>]...
47 [<var>VAR</var>=<var>VALUE</var>]...</code></p>
49 <p>To assign environment variables (e.g. <code>CC</code>,
50 <code>CFLAGS</code> ...), specify them as
51 <code><var>VAR</var>=<var>VALUE</var></code>. See <a href="#env">below</a>
52 for descriptions of some of the useful variables.</p>
55 <section id="options"><title>Options</title>
57 <li><a href="#configurationoptions">Configuration options</a></li>
58 <li><a href="#installationdirectories">Installation directories</a></li>
59 <li><a href="#systemtypes">System types</a></li>
60 <li><a href="#optionalfeatures">Optional features</a></li>
61 <li><a href="#supportopt">Options for support programs</a></li>
64 <section id="configurationoptions"><title>Configuration options</title>
66 <p>The following options influence the behavior of
67 <code>configure</code> itself.</p>
70 <dt><code>-C</code></dt>
71 <dt><code>--config-cache</code></dt>
72 <dd>This is an alias for <code>--cache-file=config.cache</code></dd>
74 <dt><code>--cache-file=<var>FILE</var></code></dt>
75 <dd>The test results will be cached in file <var>FILE</var>.
76 This option is disabled by default.</dd>
78 <dt><code>-h</code></dt>
79 <dt><code>--help [short|recursive]</code></dt>
80 <dd>Output the help and exit. With the argument <code>short</code> only
81 options specific to this package will displayed. The argument
82 <code>recursive</code> displays the short help of all the included
85 <dt><code>-n</code></dt>
86 <dt><code>--no-create</code></dt>
87 <dd>The <code>configure</code> script is run normally but does
88 not create output files. This is useful to check the test results
89 before generating makefiles for compilation.</dd>
91 <dt><code>-q</code></dt>
92 <dt><code>--quiet</code></dt>
93 <dd>Do not print <code>checking ...</code> messages during the
94 configure process.</dd>
96 <dt><code>--srcdir=<var>DIR</var></code></dt>
97 <dd>Defines directory <var>DIR</var> to be the source file directory.
98 Default is the directory where <code>configure</code> is located, or
99 the parent directory.</dd>
101 <dt><code>--silent</code></dt>
102 <dd>Same as <code>--quiet</code></dd>
106 <dd>Display copyright information and exit.</dd>
110 <section id="installationdirectories"><title>Installation
113 <p>These options define the installation directory. The installation
114 tree depends on the selected layout.</p>
117 <dt><code>--prefix=<var>PREFIX</var></code></dt>
118 <dd>Install architecture-independent files in <var>PREFIX</var>.
119 By default the installation directory is set to
120 <code>/usr/local/apache2</code>.</dd>
122 <dt><code>--exec-prefix=<var>EPREFIX</var></code></dt>
123 <dd>Install architecture-dependent files in <var>EPREFIX</var>.
124 By default the installation directory is set to the
125 <var>PREFIX</var> directory.</dd>
128 <p>By default, <code>make install</code> will install all the files in
129 <code>/usr/local/apache2/bin</code>, <code>/usr/local/apache2/lib</code>
130 etc. You can specify an installation prefix other than
131 <code>/usr/local/apache2</code> using <code>--prefix</code>,
132 for instance <code>--prefix=$HOME</code>.</p>
134 <section id="layout"><title>Define a directory layout</title>
136 <dt><code>--enable-layout=<var>LAYOUT</var></code></dt>
137 <dd>Configure the source code and build scripts to assume an
138 installation tree based on the layout <var>LAYOUT</var>. This allows
139 you to separately specify the locations for each type of file within
140 the Apache HTTP Server installation. The <code>config.layout</code>
141 file contains several example configurations, and you can also create
142 your own custom configuration following the examples. The different
143 layouts in this file are grouped into <code><Layout
144 FOO>...</Layout></code> sections and referred to by name as
145 in <code>FOO</code>. The default layout is <code>Apache</code>.</dd>
149 <section id="directoryfinetuning"><title>Fine tuning of the installation
152 <p>For better control of the installation directories, use the options
153 below. Please note that the directory defaults are set by
154 <code>autoconf</code> and are overwritten by the corresponding layout
158 <!-- only apr-config and apu-config are installed at bindir.
159 everything else is stored at sbindir. ==> clarify/change this -->
160 <dt><code>--bindir=<var>DIR</var></code></dt>
161 <dd>Install user executables in <var>DIR</var>. The user executables
162 are supporting programs like <program>htpasswd</program>,
163 <program>dbmmanage</program>, etc. which are useful for site
164 administrators. By default <var>DIR</var> is set to
165 <code><var>EPREFIX</var>/bin</code>.</dd>
167 <dt><code>--datadir=<var>DIR</var></code></dt>
168 <dd>Install read-only architecture-independent data in <var>DIR</var>.
169 By default <code>datadir</code> is set to
170 <code><var>PREFIX</var>/share</code>. This option is offered by
171 <code>autoconf</code> and currently unused.</dd>
173 <dt><code>--includedir=<var>DIR</var></code></dt>
174 <dd>Install C header files in <var>DIR</var>. By default
175 <code>includedir</code> is set to
176 <code><var>EPREFIX</var>/include</code>.</dd>
178 <dt><code>--infodir=<var>DIR</var></code></dt>
179 <dd>Install info documentation in <var>DIR</var>.
180 By default <code>infodir</code> is set to
181 <code><var>PREFIX</var>/info</code>. This option is currently
184 <dt><code>--libdir=<var>DIR</var></code></dt>
185 <dd>Install object code libraries in <var>DIR</var>. By default
186 <code>libdir</code> is set to
187 <code><var>EPREFIX</var>/lib</code>.</dd>
189 <dt><code>--libexecdir=<var>DIR</var></code></dt>
190 <dd>Install the program executables (i.e., shared modules) in
191 <var>DIR</var>. By default <code>libexecdir</code> is set to
192 <code><var>EPREFIX</var>/libexec</code>.</dd>
194 <dt><code>--localstatedir=<var>DIR</var></code></dt>
195 <dd>Install modifiable single-machine data in <var>DIR</var>.
196 By default <code>localstatedir</code> is set to
197 <code><var>PREFIX</var>/var</code>. This option is offered by
198 <code>autoconf</code> and currently unused.</dd>
200 <dt><code>--mandir=<var>DIR</var></code></dt>
201 <dd>Install the man documentation in <var>DIR</var>. By default
202 <code>mandir</code> is set to
203 <code><var>EPREFIX</var>/man</code>.</dd>
205 <dt><code>--oldincludedir=<var>DIR</var></code></dt>
206 <dd>Install C header files for non-gcc in <var>DIR</var>.
207 By default <code>oldincludedir</code> is set to
208 <code>/usr/include</code>. This option is offered by
209 <code>autoconf</code> and currently unused.</dd>
211 <dt><code>--sbindir=<var>DIR</var></code></dt>
212 <dd>Install the system administrator executables in <var>DIR</var>.
213 Those are server programs like <program>httpd</program>,
214 <program>apachectl</program>, <program>suexec</program>, etc. which
215 are neccessary to run the Apache HTTP Server. By default
216 <code>sbindir</code> is set to
217 <code><var>EPREFIX</var>/sbin</code>.</dd>
219 <dt><code>--sharedstatedir=<var>DIR</var></code></dt>
220 <dd>Install modifiable architecture-independent data in <var>DIR</var>.
221 By default <code>sharedstatedir</code> is set to
222 <code><var>PREFIX</var>/com</code>. This option is offered by
223 <code>autoconf</code> and currently unused.</dd>
225 <dt><code>--sysconfdir=<var>DIR</var></code></dt>
226 <dd>Install read-only single-machine data like the server configuration
227 files <code>httpd.conf</code>, <code>mime.types</code>, etc. in
228 <var>DIR</var>. By default <code>sysconfdir</code> is set to
229 <code><var>PREFIX</var>/etc</code>.</dd>
234 <section id="systemtypes"><title>System types</title>
236 <p>These options are used to cross-compile the Apache HTTP Server to run on
237 another system. In normal cases, when building and running the server on
238 the same system, these options are not used.</p>
241 <dt><code>--build=<var>BUILD</var></code></dt>
242 <dd>Defines the system type of the system on which the tools are being
243 built. It defaults to the result of the script
244 <code>config.guess</code>.</dd>
246 <dt><code>--host=<var>HOST</var></code></dt>
247 <dd>Defines the system type of the system on which the server will run.
248 <var>HOST</var> defaults to <var>BUILD</var>.</dd>
250 <dt><code>--target=<var>TARGET</var></code></dt>
251 <dd>Configure for building compilers for the system type
252 <var>TARGET</var>. It defaults to <var>HOST</var>. This option is
253 offered by <code>autoconf</code> and not necessary for the Apache HTTP
258 <section id="optionalfeatures"><title>Optional Features</title>
260 <p>These options are used to fine tune the features your HTTP server will
263 <section id="generaloptfeat"><title>General syntax</title>
264 <p>Generally you can use the following syntax to enable or disable a
268 <dt><code>--disable-<var>FEATURE</var></code></dt>
269 <dd>Do not include <var>FEATURE</var>. This is the same as
270 <code>--enable-<var>FEATURE</var>=no</code>.</dd>
272 <dt><code>--enable-<var>FEATURE</var>[=<var>ARG</var>]</code></dt>
273 <dd>Include <var>FEATURE</var>. The default value for <var>ARG</var>
274 is <code>yes</code>.</dd>
276 <dt><code>--enable-<var>MODULE</var>=shared</code></dt>
277 <dd>The corresponding module will be build as DSO module.</dd>
279 <dt><code>--enable-<var>MODULE</var>=static</code></dt>
280 <dd>By default enabled modules are linked statically. You can force
281 this explicitly.</dd>
284 <note><title>Note</title>
285 <code>configure</code> will not complain about
286 <code>--enable-<var>foo</var></code> even if <var>foo</var> doesn't
287 exist, so you need to type carefully.
291 <!-- to do: add better enable-module descriptions and recommendations -->
292 <section id="enabledmodules"><title>Modules enabled by default</title>
293 <p>Some modules are compiled by default and have to be disabled
294 explicitly. Use the following options to remove discrete modules from
295 the compilation process.</p>
298 <dt><code>--disable-actions</code></dt>
299 <dd>Disable action triggering on requests, which is provided by
300 <module>mod_actions</module>.</dd>
302 <dt><code>--disable-alias</code></dt>
303 <dd>Disable the mapping of requests to different parts of the
304 filesystem, which is provided by <module>mod_alias</module>.</dd>
306 <dt><code>--disable-asis</code></dt>
307 <dd>Disable support for as-is filetypes, which is provided by
308 <module>mod_asis</module>.</dd>
310 <dt><code>--disable-auth</code></dt>
311 <dd>Disable user-based access control provided by
312 <module>mod_auth</module>. This module provides for HTTP Basic
313 Authentication, where the usernames and passwords are stored in
314 plain text files.</dd>
316 <dt><code>--disable-autoindex</code></dt>
317 <dd>Disable the directory listing functionality provided by
318 <module>mod_autoindex</module>.</dd>
320 <dt><code>--disable-access</code></dt>
321 <dd>Disable host-based access control provided by
322 <module>mod_access</module>.</dd>
324 <dt><code>--disable-cgi</code></dt>
325 <dd><module>mod_cgi</module>, which provides support for CGI scripts,
326 is enabled by default when using a non-threaded MPM. Use this
327 option to disable CGI support.</dd>
329 <dt><code>--disable-cgid</code></dt>
330 <dd>When using the threaded MPMs <module>worker</module> or
331 <module>perchild</module> support for CGI scripts is provided by
332 <module>mod_cgid</module> by default. To disable CGI support use
335 <dt><code>--disable-charset-lite</code></dt>
336 <dd>Disable character set translation provided by
337 <module>mod_charset_lite</module>. This module will be installed by
338 default only on EBCDIC systems.</dd>
340 <dt><code>--disable-dir</code></dt>
341 <dd>Disable directory request handling provided by
342 <module>mod_dir</module>.</dd>
344 <dt><code>--disable-env</code></dt>
345 <dd>Disable setting and clearing of environment variables, which is
346 provided by <module>mod_env</module>.</dd>
348 <!-- configure mentions enable-http, but disable-http would make much
350 <dt><code>--disable-http</code></dt>
351 <dd>Disable the HTTP protocol handling. The <code>http</code>
352 module is a basic one, enabling the server to function as an
353 HTTP server. It is only useful to disable it if you want to use
354 another protocol module instead. <strong>Don't disable this
355 module unless you are really sure what you are doing.</strong>
357 Note: This module will always be linked statically.</dd>
359 <dt><code>--disable-imagemap</code></dt>
360 <dd>Disable support for server based imagemaps, which provided by
361 <module>mod_imagemap</module>.</dd>
363 <dt><code>--disable-include</code></dt>
364 <dd>Disable Server Side Includes provided by
365 <module>mod_include</module>.</dd>
367 <dt><code>--disable-log-config</code></dt>
368 <dd>Disable the logging configuration provided by
369 <module>mod_log_config</module>. You won't be able to log requests
370 to the server without this module.</dd>
372 <dt><code>--disable-mime</code></dt>
373 <dd><module>mod_mime</module> associates the requested
374 filename's extensions with the file's behavior and content
375 (<glossary>mime-type</glossary>, language, character set and
376 encoding). Disabling this module is normally not recommended.</dd>
378 <dt><code>--disable-negotiation</code></dt>
379 <dd>Disable content negotiation provided by
380 <module>mod_negotiation</module>.</dd>
382 <dt><code>--disable-setenvif</code></dt>
383 <dd>Disable support for basing environment variables on headers,
384 which is provided by <module>mod_setenvif</module>.</dd>
386 <dt><code>--disable-status</code></dt>
387 <dd>Disable the process/thread monitoring, which is provided by
388 <module>mod_status</module>.</dd>
390 <dt><code>--disable-userdir</code></dt>
391 <dd>Disable the mapping of requests to user-specific directories,
392 which is provided by <module>mod_userdir</module>.</dd>
396 <section id="disabledmodules"><title>Modules, disabled by default</title>
397 <p>Some modules are compiled by default and have to be enabled
398 explicitly or by using the keywords <code>most</code> or
399 <code>all</code> (see <code>--enable-mods-shared</code> below for
400 further explanation) to be available. Therefore use the options
404 <dt><code>--enable-auth-anon</code></dt>
405 <dd>Enable anonymous user access provided by
406 <module>mod_auth_anon</module>.</dd>
408 <dt><code>--enable-auth-dbm</code></dt>
409 <dd><module>mod_auth_dbm</module> provides for HTTP Basic
410 Authentication, where the usernames and passwords are stored in DBM
411 type database files. Use this option to enable the module.</dd>
413 <dt><code>--enable-auth-digest</code></dt>
414 <dd>Enable RFC2617 Digest authentication provided by
415 <module>mod_auth_digest</module>. This module uses plain text files
416 to store the credentials.</dd>
418 <dt><code>--enable-authnz-ldap</code></dt>
419 <dd>Enable LDAP based authentication provided by
420 <module>mod_authnz_ldap</module>.</dd>
422 <dt><code>--enable-cache</code></dt>
423 <dd>Enable dynamic file caching provided by
424 <module>mod_cache</module>. This experimental module may be
425 interesting for servers with high load or caching proxy servers. At
426 least one storage management module (e.g.
427 <module>mod_disk_cache</module> or <module>mod_mem_cache</module>)
428 is also necessary.</dd>
430 <dt><code>--enable-cern-meta</code></dt>
431 <dd>Enable the CERN-type meta files support provided by
432 <module>mod_cern_meta</module>.</dd>
434 <dt><code>--enable-charset-lite</code></dt>
435 <dd>Enable character set translation provided by
436 <module>mod_charset_lite</module>. This module will be installed by
437 default only on EBCDIC systems. On other systems, you have to enable
440 <dt><code>--enable-dav</code></dt>
441 <dd>Enable the WebDAV protocol handling provided by
442 <module>mod_dav</module>. Support for filesystem resources is
443 provided by the separate module <module>mod_dav_fs</module>. This
444 module is also automatically enabled with
445 <code>--enable-dav</code>.<br/>
446 Note: <module>mod_dav</module> can only be used together with the
447 <code>http</code> protocol module.</dd>
449 <dt><code>--enable-dav-fs</code></dt>
450 <dd>Enable DAV support for filesystem resources, which is provided by
451 <module>mod_dav_fs</module>. This module is a provider for the
452 <module>mod_dav</module> module, so you should also use
453 <code>--enable-dav</code>.</dd>
455 <dt><code>--enable-dav-lock</code></dt>
456 <dd>Enable <module>mod_dav_lock</module> which provides generic DAV
457 locking support for backend modules. This module needs at least
458 <module>mod_dav</module> to function, so you should also use
459 <code>--enable-dav</code>.</dd>
461 <dt><code>--enable-deflate</code></dt>
462 <dd>Enable deflate transfer encoding provided by
463 <module>mod_deflate</module>.</dd>
465 <dt><code>--enable-disk-cache</code></dt>
466 <dd>Enable disk caching provided by
467 <module>mod_disk_cache</module>.</dd>
469 <dt><code>--enable-expires</code></dt>
470 <dd>Enable Expires header control provided by
471 <module>mod_expires</module>.</dd>
473 <dt><code>--enable-ext-filter</code></dt>
474 <dd>Enable the external filter support provided by
475 <module>mod_ext_filter</module>.</dd>
477 <dt><code>--enable-file-cache</code></dt>
478 <dd>Enable the file cache provided by
479 <module>mod_file_cache</module>.</dd>
481 <dt><code>--enable-headers</code></dt>
482 <dd>Enable control of HTTP headers provided by
483 <module>mod_headers</module>.</dd>
485 <dt><code>--enable-info</code></dt>
486 <dd>Enable the server information provided by
487 <module>mod_info</module>.</dd>
489 <dt><code>--enable-ldap</code></dt>
490 <dd>Enable LDAP caching and connection pooling services provided by
491 <module>mod_ldap</module>.</dd>
493 <dt><code>--enable-logio</code></dt>
494 <dd>Enable logging of input and output bytes including headers provided
495 by <module>mod_logio</module>.</dd>
497 <dt><code>--enable-mem-cache</code></dt>
498 <dd>Enable memory caching provided by
499 <module>mod_mem_cache</module>.</dd>
501 <dt><code>--enable-mime-magic</code></dt>
503 automatical determining of <glossary ref="mime-type">MIME
504 types</glossary>, which is provided by
505 <module>mod_mime_magic</module>.</dd>
507 <dt><code>--enable-isapi</code></dt>
508 <dd>Enable the isapi extension support provided by
509 <module>mod_isapi</module>.</dd>
511 <dt><code>--enable-proxy</code></dt>
512 <dd>Enable the proxy/gateway functionality provided by
513 <module>mod_proxy</module>. The proxying capabilities for
514 <code>AJP13</code>, <code>CONNECT</code>, <code>FTP</code>,
515 <code>HTTP</code> and the balancer are provided by the separate
516 modules <module>mod_proxy_ajp</module>,
517 <module>mod_proxy_connect</module>, <module>mod_proxy_ftp</module>,
518 <module>mod_proxy_http</module> and
519 <module>mod_proxy_balancer</module>.
520 These five modules are also automatically enabled with
521 <code>--enable-proxy</code>.</dd>
523 <dt><code>--enable-proxy-ajp</code></dt>
524 <dd>Enable proxy support for <code>AJP13 (Apache JServ Protocol 1.3)</code>
525 request handling, which is provided by <module>mod_proxy_ajp</module>.
526 This module is an extension for the <module>mod_proxy</module> module,
527 so you should also use <code>--enable-proxy</code>.</dd>
529 <dt><code>--enable-proxy-balancer</code></dt>
530 <dd>Enable load balancing support for the <code>AJP13</code>,
531 <code>FTP</code> and <code>HTTP</code> protocols, which is provided by
532 <module>mod_proxy_balancer</module>. This module is an extension for the
533 <module>mod_proxy</module> module, so you should also use
534 <code>--enable-proxy</code>.</dd>
536 <dt><code>--enable-proxy-connect</code></dt>
537 <dd>Enable proxy support for <code>CONNECT</code> request handling,
538 which is provided by <module>mod_proxy_connect</module>. This module
539 is an extension for the <module>mod_proxy</module> module, so you
540 should also use <code>--enable-proxy</code>.</dd>
542 <dt><code>--enable-proxy-ftp</code></dt>
543 <dd>Enable proxy support for <code>FTP</code> requests, which is
544 provided by <module>mod_proxy_ftp</module>. This module
545 is an extension for the <module>mod_proxy</module> module, so you
546 should also use <code>--enable-proxy</code>.</dd>
548 <dt><code>--enable-proxy-http</code></dt>
549 <dd>Enable proxy support for <code>HTTP</code> requests, which is
550 provided by <module>mod_proxy_http</module>. This module
551 is an extension for the <module>mod_proxy</module> module, so you
552 should also use <code>--enable-proxy</code>.</dd>
554 <dt><code>--enable-rewrite</code></dt>
555 <dd>Enable rule based URL manipulation provided by
556 <module>mod_rewrite</module>.</dd>
558 <dt><code>--enable-so</code></dt>
559 <dd>Enable DSO capability provided by <module>mod_so</module>. This
560 module will be automatically enabled if you use the
561 <code>--enable-mods-shared</code> option.</dd>
563 <dt><code>--enable-speling</code></dt>
564 <dd>Enable the functionality to correct common URL misspellings, which
565 is provided by <module>mod_speling</module>.</dd>
567 <dt><code>--enable-ssl</code></dt>
568 <dd>Enable support for SSL/TLS provided by
569 <module>mod_ssl</module>.</dd>
571 <dt><code>--enable-unique-id</code></dt>
572 <dd>Enable the generation of per-request unique ids, which is provided
573 by <module>mod_unique_id</module>.</dd>
575 <dt><code>--enable-usertrack</code></dt>
576 <dd>Enable user-session tracking provided by
577 <module>mod_usertrack</module>.</dd>
579 <dt><code>--enable-vhost-alias</code></dt>
580 <dd>Enable mass virtual hosting provided by
581 <module>mod_vhost_alias</module>.</dd>
585 <section id="developermodules"><title>Modules for developers</title>
586 <p>The following modules are useful only for developers and testing
587 purposes and are disabled by default. Use the following options to
588 enable them. If you are not sure whether you need one of these
589 modules, omit them.</p>
592 <!-- module doc needed -->
593 <dt><code>--enable-bucketeer</code></dt>
594 <dd>Enable the manipulation filter for buckets, which is provided by
595 <code>mod_bucketeer</code>.</dd>
597 <!-- module doc needed -->
598 <dt><code>--enable-case-filter</code></dt>
599 <dd>Enable the example uppercase conversion output filter support of
600 <code>mod_case_filter</code>.</dd>
602 <!-- module doc needed -->
603 <dt><code>--enable-case-filter-in</code></dt>
604 <dd>Enable the example uppercase conversion input filter support of
605 <code>mod_case_filter_in</code>.</dd>
607 <dt><code>--enable-echo</code></dt>
608 <dd>Enable the ECHO server provided by
609 <module>mod_echo</module>.</dd>
611 <dt><code>--enable-example</code></dt>
612 <dd>Enable the example and demo module
613 <module>mod_example</module>.</dd>
615 <!-- module doc needed -->
616 <dt><code>--enable-optional-fn-export</code></dt>
617 <dd>Enable the example for an optional function exporter, which is
618 provided by <code>mod_optional_fn_export</code>.</dd>
620 <!-- module doc needed -->
621 <dt><code>--enable-optional-fn-import</code></dt>
622 <dd>Enable the example for an optional function importer, which is
623 provided by <code>mod_optional_fn_import</code>.</dd>
625 <!-- module doc needed -->
626 <dt><code>--enable-optional-hook-export</code></dt>
627 <dd>Enable the example for an optional hook exporter, which is provided
628 by <code>mod_optional_hook_export</code>.</dd>
630 <!-- module doc needed -->
631 <dt><code>--enable-optional-hook-import</code></dt>
632 <dd>Enable the example optional hook importer, which is provided by
633 <code>mod_optional_hook_import</code>.</dd>
637 <section id="modules"><title>MPMs and third-party modules</title>
638 <p>To add the necessary Multi Processing Module and additional third-party
639 modules use the following options:</p>
642 <dt><code>--with-module=<var>module-type</var>:<var>module-file</var>[,
643 <var>module-type</var>:<var>module-file</var>]</code></dt>
644 <dd><p>Add one or more third-party modules to the list of statically linked
645 modules. The module source file <code><var>module-file</var></code>
646 will be searched in the <code>modules/<var>module-type</var></code>
647 subdirectory of your Apache HTTP server source tree. If it is not found
648 there <code>configure</code> is considering <var>module-file</var> to be
649 an absolute file path and tries to copy the source file into the
650 <var>module-type</var> subdirectory. If the subdirectory doesn't
651 exist it will be created and populated with a standard
652 <code>Makefile.in</code>.</p>
653 <p>This option is useful to add small external modules consisting of
654 one source file. For more complex modules you should read the
655 vendor's documentation.</p>
656 <note><title>Note</title>
657 If you want to build a DSO module instead of a statically linked
658 use <program>apxs</program>.</note>
661 <dt><code>--with-mpm=MPM</code></dt>
662 <dd>Choose the process model for your server. You have to select
663 exactly one <a href="../mpm.html">Multi-Processing Module</a>.
664 Otherwise the <a href="../mpm.html#defaults">default MPM</a> for
665 your operating system will be taken. Possible MPMs are
666 <module>beos</module>, <module>leader</module>,
667 <module>mpmt_os2</module>, <module>perchild</module>,
668 <module>prefork</module>, <module>threadpool</module> and
669 <module>worker</module>.</dd>
673 <section id="otheroptfeat"><title>Cumulative and other options</title>
675 <dt><code>--enable-maintainer-mode</code></dt>
676 <dd>Turn on debugging and compile time warnings.</dd>
678 <dt><code>--enable-mods-shared=<var>MODULE-LIST</var></code></dt>
680 <p>Defines a list of modules to be enabled and build as dynamic
681 shared modules. This mean, these module have to be loaded
682 dynamically by using the <directive
683 module="mod_so">LoadModule</directive> directive.</p>
684 <p><var>MODULE-LIST</var> is a space separated list of modulenames
685 enclosed by quotation marks. The module names are given without the
686 preceding <code>mod_</code>. For example:</p>
688 --enable-mods-shared='headers rewrite dav'
690 <p>Additionally you can use the special keywords <code>all</code> and
691 <code>most</code>. For example,</p>
693 --enable-mods-shared=most
695 <p>will compile most modules and build them as DSO modules.
696 <!-- See <a href="../install/enabledmodules.html">Overview of
697 enabled modules</a> for further information. --></p>
700 <dt><code>--enable-modules=<var>MODULE-LIST</var></code></dt>
701 <dd>This option behaves similar to <code>--enable-mods-shared</code>,
702 but will link the given modules statically. This mean, these modules
703 will always be present while running <program>httpd</program>. They need
704 not be loaded with <directive
705 module="mod_so">LoadModule</directive>.</dd>
707 <dt><code>--enable-v4-mapped</code></dt>
708 <dd>Allow IPv6 sockets to handle IPv4 connections.</dd>
710 <dt><code>--with-port=<var>PORT</var></code></dt>
711 <dd>This defines the port on which <program>httpd</program> will listen.
712 This port number is used when generating the configuration file
713 <code>httpd.conf</code>. The default is 80.</dd>
715 <dt><code>--with-program-name</code></dt>
716 <dd>Define an alternative executable name. The default is
717 <code>httpd</code>.</dd>
722 <section id="packages"><title>Optional packages</title>
723 <p>These options are used to define optional packages.</p>
725 <section id="generalpackages"><title>General syntax</title>
726 <p>Generally you can use the following syntax to define an optional
730 <dt><code>--with-<var>PACKAGE</var>[=<var>ARG</var>]</code></dt>
731 <dd>Use the package <var>PACKAGE</var>. The default value for
732 <var>ARG</var> is<code>yes</code>.</dd>
734 <dt><code>--without-<var>PACKAGE</var></code></dt>
735 <dd>Do not use the package <var>PACKAGE</var>. This is the same as
736 <code>--with-<var>PACKAGE</var>=no</code>. This option is provided by
737 <code>autoconf</code> but not very useful for the Apache HTTP
742 <!-- options not known are passed to packages?
743 are there other important options for packages? -->
745 <section id="packageopt"><title>Specific packages</title>
747 <dt><code>--with-apr=<var>DIR</var>|<var>FILE</var></code></dt>
748 <dd>The <glossary ref="apr">Apache Portable Runtime</glossary> (APR)
750 source distribution and will automatically be build together with the
751 HTTP server. If you want to use an already installed APR instead you
752 have to tell <code>configure</code> the path to the
753 <code>apr-config</code> script. You may set the absolute path and name
754 or the directory to the installed APR. <code>apr-config</code> must
755 exist within this directory or the subdirectory
756 <code>bin</code>.</dd>
758 <dt><code>--with-apr-util=<var>DIR</var>|<var>FILE</var></code></dt>
759 <dd>The Apache Portable Runtime Utilities (APU) are part of the
760 httpd source distribution and will automatically be build
761 together with the HTTP server. If you want to use an already installed
762 APU instead you have to tell <code>configure</code> the path to the
763 <code>apu-config</code> script. You may set the absolute path and name
764 or the directory to the installed APU. <code>apu-config</code> must
765 exists within this directory or the subdirectory
766 <code>bin</code>.</dd>
768 <dt><code>--with-ssl=<var>DIR</var></code></dt>
769 <dd>If <module>mod_ssl</module> has been enabled <code>configure</code>
770 searches for an installed OpenSSL. You can set the directory path
771 to the SSL/TLS toolkit instead.</dd>
773 <dt><code>--with-z=<var>DIR</var></code></dt>
774 <dd><code>configure</code> searches automatically for an installed
775 <code>zlib</code> library if your source configuration requires one
776 (e.g., when <module>mod_deflate</module> is enabled). You can set the
777 directory path to the compression library instead.</dd>
780 <p>Several features of the Apache HTTP Server, including
781 <module>mod_authn_dbm</module> and <module>mod_rewrite</module>'s DBM
782 <directive module="mod_rewrite">RewriteMap</directive> use simple
783 key/value databases for quick lookups of information. SDBM is included
784 in the APU, so this database is always available. If you would like to
785 use other database types, use the following options to enable
789 <dt><code>--with-gdbm[=<var>path</var>]</code></dt>
790 <dd>If no <var>path</var> is specified, <code>configure</code> will
791 search for the include files and libraries of a GNU DBM
792 installation in the usual search paths. An explicit
793 <var>path</var> will cause <code>configure</code> to look in
794 <code><var>path</var>/lib</code> and
795 <code><var>path</var>/include</code> for the relevant files.
796 Finally, the <var>path</var> may specify specific include and
797 library paths separated by a colon.</dd>
799 <dt><code>--with-ndbm[=<var>path</var>]</code></dt>
800 <dd>Like <code>--with-gdbm</code>, bur searches for a New DBM
803 <dt><code>--with-berkeley-db[=<var>path</var>]</code></dt>
804 <dd>Like <code>--with-gdbm</code>, but searches for a Berkeley DB
808 <note><title>Note</title>
809 <p>The DBM options are provided by the APU and passed through to its
810 configuration script. They are useless when using an already
811 installed APU defined by <code>--with-apr-util</code>.</p>
812 <p>You may use more then one DBM implementation together with your
813 HTTP server. The appropriated DBM type will be configured within
814 the runtime configuration at each time.</p>
819 <section id="supportopt"><title>Options for support programs</title>
821 <dt><code>--enable-static-support</code></dt>
822 <dd>Build a statically linked version of the support binaries. This
823 means, a stand-alone executable will be built with all the necessary
824 libraries integrated. Otherwise the support binaries are linked
825 dynamically by default.</dd>
827 <dt><code>--enable-suexec</code></dt>
828 <dd>Use this option to enable <program>
829 suexec</program>, which allows you to set
830 uid and gid for spawned processes. <strong>Do not use this
831 option unless you understand all the security implications of
832 running a suid binary on your server.</strong> Further options
833 to configure <program>suexec</program> are described <a
834 href="#suexec">below</a>.</dd> </dl>
836 <p>It is possible to create a statically linked binary of a single
837 support program by using the following options:</p>
840 <dt><code>--enable-static-ab</code></dt>
841 <dd>Build a statically linked version of <program>
844 <!-- missing documentation for chechgid -->
845 <dt><code>--enable-static-checkgid</code></dt>
846 <dd>Build a statically linked version of <code>checkgid</code>.</dd>
848 <dt><code>--enable-static-htdbm</code></dt>
849 <dd>Build a statically linked version of <program>
850 htdbm</program>.</dd>
852 <dt><code>--enable-static-htdigest</code></dt>
853 <dd>Build a statically linked version of <program>
854 htdigest</program>.</dd>
856 <dt><code>--enable-static-htpasswd</code></dt>
857 <dd>Build a statically linked version of <program>
858 htpasswd</program>.</dd>
860 <dt><code>--enable-static-logresolve</code></dt>
861 <dd>Build a statically linked version of <program>
862 logresolve</program>.</dd>
864 <dt><code>--enable-static-rotatelogs</code></dt>
865 <dd>Build a statically linked version of <program>
866 rotatelogs</program>.</dd>
869 <section id="suexec"><title>suexec configuration options</title>
870 <p>The following options are used to fine tune the behavior of <program>
871 suexec</program>. See <a
872 href="suexec.html#install">Configuring and installing suEXEC</a>
873 for further information.</p>
876 <dt><code>--with-suexec-bin</code></dt>
877 <dd>This defines the path to suexec binary. Default is
878 <code>--sbindir</code> (see <a href="directoryfinetuning">Fine
879 tuning of installation directories</a>).</dd>
881 <dt><code>--with-suexec-caller</code></dt>
882 <dd>This defines the user allowed to call <program>suexec</program>.
883 It should be the same as the user under which <program>httpd</program>
886 <dt><code>--with-suexec-docroot</code></dt>
887 <dd>This defines the directory tree under which <program>
888 suexec</program> access is allowed for executables. Default value is
889 <code>--datadir/htdocs</code>.</dd>
891 <dt><code>--with-suexec-gidmin</code></dt>
892 <dd>Define this as the lowest GID allowed to be a target user for
893 <program>suexec</program>. The default value is 100.</dd>
895 <dt><code>--with-suexec-logfile</code></dt>
896 <dd>This defines the filename of the <program>suexec</program> logfile.
897 By default the logfile is named <code>suexec_log</code> and located in
898 <code>--logfiledir</code>.</dd>
900 <dt><code>--with-suexec-safepath</code></dt>
901 <dd>Define the value of the environment variable <code>PATH</code> to
902 be set for processes started by <program>suexec</program>. Default
903 value is <code>/usr/local/bin:/usr/bin:/bin</code>.</dd>
905 <dt><code>--with-suexec-userdir</code></dt>
906 <dd>This defines the subdirectory under the user's directory that
907 contains all executables for which <program>suexec</program> access
908 is allowed. This setting is necessary when you want to use
909 <program>suexec</program> together with user-specific directories (as
910 provided by <module>mod_userdir</module>). The default is
911 <code>public_html</code>.</dd>
913 <dt><code>--with-suexec-uidmin</code></dt>
914 <dd>Define this as the lowest UID allowed to be a target user for
915 <program>suexec</program>. The default value is 100.</dd>
917 <dt><code>--with-suexec-umask</code></dt>
918 <dd>Set <code>umask</code> for processes started by
919 <program>suexec</program>. It defaults to your system settings.</dd>
925 <section id="env"><title>Environment variables</title>
926 <p>There are some useful environment variables to override the choices made by
927 <code>configure</code> or to help it to find libraries and programs with
928 nonstandard names or locations.</p>
930 <!-- are these all useful variables? -->
932 <dt><code>CC</code></dt>
933 <dd>Define the C compiler command to be used for compilation.</dd>
935 <dt><code>CFLAGS</code></dt>
936 <dd>Set C compiler flags you want to use for compilation.</dd>
938 <dt><code>CPP</code></dt>
939 <dd>Define the C preprocessor command to be used.</dd>
941 <dt><code>CPPFLAGS</code></dt>
942 <dd>Set C/C++ preprocessor flags, e.g. <code>-I<var>includedir</var></code>
943 if you have headers in a nonstandard directory <var>includedir</var>.</dd>
945 <dt><code>LDFLAGS</code></dt>
946 <dd>Set linker flags, e.g. <code>-L<var>libdir</var></code> if you have
947 libraries in a nonstandard directory <var>libdir</var>.</dd>