Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
apache-httpd/docs/manual/programs/configure.xml
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
1005 lines (830 sloc)
44.8 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?xml version='1.0' encoding='UTF-8' ?> | |
<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd"> | |
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?> | |
<!-- $LastChangedRevision$ --> | |
<!-- | |
Licensed to the Apache Software Foundation (ASF) under one or more | |
contributor license agreements. See the NOTICE file distributed with | |
this work for additional information regarding copyright ownership. | |
The ASF licenses this file to You under the Apache License, Version 2.0 | |
(the "License"); you may not use this file except in compliance with | |
the License. You may obtain a copy of the License at | |
http://www.apache.org/licenses/LICENSE-2.0 | |
Unless required by applicable law or agreed to in writing, software | |
distributed under the License is distributed on an "AS IS" BASIS, | |
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
See the License for the specific language governing permissions and | |
limitations under the License. | |
--> | |
<manualpage metafile="configure.xml.meta"> | |
<parentdocument href="./">Programs</parentdocument> | |
<title>configure - Configure the source tree</title> | |
<summary> | |
<p>The <code>configure</code> script configures the source tree | |
for compiling and installing the Apache HTTP Server on your | |
particular platform. Various options allow the compilation of a | |
server corresponding to your personal requirements.</p> | |
<p>This script, included in the root directory of the source | |
distribution, is for compilation on Unix and Unix-like systems | |
only. For other platforms, see the <a | |
href="../platform/">platform</a> documentation.</p> | |
</summary> | |
<seealso><a href="../install.html">Compiling and Installing</a></seealso> | |
<section id="synopsis"><title>Synopsis</title> | |
<p>You should call the <code>configure</code> script from within the | |
root directory of the distribution.</p> | |
<p><code><strong>./configure</strong> [<var>OPTION</var>]... | |
[<var>VAR</var>=<var>VALUE</var>]...</code></p> | |
<p>To assign environment variables (e.g. <code>CC</code>, | |
<code>CFLAGS</code> ...), specify them as | |
<code><var>VAR</var>=<var>VALUE</var></code>. See <a href="#env">below</a> | |
for descriptions of some of the useful variables.</p> | |
</section> | |
<section id="options"><title>Options</title> | |
<ul> | |
<li><a href="#configurationoptions">Configuration options</a></li> | |
<li><a href="#installationdirectories">Installation directories</a></li> | |
<li><a href="#systemtypes">System types</a></li> | |
<li><a href="#optionalfeatures">Optional features</a></li> | |
<li><a href="#supportopt">Options for support programs</a></li> | |
</ul> | |
<section id="configurationoptions"><title>Configuration options</title> | |
<p>The following options influence the behavior of | |
<code>configure</code> itself.</p> | |
<dl> | |
<dt><code>-C</code></dt> | |
<dt><code>--config-cache</code></dt> | |
<dd>This is an alias for <code>--cache-file=config.cache</code></dd> | |
<dt><code>--cache-file=<var>FILE</var></code></dt> | |
<dd>The test results will be cached in file <var>FILE</var>. | |
This option is disabled by default.</dd> | |
<dt><code>-h</code></dt> | |
<dt><code>--help [short|recursive]</code></dt> | |
<dd>Output the help and exit. With the argument <code>short</code> only | |
options specific to this package will displayed. The argument | |
<code>recursive</code> displays the short help of all the included | |
packages.</dd> | |
<dt><code>-n</code></dt> | |
<dt><code>--no-create</code></dt> | |
<dd>The <code>configure</code> script is run normally but does | |
not create output files. This is useful to check the test results | |
before generating makefiles for compilation.</dd> | |
<dt><code>-q</code></dt> | |
<dt><code>--quiet</code></dt> | |
<dd>Do not print <code>checking ...</code> messages during the | |
configure process.</dd> | |
<dt><code>--srcdir=<var>DIR</var></code></dt> | |
<dd>Defines directory <var>DIR</var> to be the source file directory. | |
Default is the directory where <code>configure</code> is located, or | |
the parent directory.</dd> | |
<dt><code>--silent</code></dt> | |
<dd>Same as <code>--quiet</code></dd> | |
<dt>-V</dt> | |
<dt>--version</dt> | |
<dd>Display copyright information and exit.</dd> | |
</dl> | |
</section> | |
<section id="installationdirectories"><title>Installation | |
directories</title> | |
<p>These options define the installation directory. The installation | |
tree depends on the selected layout.</p> | |
<dl> | |
<dt><code>--prefix=<var>PREFIX</var></code></dt> | |
<dd>Install architecture-independent files in <var>PREFIX</var>. | |
By default the installation directory is set to | |
<code>/usr/local/apache2</code>.</dd> | |
<dt><code>--exec-prefix=<var>EPREFIX</var></code></dt> | |
<dd>Install architecture-dependent files in <var>EPREFIX</var>. | |
By default the installation directory is set to the | |
<var>PREFIX</var> directory.</dd> | |
</dl> | |
<p>By default, <code>make install</code> will install all the files in | |
<code>/usr/local/apache2/bin</code>, <code>/usr/local/apache2/lib</code> | |
etc. You can specify an installation prefix other than | |
<code>/usr/local/apache2</code> using <code>--prefix</code>, | |
for instance <code>--prefix=$HOME</code>.</p> | |
<section id="layout"><title>Define a directory layout</title> | |
<dl> | |
<dt><code>--enable-layout=<var>LAYOUT</var></code></dt> | |
<dd>Configure the source code and build scripts to assume an | |
installation tree based on the layout <var>LAYOUT</var>. This allows | |
you to separately specify the locations for each type of file within | |
the Apache HTTP Server installation. The <code>config.layout</code> | |
file contains several example configurations, and you can also create | |
your own custom configuration following the examples. The different | |
layouts in this file are grouped into <code><Layout | |
FOO>...</Layout></code> sections and referred to by name as | |
in <code>FOO</code>. The default layout is <code>Apache</code>.</dd> | |
</dl> | |
</section> | |
<section id="directoryfinetuning"><title>Fine tuning of the installation | |
directories</title> | |
<p>For better control of the installation directories, use the options | |
below. Please note that the directory defaults are set by | |
<code>autoconf</code> and are overwritten by the corresponding layout | |
setting.</p> | |
<dl> | |
<!-- only apr-config and apu-config are installed at bindir. | |
everything else is stored at sbindir. ==> clarify/change this --> | |
<dt><code>--bindir=<var>DIR</var></code></dt> | |
<dd>Install user executables in <var>DIR</var>. The user executables | |
are supporting programs like <program>htpasswd</program>, | |
<program>dbmmanage</program>, etc. which are useful for site | |
administrators. By default <var>DIR</var> is set to | |
<code><var>EPREFIX</var>/bin</code>.</dd> | |
<dt><code>--datadir=<var>DIR</var></code></dt> | |
<dd>Install read-only architecture-independent data in <var>DIR</var>. | |
By default <code>datadir</code> is set to | |
<code><var>PREFIX</var>/share</code>. This option is offered by | |
<code>autoconf</code> and currently unused.</dd> | |
<dt><code>--includedir=<var>DIR</var></code></dt> | |
<dd>Install C header files in <var>DIR</var>. By default | |
<code>includedir</code> is set to | |
<code><var>EPREFIX</var>/include</code>.</dd> | |
<dt><code>--infodir=<var>DIR</var></code></dt> | |
<dd>Install info documentation in <var>DIR</var>. | |
By default <code>infodir</code> is set to | |
<code><var>PREFIX</var>/info</code>. This option is currently | |
unused.</dd> | |
<dt><code>--libdir=<var>DIR</var></code></dt> | |
<dd>Install object code libraries in <var>DIR</var>. By default | |
<code>libdir</code> is set to | |
<code><var>EPREFIX</var>/lib</code>.</dd> | |
<dt><code>--libexecdir=<var>DIR</var></code></dt> | |
<dd>Install the program executables (i.e., shared modules) in | |
<var>DIR</var>. By default <code>libexecdir</code> is set to | |
<code><var>EPREFIX</var>/libexec</code>.</dd> | |
<dt><code>--localstatedir=<var>DIR</var></code></dt> | |
<dd>Install modifiable single-machine data in <var>DIR</var>. | |
By default <code>localstatedir</code> is set to | |
<code><var>PREFIX</var>/var</code>. This option is offered by | |
<code>autoconf</code> and currently unused.</dd> | |
<dt><code>--mandir=<var>DIR</var></code></dt> | |
<dd>Install the man documentation in <var>DIR</var>. By default | |
<code>mandir</code> is set to | |
<code><var>EPREFIX</var>/man</code>.</dd> | |
<dt><code>--oldincludedir=<var>DIR</var></code></dt> | |
<dd>Install C header files for non-gcc in <var>DIR</var>. | |
By default <code>oldincludedir</code> is set to | |
<code>/usr/include</code>. This option is offered by | |
<code>autoconf</code> and currently unused.</dd> | |
<dt><code>--sbindir=<var>DIR</var></code></dt> | |
<dd>Install the system administrator executables in <var>DIR</var>. | |
Those are server programs like <program>httpd</program>, | |
<program>apachectl</program>, <program>suexec</program>, etc. which | |
are necessary to run the Apache HTTP Server. By default | |
<code>sbindir</code> is set to | |
<code><var>EPREFIX</var>/sbin</code>.</dd> | |
<dt><code>--sharedstatedir=<var>DIR</var></code></dt> | |
<dd>Install modifiable architecture-independent data in <var>DIR</var>. | |
By default <code>sharedstatedir</code> is set to | |
<code><var>PREFIX</var>/com</code>. This option is offered by | |
<code>autoconf</code> and currently unused.</dd> | |
<dt><code>--sysconfdir=<var>DIR</var></code></dt> | |
<dd>Install read-only single-machine data like the server configuration | |
files <code>httpd.conf</code>, <code>mime.types</code>, etc. in | |
<var>DIR</var>. By default <code>sysconfdir</code> is set to | |
<code><var>PREFIX</var>/conf</code>.</dd> | |
</dl> | |
</section> | |
</section> | |
<section id="systemtypes"><title>System types</title> | |
<p>These options are used to cross-compile the Apache HTTP Server to run on | |
another system. In normal cases, when building and running the server on | |
the same system, these options are not used.</p> | |
<dl> | |
<dt><code>--build=<var>BUILD</var></code></dt> | |
<dd>Defines the system type of the system on which the tools are being | |
built. It defaults to the result of the script | |
<code>config.guess</code>.</dd> | |
<dt><code>--host=<var>HOST</var></code></dt> | |
<dd>Defines the system type of the system on which the server will run. | |
<var>HOST</var> defaults to <var>BUILD</var>.</dd> | |
<dt><code>--target=<var>TARGET</var></code></dt> | |
<dd>Configure for building compilers for the system type | |
<var>TARGET</var>. It defaults to <var>HOST</var>. This option is | |
offered by <code>autoconf</code> and not necessary for the Apache HTTP | |
Server.</dd> | |
</dl> | |
</section> | |
<section id="optionalfeatures"><title>Optional Features</title> | |
<p>These options are used to fine tune the features your HTTP server will | |
have.</p> | |
<section id="generaloptfeat"><title>General syntax</title> | |
<p>Generally you can use the following syntax to enable or disable a | |
feature:</p> | |
<dl> | |
<dt><code>--disable-<var>FEATURE</var></code></dt> | |
<dd>Do not include <var>FEATURE</var>. This is the same as | |
<code>--enable-<var>FEATURE</var>=no</code>.</dd> | |
<dt><code>--enable-<var>FEATURE</var>[=<var>ARG</var>]</code></dt> | |
<dd>Include <var>FEATURE</var>. The default value for <var>ARG</var> | |
is <code>yes</code>.</dd> | |
<dt><code>--enable-<var>MODULE</var>=shared</code></dt> | |
<dd>The corresponding module will be build as DSO module. | |
By default enabled modules are linked dynamically.</dd> | |
<dt><code>--enable-<var>MODULE</var>=static</code></dt> | |
<dd>The corresponding module will be linked statically.</dd> | |
</dl> | |
<note><title>Note</title> | |
<code>configure</code> will not complain about | |
<code>--enable-<var>foo</var></code> even if <var>foo</var> doesn't | |
exist, so you need to type carefully. | |
</note> | |
</section> | |
<!-- to do: add better enable-module descriptions and recommendations --> | |
<section id="enabledmodules"><title>Modules enabled by default</title> | |
<p>Some modules are compiled by default and have to be disabled | |
explicitly or by using the keywords <code>few</code> or | |
<code>none</code> (see <code>--enable-modules</code>, | |
<code>--enable-mods-shared</code> and <code>--enable-mods-static</code> | |
below for further explanation) to be removed. The following options remove | |
individual modules from the compilation process.</p> | |
<dl> | |
<dt><code>--disable-actions</code></dt> | |
<dd>Disable action triggering on requests, which is provided by | |
<module>mod_actions</module>.</dd> | |
<dt><code>--disable-alias</code></dt> | |
<dd>Disable the mapping of requests to different parts of the | |
filesystem, which is provided by <module>mod_alias</module>.</dd> | |
<dt><code>--disable-asis</code></dt> | |
<dd>Disable support for as-is filetypes, which is provided by | |
<module>mod_asis</module>.</dd> | |
<dt><code>--disable-auth</code></dt> | |
<dd>Disable user-based access control provided by | |
<module>mod_authn_file</module>. This module provides for HTTP Basic | |
Authentication, where the usernames and passwords are stored in | |
plain text files.</dd> | |
<dt><code>--disable-autoindex</code></dt> | |
<dd>Disable the directory listing functionality provided by | |
<module>mod_autoindex</module>.</dd> | |
<dt><code>--disable-access</code></dt> | |
<dd>Disable host-based access control provided by | |
<module>mod_authz_host</module>.</dd> | |
<dt><code>--disable-cgi</code></dt> | |
<dd><module>mod_cgi</module>, which provides support for CGI scripts, | |
is enabled by default when using a non-threaded MPM. Use this | |
option to disable CGI support.</dd> | |
<dt><code>--disable-cgid</code></dt> | |
<dd>When using the threaded MPM <module>worker</module>, | |
support for CGI scripts is provided by <module>mod_cgid</module> | |
by default. To disable CGI support use this option.</dd> | |
<dt><code>--disable-charset-lite</code></dt> | |
<dd>Disable character set translation provided by | |
<module>mod_charset_lite</module>. This module will be installed by | |
default only on EBCDIC systems.</dd> | |
<dt><code>--disable-dir</code></dt> | |
<dd>Disable directory request handling provided by | |
<module>mod_dir</module>.</dd> | |
<dt><code>--disable-env</code></dt> | |
<dd>Disable setting and clearing of environment variables, which is | |
provided by <module>mod_env</module>.</dd> | |
<!-- configure mentions enable-http, but disable-http would make much | |
more sense --> | |
<dt><code>--disable-http</code></dt> | |
<dd>Disable the HTTP protocol handling. The <code>http</code> | |
module is a basic one, enabling the server to function as an | |
HTTP server. It is only useful to disable it if you want to use | |
another protocol module instead. <strong>Don't disable this | |
module unless you are really sure what you are doing.</strong> | |
<br/> | |
Note: This module will always be linked statically.</dd> | |
<dt><code>--disable-imagemap</code></dt> | |
<dd>Disable support for server based imagemaps, which provided by | |
<module>mod_imagemap</module>.</dd> | |
<dt><code>--disable-include</code></dt> | |
<dd>Disable Server Side Includes provided by | |
<module>mod_include</module>.</dd> | |
<dt><code>--disable-log-config</code></dt> | |
<dd>Disable the logging configuration provided by | |
<module>mod_log_config</module>. You won't be able to log requests | |
to the server without this module.</dd> | |
<dt><code>--disable-mime</code></dt> | |
<dd><module>mod_mime</module> associates the requested | |
filename's extensions with the file's behavior and content | |
(<glossary>mime-type</glossary>, language, character set and | |
encoding). Disabling this module is normally not recommended.</dd> | |
<dt><code>--disable-negotiation</code></dt> | |
<dd>Disable content negotiation provided by | |
<module>mod_negotiation</module>.</dd> | |
<dt><code>--disable-setenvif</code></dt> | |
<dd>Disable support for basing environment variables on headers, | |
which is provided by <module>mod_setenvif</module>.</dd> | |
<dt><code>--disable-status</code></dt> | |
<dd>Disable the process/thread monitoring, which is provided by | |
<module>mod_status</module>.</dd> | |
<dt><code>--disable-userdir</code></dt> | |
<dd>Disable the mapping of requests to user-specific directories, | |
which is provided by <module>mod_userdir</module>.</dd> | |
</dl> | |
</section> | |
<section id="disabledmodules"><title>Modules, disabled by default</title> | |
<p>Some modules are not compiled by default and have to be enabled | |
explicitly or by using the keywords <code>most</code> or | |
<code>all</code> (see <code>--enable-modules</code>, | |
<code>--enable-mods-shared</code> and <code>--enable-mods-static</code> | |
below for further explanation) to be available. The following options | |
add individual modules to the compilation process.</p> | |
<dl> | |
<dt><code>--enable-authn-anon</code></dt> | |
<dd>Enable anonymous user access provided by | |
<module>mod_authn_anon</module>.</dd> | |
<dt><code>--enable-authn-dbm</code></dt> | |
<dd><module>mod_authn_dbm</module> provides for HTTP Basic | |
Authentication, where the usernames and passwords are stored in DBM | |
type database files. Use this option to enable the module.</dd> | |
<dt><code>--enable-authz-dbm</code></dt> | |
<dd><module>mod_authz_dbm</module> provides for HTTP Basic | |
Authorization, where the usernames and groups are stored in DBM | |
type database files. Use this option to enable the module.</dd> | |
<dt><code>--enable-auth-digest</code></dt> | |
<dd>Enable RFC2617 Digest authentication provided by | |
<module>mod_auth_digest</module>. This module uses plain text files | |
to store the credentials.</dd> | |
<dt><code>--enable-authnz-ldap</code></dt> | |
<dd>Enable LDAP based authentication provided by | |
<module>mod_authnz_ldap</module>.</dd> | |
<dt><code>--enable-cache</code></dt> | |
<dd>Enable dynamic file caching provided by | |
<module>mod_cache</module>. This experimental module may be | |
interesting for servers with high load or caching proxy servers. At | |
least one storage management module (e.g. | |
<module>mod_disk_cache</module>) is also necessary.</dd> | |
<dt><code>--enable-cern-meta</code></dt> | |
<dd>Enable the CERN-type meta files support provided by | |
<module>mod_cern_meta</module>.</dd> | |
<dt><code>--enable-charset-lite</code></dt> | |
<dd>Enable character set translation provided by | |
<module>mod_charset_lite</module>. This module will be installed by | |
default only on EBCDIC systems. On other systems, you have to enable | |
it.</dd> | |
<dt><code>--enable-dav</code></dt> | |
<dd>Enable the WebDAV protocol handling provided by | |
<module>mod_dav</module>. Support for filesystem resources is | |
provided by the separate module <module>mod_dav_fs</module>. This | |
module is also automatically enabled with | |
<code>--enable-dav</code>.<br/> | |
Note: <module>mod_dav</module> can only be used together with the | |
<code>http</code> protocol module.</dd> | |
<dt><code>--enable-dav-fs</code></dt> | |
<dd>Enable DAV support for filesystem resources, which is provided by | |
<module>mod_dav_fs</module>. This module is a provider for the | |
<module>mod_dav</module> module, so you should also use | |
<code>--enable-dav</code>.</dd> | |
<dt><code>--enable-dav-lock</code></dt> | |
<dd>Enable <module>mod_dav_lock</module> which provides generic DAV | |
locking support for backend modules. This module needs at least | |
<module>mod_dav</module> to function, so you should also use | |
<code>--enable-dav</code>.</dd> | |
<dt><code>--enable-deflate</code></dt> | |
<dd>Enable deflate transfer encoding provided by | |
<module>mod_deflate</module>.</dd> | |
<dt><code>--enable-disk-cache</code></dt> | |
<dd>Enable disk caching provided by | |
<module>mod_disk_cache</module>.</dd> | |
<dt><code>--enable-expires</code></dt> | |
<dd>Enable <code>Expires</code> header control provided by | |
<module>mod_expires</module>.</dd> | |
<dt><code>--enable-ext-filter</code></dt> | |
<dd>Enable the external filter support provided by | |
<module>mod_ext_filter</module>.</dd> | |
<dt><code>--enable-file-cache</code></dt> | |
<dd>Enable the file cache provided by | |
<module>mod_file_cache</module>.</dd> | |
<dt><code>--enable-headers</code></dt> | |
<dd>Enable control of HTTP headers provided by | |
<module>mod_headers</module>.</dd> | |
<dt><code>--enable-info</code></dt> | |
<dd>Enable the server information provided by | |
<module>mod_info</module>.</dd> | |
<dt><code>--enable-ldap</code></dt> | |
<dd>Enable LDAP caching and connection pooling services provided by | |
<module>mod_ldap</module>.</dd> | |
<dt><code>--enable-logio</code></dt> | |
<dd>Enable logging of input and output bytes including headers provided | |
by <module>mod_logio</module>.</dd> | |
<dt><code>--enable-mime-magic</code></dt> | |
<dd>Enable | |
automatical determining of <glossary ref="mime-type">MIME | |
types</glossary>, which is provided by | |
<module>mod_mime_magic</module>.</dd> | |
<dt><code>--enable-isapi</code></dt> | |
<dd>Enable the isapi extension support provided by | |
<module>mod_isapi</module>.</dd> | |
<dt><code>--enable-proxy</code></dt> | |
<dd>Enable the proxy/gateway functionality provided by | |
<module>mod_proxy</module>. The proxying capabilities for | |
<code>AJP13</code>, <code>CONNECT</code>, <code>FTP</code>, | |
<code>HTTP</code> and the balancer are provided by the separate | |
modules <module>mod_proxy_ajp</module>, | |
<module>mod_proxy_connect</module>, <module>mod_proxy_ftp</module>, | |
<module>mod_proxy_http</module> and | |
<module>mod_proxy_balancer</module>. | |
These five modules are also automatically enabled with | |
<code>--enable-proxy</code>.</dd> | |
<dt><code>--enable-proxy-ajp</code></dt> | |
<dd>Enable proxy support for <code>AJP13 (Apache JServ Protocol 1.3)</code> | |
request handling, which is provided by <module>mod_proxy_ajp</module>. | |
This module is an extension for the <module>mod_proxy</module> module, | |
so you should also use <code>--enable-proxy</code>.</dd> | |
<dt><code>--enable-proxy-balancer</code></dt> | |
<dd>Enable load balancing support for the <code>AJP13</code>, | |
<code>FTP</code> and <code>HTTP</code> protocols, which is provided by | |
<module>mod_proxy_balancer</module>. This module is an extension for the | |
<module>mod_proxy</module> module, so you should also use | |
<code>--enable-proxy</code>.</dd> | |
<dt><code>--enable-proxy-connect</code></dt> | |
<dd>Enable proxy support for <code>CONNECT</code> request handling, | |
which is provided by <module>mod_proxy_connect</module>. This module | |
is an extension for the <module>mod_proxy</module> module, so you | |
should also use <code>--enable-proxy</code>.</dd> | |
<dt><code>--enable-proxy-ftp</code></dt> | |
<dd>Enable proxy support for <code>FTP</code> requests, which is | |
provided by <module>mod_proxy_ftp</module>. This module | |
is an extension for the <module>mod_proxy</module> module, so you | |
should also use <code>--enable-proxy</code>.</dd> | |
<dt><code>--enable-proxy-http</code></dt> | |
<dd>Enable proxy support for <code>HTTP</code> requests, which is | |
provided by <module>mod_proxy_http</module>. This module | |
is an extension for the <module>mod_proxy</module> module, so you | |
should also use <code>--enable-proxy</code>.</dd> | |
<dt><code>--enable-rewrite</code></dt> | |
<dd>Enable rule based URL manipulation provided by | |
<module>mod_rewrite</module>.</dd> | |
<dt><code>--enable-so</code></dt> | |
<dd>Enable DSO capability provided by <module>mod_so</module>. This | |
module will be automatically enabled unless you build | |
all modules statically.</dd> | |
<dt><code>--enable-speling</code></dt> | |
<dd>Enable the functionality to correct common URL misspellings, which | |
is provided by <module>mod_speling</module>.</dd> | |
<dt><code>--enable-ssl</code></dt> | |
<dd>Enable support for SSL/TLS provided by | |
<module>mod_ssl</module>.</dd> | |
<dt><code>--enable-unique-id</code></dt> | |
<dd>Enable the generation of per-request unique ids, which is provided | |
by <module>mod_unique_id</module>.</dd> | |
<dt><code>--enable-usertrack</code></dt> | |
<dd>Enable user-session tracking provided by | |
<module>mod_usertrack</module>.</dd> | |
<dt><code>--enable-vhost-alias</code></dt> | |
<dd>Enable mass virtual hosting provided by | |
<module>mod_vhost_alias</module>.</dd> | |
</dl> | |
</section> | |
<section id="developermodules"><title>Modules for developers</title> | |
<p>The following modules are useful only for developers and testing | |
purposes and are disabled by default. Use the following options to | |
enable them. If you are not sure whether you need one of these | |
modules, omit them.</p> | |
<dl> | |
<!-- module doc needed --> | |
<dt><code>--enable-bucketeer</code></dt> | |
<dd>Enable the manipulation filter for buckets, which is provided by | |
<code>mod_bucketeer</code>.</dd> | |
<!-- module doc needed --> | |
<dt><code>--enable-case-filter</code></dt> | |
<dd>Enable the example uppercase conversion output filter support of | |
<code>mod_case_filter</code>.</dd> | |
<!-- module doc needed --> | |
<dt><code>--enable-case-filter-in</code></dt> | |
<dd>Enable the example uppercase conversion input filter support of | |
<code>mod_case_filter_in</code>.</dd> | |
<dt><code>--enable-echo</code></dt> | |
<dd>Enable the ECHO server provided by | |
<module>mod_echo</module>.</dd> | |
<dt><code>--enable-example</code></dt> | |
<dd>Enable the example and demo module | |
<module>mod_example</module>.</dd> | |
<!-- module doc needed --> | |
<dt><code>--enable-optional-fn-export</code></dt> | |
<dd>Enable the example for an optional function exporter, which is | |
provided by <code>mod_optional_fn_export</code>.</dd> | |
<!-- module doc needed --> | |
<dt><code>--enable-optional-fn-import</code></dt> | |
<dd>Enable the example for an optional function importer, which is | |
provided by <code>mod_optional_fn_import</code>.</dd> | |
<!-- module doc needed --> | |
<dt><code>--enable-optional-hook-export</code></dt> | |
<dd>Enable the example for an optional hook exporter, which is provided | |
by <code>mod_optional_hook_export</code>.</dd> | |
<!-- module doc needed --> | |
<dt><code>--enable-optional-hook-import</code></dt> | |
<dd>Enable the example optional hook importer, which is provided by | |
<code>mod_optional_hook_import</code>.</dd> | |
</dl> | |
</section> | |
<section id="mpms"><title>Multi-Processing Modules</title> | |
<p><a href="../mpm.html">Multi-Processing Modules</a>, or MPMs, implement | |
the basic behavior of the server. A single MPM must be active in order | |
for the server to function. The list of available MPMs appears on the | |
<a href="../mod/">module index page</a>.</p> | |
<p>MPMs can be built as DSOs for dynamic loading or statically linked with | |
the server, and are enabled using the following options:</p> | |
<dl> | |
<dt><code>--with-mpm=MPM</code></dt> | |
<dd> | |
<p>Choose the default MPM for your server. If MPMs are built as DSO | |
modules (see <code>--enable-mpms-shared</code>), this directive | |
selects the MPM which will be loaded in the default configuration | |
file. Otherwise, this directive selects the only available MPM, | |
which will be statically linked into the server.</p> | |
<p>If this option is omitted, the <a href="../mpm.html#defaults">default | |
MPM</a> for your operating system will be used.</p> | |
</dd> | |
<dt><code>--enable-mpms-shared=<var>MPM-LIST</var></code></dt> | |
<dd> | |
<p>Enable a list of MPMs as dynamic shared modules. One of these | |
modules must be loaded dynamically using the | |
<directive module="mod_so">LoadModule</directive> directive.</p> | |
<p><var>MPM-LIST</var> is a space-separated list of MPM names | |
enclosed by quotation marks. For example:</p> | |
<example> | |
--enable-mpms-shared='prefork worker' | |
</example> | |
<p>Additionally you can use the special keyword <code>all</code>, | |
which will select all MPMs which support dynamic loading on the | |
current platform and build them as DSO modules. For example:</p> | |
<example> | |
--enable-mpms-shared=all | |
</example> | |
</dd> | |
</dl> | |
</section> | |
<section id="modules"><title>Third-party modules</title> | |
<p>To add additional third-party modules use the following options:</p> | |
<dl> | |
<dt><code>--with-module=<var>module-type</var>:<var>module-file</var>[, | |
<var>module-type</var>:<var>module-file</var>]</code></dt> | |
<dd><p>Add one or more third-party modules to the list of statically linked | |
modules. The module source file <code><var>module-file</var></code> | |
will be searched in the <code>modules/<var>module-type</var></code> | |
subdirectory of your Apache HTTP server source tree. If it is not found | |
there <code>configure</code> is considering <var>module-file</var> to be | |
an absolute file path and tries to copy the source file into the | |
<var>module-type</var> subdirectory. If the subdirectory doesn't | |
exist it will be created and populated with a standard | |
<code>Makefile.in</code>.</p> | |
<p>This option is useful to add small external modules consisting of | |
one source file. For more complex modules you should read the | |
vendor's documentation.</p> | |
<note><title>Note</title> | |
If you want to build a DSO module instead of a statically linked | |
use <program>apxs</program>.</note> | |
</dd> | |
</dl> | |
</section> | |
<section id="otheroptfeat"><title>Cumulative and other options</title> | |
<dl> | |
<dt><code>--enable-maintainer-mode</code></dt> | |
<dd>Turn on debugging and compile time warnings.</dd> | |
<dt><code>--enable-mods-shared=<var>MODULE-LIST</var></code></dt> | |
<dd> | |
<p>Defines a list of modules to be enabled and build as dynamic | |
shared modules. This mean, these module have to be loaded | |
dynamically by using the <directive | |
module="mod_so">LoadModule</directive> directive.</p> | |
<p><var>MODULE-LIST</var> is a space separated list of modulenames | |
enclosed by quotation marks. The module names are given without the | |
preceding <code>mod_</code>. For example:</p> | |
<example> | |
--enable-mods-shared='headers rewrite dav' | |
</example> | |
<p>Additionally you can use the special keywords <code>all</code>, | |
<code>most</code> and <code>few</code>. For example,</p> | |
<example> | |
--enable-mods-shared=most | |
</example> | |
<p>will compile most modules and build them as DSO modules,</p> | |
<example> | |
--enable-mods-shared=few | |
</example> | |
<p>will only compile a very basic set of modules.</p> | |
<p>The default set is <code>most</code>.</p> | |
<!-- See <a href="../install/enabledmodules.html">Overview of | |
enabled modules</a> for further information. --> | |
<p><strong>Caveat:</strong> | |
<code>--enable-mods-shared=all</code> does not actually build all | |
modules. To build all modules then, one might use:</p> | |
<example> | |
./configure \<br /> | |
<indent> | |
--with-ldap \<br /> | |
--enable-mods-shared="all ssl ldap cache proxy authn_alias file_cache authnz_ldap charset_lite dav_lock disk_cache" | |
</indent> | |
</example> | |
</dd> | |
<dt><code>--enable-mods-static=<var>MODULE-LIST</var></code></dt> | |
<dd>This option behaves similar to <code>--enable-mods-shared</code>, | |
but will link the given modules statically. This mean, these modules | |
will always be present while running <program>httpd</program>. They need | |
not be loaded with <directive | |
module="mod_so">LoadModule</directive>.</dd> | |
<dt><code>--enable-modules=<var>MODULE-LIST</var></code></dt> | |
<dd>This option behaves like to <code>--enable-mods-shared</code>, | |
and will also link the given modules dynamically. The special | |
keyword <code>none</code> disables the build of all modules.</dd> | |
<dt><code>--enable-v4-mapped</code></dt> | |
<dd>Allow IPv6 sockets to handle IPv4 connections.</dd> | |
<dt><code>--with-port=<var>PORT</var></code></dt> | |
<dd>This defines the port on which <program>httpd</program> will listen. | |
This port number is used when generating the configuration file | |
<code>httpd.conf</code>. The default is 80.</dd> | |
<dt><code>--with-program-name</code></dt> | |
<dd>Define an alternative executable name. The default is | |
<code>httpd</code>.</dd> | |
</dl> | |
</section> | |
</section> | |
<section id="packages"><title>Optional packages</title> | |
<p>These options are used to define optional packages.</p> | |
<section id="generalpackages"><title>General syntax</title> | |
<p>Generally you can use the following syntax to define an optional | |
package:</p> | |
<dl> | |
<dt><code>--with-<var>PACKAGE</var>[=<var>ARG</var>]</code></dt> | |
<dd>Use the package <var>PACKAGE</var>. The default value for | |
<var>ARG</var> is <code>yes</code>.</dd> | |
<dt><code>--without-<var>PACKAGE</var></code></dt> | |
<dd>Do not use the package <var>PACKAGE</var>. This is the same as | |
<code>--with-<var>PACKAGE</var>=no</code>. This option is provided by | |
<code>autoconf</code> but not very useful for the Apache HTTP | |
Server.</dd> | |
</dl> | |
</section> | |
<!-- options not known are passed to packages? | |
are there other important options for packages? --> | |
<section id="packageopt"><title>Specific packages</title> | |
<dl> | |
<dt><code>--with-apr=<var>DIR</var>|<var>FILE</var></code></dt> | |
<dd>The <glossary ref="apr">Apache Portable Runtime</glossary> (APR) | |
is part of the httpd | |
source distribution and will automatically be build together with the | |
HTTP server. If you want to use an already installed APR instead you | |
have to tell <code>configure</code> the path to the | |
<code>apr-config</code> script. You may set the absolute path and name | |
or the directory to the installed APR. <code>apr-config</code> must | |
exist within this directory or the subdirectory | |
<code>bin</code>.</dd> | |
<dt><code>--with-apr-util=<var>DIR</var>|<var>FILE</var></code></dt> | |
<dd>The Apache Portable Runtime Utilities (APU) are part of the | |
httpd source distribution and will automatically be build | |
together with the HTTP server. If you want to use an already installed | |
APU instead you have to tell <code>configure</code> the path to the | |
<code>apu-config</code> script. You may set the absolute path and name | |
or the directory to the installed APU. <code>apu-config</code> must | |
exist within this directory or the subdirectory | |
<code>bin</code>.</dd> | |
<dt><code>--with-ssl=<var>DIR</var></code></dt> | |
<dd>If <module>mod_ssl</module> has been enabled <code>configure</code> | |
searches for an installed OpenSSL. You can set the directory path | |
to the SSL/TLS toolkit instead.</dd> | |
<dt><code>--with-z=<var>DIR</var></code></dt> | |
<dd><code>configure</code> searches automatically for an installed | |
<code>zlib</code> library if your source configuration requires one | |
(e.g., when <module>mod_deflate</module> is enabled). You can set the | |
directory path to the compression library instead.</dd> | |
</dl> | |
<p>Several features of the Apache HTTP Server, including | |
<module>mod_authn_dbm</module> and <module>mod_rewrite</module>'s DBM | |
<directive module="mod_rewrite">RewriteMap</directive> use simple | |
key/value databases for quick lookups of information. SDBM is included | |
in the APU, so this database is always available. If you would like to | |
use other database types, use the following options to enable | |
them:</p> | |
<dl> | |
<dt><code>--with-gdbm[=<var>path</var>]</code></dt> | |
<dd>If no <var>path</var> is specified, <code>configure</code> will | |
search for the include files and libraries of a GNU DBM | |
installation in the usual search paths. An explicit | |
<var>path</var> will cause <code>configure</code> to look in | |
<code><var>path</var>/lib</code> and | |
<code><var>path</var>/include</code> for the relevant files. | |
Finally, the <var>path</var> may specify specific include and | |
library paths separated by a colon.</dd> | |
<dt><code>--with-ndbm[=<var>path</var>]</code></dt> | |
<dd>Like <code>--with-gdbm</code>, but searches for a New DBM | |
installation.</dd> | |
<dt><code>--with-berkeley-db[=<var>path</var>]</code></dt> | |
<dd>Like <code>--with-gdbm</code>, but searches for a Berkeley DB | |
installation.</dd> | |
</dl> | |
<note><title>Note</title> | |
<p>The DBM options are provided by the APU and passed through to its | |
configuration script. They are useless when using an already | |
installed APU defined by <code>--with-apr-util</code>.</p> | |
<p>You may use more then one DBM implementation together with your | |
HTTP server. The appropriated DBM type will be configured within | |
the runtime configuration at each time.</p> | |
</note> | |
</section> | |
</section> | |
<section id="supportopt"><title>Options for support programs</title> | |
<dl> | |
<dt><code>--enable-static-support</code></dt> | |
<dd>Build a statically linked version of the support binaries. This | |
means, a stand-alone executable will be built with all the necessary | |
libraries integrated. Otherwise the support binaries are linked | |
dynamically by default.</dd> | |
<dt><code>--enable-suexec</code></dt> | |
<dd>Use this option to enable <program> | |
suexec</program>, which allows you to set | |
uid and gid for spawned processes. <strong>Do not use this | |
option unless you understand all the security implications of | |
running a suid binary on your server.</strong> Further options | |
to configure <program>suexec</program> are described <a | |
href="#suexec">below</a>.</dd> | |
</dl> | |
<p>It is possible to create a statically linked binary of a single | |
support program by using the following options:</p> | |
<dl> | |
<dt><code>--enable-static-ab</code></dt> | |
<dd>Build a statically linked version of <program> | |
ab</program>.</dd> | |
<!-- missing documentation for chechgid --> | |
<dt><code>--enable-static-checkgid</code></dt> | |
<dd>Build a statically linked version of <code>checkgid</code>.</dd> | |
<dt><code>--enable-static-htdbm</code></dt> | |
<dd>Build a statically linked version of <program> | |
htdbm</program>.</dd> | |
<dt><code>--enable-static-htdigest</code></dt> | |
<dd>Build a statically linked version of <program> | |
htdigest</program>.</dd> | |
<dt><code>--enable-static-htpasswd</code></dt> | |
<dd>Build a statically linked version of <program> | |
htpasswd</program>.</dd> | |
<dt><code>--enable-static-logresolve</code></dt> | |
<dd>Build a statically linked version of <program> | |
logresolve</program>.</dd> | |
<dt><code>--enable-static-rotatelogs</code></dt> | |
<dd>Build a statically linked version of <program> | |
rotatelogs</program>.</dd> | |
</dl> | |
<section id="suexec"> | |
<title><code>suexec</code> configuration options</title> | |
<p>The following options are used to fine tune the behavior of <program> | |
suexec</program>. See <a | |
href="suexec.html#install">Configuring and installing suEXEC</a> | |
for further information.</p> | |
<dl> | |
<dt><code>--with-suexec-bin</code></dt> | |
<dd>This defines the path to <program>suexec</program> binary. | |
Default is <code>--sbindir</code> (see <a href="#directoryfinetuning" | |
>Fine tuning of installation directories</a>).</dd> | |
<dt><code>--with-suexec-caller</code></dt> | |
<dd>This defines the user allowed to call <program>suexec</program>. | |
It should be the same as the user under which | |
<program>httpd</program> normally runs.</dd> | |
<dt><code>--with-suexec-docroot</code></dt> | |
<dd>This defines the directory tree under which <program> | |
suexec</program> access is allowed for executables. Default value is | |
<code>--datadir/htdocs</code>.</dd> | |
<dt><code>--with-suexec-gidmin</code></dt> | |
<dd>Define this as the lowest GID allowed to be a target user for | |
<program>suexec</program>. The default value is 100.</dd> | |
<dt><code>--with-suexec-logfile</code></dt> | |
<dd>This defines the filename of the <program>suexec</program> logfile. | |
By default the logfile is named <code>suexec_log</code> and located in | |
<code>--logfiledir</code>.</dd> | |
<dt><code>--with-suexec-safepath</code></dt> | |
<dd>Define the value of the environment variable <code>PATH</code> to | |
be set for processes started by <program>suexec</program>. Default | |
value is <code>/usr/local/bin:/usr/bin:/bin</code>.</dd> | |
<dt><code>--with-suexec-userdir</code></dt> | |
<dd>This defines the subdirectory under the user's directory that | |
contains all executables for which <program>suexec</program> access | |
is allowed. This setting is necessary when you want to use | |
<program>suexec</program> together with user-specific directories (as | |
provided by <module>mod_userdir</module>). The default is | |
<code>public_html</code>.</dd> | |
<dt><code>--with-suexec-uidmin</code></dt> | |
<dd>Define this as the lowest UID allowed to be a target user for | |
<program>suexec</program>. The default value is 100.</dd> | |
<dt><code>--with-suexec-umask</code></dt> | |
<dd>Set <code>umask</code> for processes started by | |
<program>suexec</program>. It defaults to your system settings.</dd> | |
</dl> | |
</section> | |
</section> | |
</section> | |
<section id="env"><title>Environment variables</title> | |
<p>There are some useful environment variables to override the choices made by | |
<code>configure</code> or to help it to find libraries and programs with | |
nonstandard names or locations.</p> | |
<!-- are these all useful variables? --> | |
<dl> | |
<dt><code>CC</code></dt> | |
<dd>Define the C compiler command to be used for compilation.</dd> | |
<dt><code>CFLAGS</code></dt> | |
<dd>Set C compiler flags you want to use for compilation.</dd> | |
<dt><code>CPP</code></dt> | |
<dd>Define the C preprocessor command to be used.</dd> | |
<dt><code>CPPFLAGS</code></dt> | |
<dd>Set C/C++ preprocessor flags, e.g. <code>-I<var>includedir</var></code> | |
if you have headers in a nonstandard directory <var>includedir</var>.</dd> | |
<dt><code>LDFLAGS</code></dt> | |
<dd>Set linker flags, e.g. <code>-L<var>libdir</var></code> if you have | |
libraries in a nonstandard directory <var>libdir</var>.</dd> | |
</dl> | |
</section> | |
</manualpage> |