]> git.ipfire.org Git - thirdparty/apache/httpd.git/commitdiff
Remove out-of-date details about which modules are enabled by default
authorDaniel Earl Poirier <poirier@apache.org>
Tue, 9 Nov 2010 15:40:44 +0000 (15:40 +0000)
committerDaniel Earl Poirier <poirier@apache.org>
Tue, 9 Nov 2010 15:40:44 +0000 (15:40 +0000)
from the documentation, in favor of suggesting getting the up-to-date
information by running ./configure -h.

The special cases previously documented here (such as, this module
depends on this other module, or you probably don't want this module
unless you're a developer), have had that information added to the
output of configure -h in r1029814.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1033032 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/programs/configure.xml

index f05f2f9cc1cbff9d16db85e2b64907fb1ffcf3f4..e58af4893576b68cc8bafb765dbd508aa7cf041b 100644 (file)
       </note>
     </section>
 
-    <!-- to do: add better enable-module descriptions and recommendations -->
-    <section id="enabledmodules"><title>Modules enabled by default</title>
+    <section id="choosemodules"><title>Choosing modules to compile</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>
+        below for further explanation) to be removed.</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
+        <p>Other 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>
+        <code>all</code> to be available.</p>
+
+        <p>To find out which modules are compiled by default, run
+        <code>./configure -h</code> or <code>./configure --help</code>
+        and look under <code>Optional Features</code>.  Suppose you
+        are interested in <module>mod_example1</module> and
+        <module>mod_example2</module>, and you
+        see this:</p>
+
+        <example><pre>Optional Features:
+  ...
+  --disable-example1     example module 1
+  --enable-example2      example module 2
+  ...</pre></example>
+
+        <p>Then <code>mod_example1</code> is enabled by default,
+        and you would use <code>--disable-example1</code> to not
+        compile it.  <code>mod_example2</code> is disabled by
+        default, and you would use <code>--enable-example2</code>
+        to compile it.</p>
     </section>
 
     <section id="mpms"><title>Multi-Processing Modules</title>