From b0abaae6bf6c1d0781b882c6d13d8cd6d8d17180 Mon Sep 17 00:00:00 2001 From: Astrid Malo Date: Sun, 23 Nov 2003 23:07:26 +0000 Subject: [PATCH] Several improvements: - some better descriptions - reorder the enable/disable module options - add --with-dbm options - some nits note: this is 2.0. changes in 2.1, e.g. auth modules, are still missing git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@101857 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/programs/configure.html.en | 259 ++++++++++++++++--------- docs/manual/programs/configure.xml | 259 ++++++++++++++++--------- 2 files changed, 334 insertions(+), 184 deletions(-) diff --git a/docs/manual/programs/configure.html.en b/docs/manual/programs/configure.html.en index 35c0ba76da2..12e8205976a 100644 --- a/docs/manual/programs/configure.html.en +++ b/docs/manual/programs/configure.html.en @@ -282,24 +282,22 @@ --enable-foo even if foo doesn't exist, so you need to type carefully. - -

Enable or disable discrete modules

+ +

Modules enabled by default

Some modules are compiled by default and have to be disabled - explicitly while other modules have to be enabled explicitly or by - using the keywords most or all (see - --enable-mods-shared below for further explanation) to be - available. Therefore use the options below.

- + explicitly. Use the following options to remove discrete modules from + the compilation process.

+
--disable-actions
Disable action triggering on requests, which is provided by mod_actions.
--disable-alias
-
Disable the mapping of requests to different parts of the filesystem, - which is provided by mod_alias.
+
Disable the mapping of requests to different parts of the + filesystem, which is provided by mod_alias.
--disable-asis
Disable support for as-is filetypes, which is provided by @@ -307,7 +305,9 @@
--disable-auth
Disable user-based access control provided by - mod_auth.
+ mod_auth. This module provides for HTTP Basic + Authentication, where the usernames and passwords are stored in + plain text files.
--disable-autoindex
Disable the directory listing functionality provided by @@ -318,15 +318,15 @@ mod_access.
--disable-cgi
-
mod_cgi, which provides support for CGI scripts, is - enabled by default when using a non-threaded MPM. Use this option to - disable CGI support.
- +
mod_cgi, which provides support for CGI scripts, + is enabled by default when using a non-threaded MPM. Use this + option to disable CGI support.
+
--disable-cgid
When using the threaded MPMs worker or perchild support for CGI scripts is provided by - mod_cgid by default. To disable CGI support use this - option.
+ mod_cgid by default. To disable CGI support use + this option.
--disable-charset-lite
Disable character set translation provided by @@ -343,12 +343,13 @@
--disable-http
-
Disable the HTTP protocol handling. The http 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. Don't disable this module unless you are really sure - what you are doing.
- Note: This module will always be linked statically.
+
Disable the HTTP protocol handling. The http + 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. Don't disable this + module unless you are really sure what you are doing. +
+ Note: This module will always be linked statically.
--disable-imap
Disable support for server based imagemaps, which provided by @@ -360,62 +361,66 @@
--disable-log-config
Disable the logging configuration provided by - mod_log_config.
+ mod_log_config. You won't be able to log requests + to the server without this module.
--disable-mime
-
Disable the mapping of file-extensions to MIME, which is provided by - mod_mime.
+
mod_mime associates the requested filename's + extensions with the file's behavior and content (mime-type, + language, character set and encoding). Disabling the mapping of + file-extensions to MIME is normally not recommended.
--disable-negotiation
Disable content negotiation provided by mod_negotiation.
--disable-setenvif
-
Disable support for basing environment variables on headers, which - is provided by mod_setenvif.
+
Disable support for basing environment variables on headers, + which is provided by mod_setenvif.
--disable-status
Enable the process/thread monitoring, which is provided by mod_status.
--disable-userdir
-
Disable the mapping of requests to user-specific directories, which - is provided by mod_userdir.
+
Disable the mapping of requests to user-specific directories, + which is provided by mod_userdir.
+
+ + +

Modules, disabled by default

+

Some modules are compiled by default and have to be enabled + explicitly or by using the keywords most or + all (see --enable-mods-shared below for + further explanation) to be available. Therefore use the options + below.

+
--enable-auth-anon
Enable anonymous user access provided by mod_auth_anon.
--enable-auth-dbm
-
Enable support for DBM-based access databases provided by - mod_auth_dbm.
+
mod_auth_dbm provides for HTTP Basic + Authentication, where the usernames and passwords are stored in DBM + type database files. Use this option to enable the module.
--enable-auth-digest
Enable RFC2617 Digest authentication provided by - mod_auth_digest.
+ mod_auth_digest. This module uses plain text files + to store the credentials.
--enable-auth-ldap
Enable LDAP based authentication provided by mod_auth_ldap.
- - -
--enable-bucketeer
-
Enable manipulation filter the manipulation filter for buckets, - which is provided by mod_bucketeer.
--enable-cache
Enable dynamic file caching provided by - mod_cache.
- - -
--enable-case-filter
-
Enable the example uppercase conversion output filter support of - mod_case_filter.
- - -
--enable-case-filter-in
-
Enable the example uppercase conversion input filter support of - mod_case_filter_in.
+ mod_cache. This experimental module may be + interesting for servers with high load or caching proxy servers. At + least one storage management module (e.g. + mod_disk_cache or mod_mem_cache) + is also necessary.
--enable-cern-meta
Enable the CERN-type meta files support provided by @@ -450,14 +455,6 @@
Enable disk caching provided by mod_disk_cache.
-
--enable-echo
-
Enable the ECHO server provided by - mod_echo.
- -
--enable-example
-
Enable the example and demo module - mod_example.
-
--enable-expires
Enable Expires header control provided by mod_expires.
@@ -498,26 +495,6 @@
Enable the isapi extension support provided by mod_isapi.
- -
--enable-optional-fn-export
-
Enable the example for an optional function exporter, which is - provided by mod_optional_fn_export.
- - -
--enable-optional-fn-import
-
Enable the example for an optional function importer, which is - provided by mod_optional_fn_import.
- - -
--enable-optional-hook-export
-
Enable the example for an optional hook exporter, which is provided - by mod_optional_hook_export.
- - -
--enable-optional-hook-import
-
Enable the example optional hook importer, which is provided by - mod_optional_hook_import.
-
--enable-proxy
Enable the proxy/gateway functionality provided by mod_proxy. The proxying capabilities for @@ -570,6 +547,69 @@
Enable user-session tracking provided by mod_usertrack.
+
--enable-vhost-alias
+
Enable mass virtual hosting provided by + mod_vhost_alias.
+
+ + +

Modules for developers

+

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.

+ +
+ +
--enable-bucketeer
+
Enable the manipulation filter for buckets, which is provided by + mod_bucketeer.
+ + +
--enable-case-filter
+
Enable the example uppercase conversion output filter support of + mod_case_filter.
+ + +
--enable-case-filter-in
+
Enable the example uppercase conversion input filter support of + mod_case_filter_in.
+ +
--enable-echo
+
Enable the ECHO server provided by + mod_echo.
+ +
--enable-example
+
Enable the example and demo module + mod_example.
+ + +
--enable-optional-fn-export
+
Enable the example for an optional function exporter, which is + provided by mod_optional_fn_export.
+ + +
--enable-optional-fn-import
+
Enable the example for an optional function importer, which is + provided by mod_optional_fn_import.
+ + +
--enable-optional-hook-export
+
Enable the example for an optional hook exporter, which is provided + by mod_optional_hook_export.
+ + +
--enable-optional-hook-import
+
Enable the example optional hook importer, which is provided by + mod_optional_hook_import.
+
+ + +

MPMs and third-party modules

+

To add the necessary Multi Processing Module and additional third-party + modules use the following options:

+ +
--with-module=module-type:module-file

Add a third-party module to the list of statically linked @@ -577,25 +617,26 @@ will be searched in the modules/module-type subdirectory of your Apache HTTP server source tree so it has to be placed there before. If it is not found here - configure is considering module-file to be a + configure is considering module-file to be an absolute file path and tries to copy the source file into the module-type subdirectory.

This option is useful to add small external modules consisting of - one source file. For bigger modules you should read the vendor's - documentation.

+ one source file. For more complex modules you should read the + vendor's documentation.

Note

- If you want to build a DSO module instead of a statically linked use - apxs.
+ If you want to build a DSO module instead of a statically linked + use apxs.
--with-mpm=MPM
Choose the process model for your server. You have to select - exactly one Multi-Processing Module. Otherwise - the default MPM for your operating - system will be taken. Possible MPMs are beos, - leader, mpmt_os2, - perchild, prefork, - threadpool and worker.
+ exactly one Multi-Processing Module. + Otherwise the default MPM for + your operating system will be taken. Possible MPMs are + beos, leader, + mpmt_os2, perchild, + prefork, threadpool and + worker.
@@ -633,17 +674,14 @@
--enable-v4-mapped
Allow IPv6 sockets to handle IPv4 connections.
-
--enable-vhost-alias
-
Enable mass virtual hosting provided by - mod_vhost_alias.
-
--with-port=PORT
This defines the port on which httpd will listen. This port number is used when generating the configuration file httpd.conf. The default is 80.
--with-program-name
-
Define an alternative executable name.
+
Define an alternative executable name. The default is + httpd.
@@ -703,6 +741,43 @@ (e.g., when mod_deflate is enabled). You can set the directory path to the compression library instead. + +

Several features of the Apache HTTP Server, including + mod_authn_dbm and mod_rewrite's DBM + RewriteMap 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:

+ +
+
--with-gdbm[=path]
+
If no path is specified, configure will + search for the include files and libraries of a GNU DBM + installation in the usual search paths. An explicit + path will cause configure to look in + path/lib and + path/include for the relevant files. + Finally, the path may specify specific include and + library paths separated by a colon.
+ +
--with-ndbm[=path]
+
Like --with-gdbm, bur searches for a New DBM + installation.
+ +
--with-berkeley-db[=path]
+
Like --with-gdbm, but searches for a Berkeley DB + installation.
+
+ +

Note

+

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 --with-apr-util.

+

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.

+
diff --git a/docs/manual/programs/configure.xml b/docs/manual/programs/configure.xml index 75d88b30461..28b11377f6e 100644 --- a/docs/manual/programs/configure.xml +++ b/docs/manual/programs/configure.xml @@ -266,24 +266,22 @@ --enable-foo even if foo doesn't exist, so you need to type carefully. - -
Enable or disable discrete modules + +
Modules enabled by default

Some modules are compiled by default and have to be disabled - explicitly while other modules have to be enabled explicitly or by - using the keywords most or all (see - --enable-mods-shared below for further explanation) to be - available. Therefore use the options below.

- + explicitly. Use the following options to remove discrete modules from + the compilation process.

+
--disable-actions
Disable action triggering on requests, which is provided by mod_actions.
--disable-alias
-
Disable the mapping of requests to different parts of the filesystem, - which is provided by mod_alias.
+
Disable the mapping of requests to different parts of the + filesystem, which is provided by mod_alias.
--disable-asis
Disable support for as-is filetypes, which is provided by @@ -291,7 +289,9 @@
--disable-auth
Disable user-based access control provided by - mod_auth.
+ mod_auth. This module provides for HTTP Basic + Authentication, where the usernames and passwords are stored in + plain text files.
--disable-autoindex
Disable the directory listing functionality provided by @@ -302,15 +302,15 @@ mod_access.
--disable-cgi
-
mod_cgi, which provides support for CGI scripts, is - enabled by default when using a non-threaded MPM. Use this option to - disable CGI support.
- +
mod_cgi, which provides support for CGI scripts, + is enabled by default when using a non-threaded MPM. Use this + option to disable CGI support.
+
--disable-cgid
When using the threaded MPMs worker or perchild support for CGI scripts is provided by - mod_cgid by default. To disable CGI support use this - option.
+ mod_cgid by default. To disable CGI support use + this option.
--disable-charset-lite
Disable character set translation provided by @@ -328,12 +328,13 @@
--disable-http
-
Disable the HTTP protocol handling. The http 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. Don't disable this module unless you are really sure - what you are doing.
- Note: This module will always be linked statically.
+
Disable the HTTP protocol handling. The http + 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. Don't disable this + module unless you are really sure what you are doing. +
+ Note: This module will always be linked statically.
--disable-imap
Disable support for server based imagemaps, which provided by @@ -345,62 +346,66 @@
--disable-log-config
Disable the logging configuration provided by - mod_log_config.
+ mod_log_config. You won't be able to log requests + to the server without this module.
--disable-mime
-
Disable the mapping of file-extensions to MIME, which is provided by - mod_mime.
+
mod_mime associates the requested filename's + extensions with the file's behavior and content (mime-type, + language, character set and encoding). Disabling the mapping of + file-extensions to MIME is normally not recommended.
--disable-negotiation
Disable content negotiation provided by mod_negotiation.
--disable-setenvif
-
Disable support for basing environment variables on headers, which - is provided by mod_setenvif.
+
Disable support for basing environment variables on headers, + which is provided by mod_setenvif.
--disable-status
Enable the process/thread monitoring, which is provided by mod_status.
--disable-userdir
-
Disable the mapping of requests to user-specific directories, which - is provided by mod_userdir.
+
Disable the mapping of requests to user-specific directories, + which is provided by mod_userdir.
+
+
+
Modules, disabled by default +

Some modules are compiled by default and have to be enabled + explicitly or by using the keywords most or + all (see --enable-mods-shared below for + further explanation) to be available. Therefore use the options + below.

+ +
--enable-auth-anon
Enable anonymous user access provided by mod_auth_anon.
--enable-auth-dbm
-
Enable support for DBM-based access databases provided by - mod_auth_dbm.
+
mod_auth_dbm provides for HTTP Basic + Authentication, where the usernames and passwords are stored in DBM + type database files. Use this option to enable the module.
--enable-auth-digest
Enable RFC2617 Digest authentication provided by - mod_auth_digest.
+ mod_auth_digest. This module uses plain text files + to store the credentials.
--enable-auth-ldap
Enable LDAP based authentication provided by mod_auth_ldap.
- - -
--enable-bucketeer
-
Enable manipulation filter the manipulation filter for buckets, - which is provided by mod_bucketeer.
--enable-cache
Enable dynamic file caching provided by - mod_cache.
- - -
--enable-case-filter
-
Enable the example uppercase conversion output filter support of - mod_case_filter.
- - -
--enable-case-filter-in
-
Enable the example uppercase conversion input filter support of - mod_case_filter_in.
+ mod_cache. This experimental module may be + interesting for servers with high load or caching proxy servers. At + least one storage management module (e.g. + mod_disk_cache or mod_mem_cache) + is also necessary.
--enable-cern-meta
Enable the CERN-type meta files support provided by @@ -435,14 +440,6 @@
Enable disk caching provided by mod_disk_cache.
-
--enable-echo
-
Enable the ECHO server provided by - mod_echo.
- -
--enable-example
-
Enable the example and demo module - mod_example.
-
--enable-expires
Enable Expires header control provided by mod_expires.
@@ -483,26 +480,6 @@
Enable the isapi extension support provided by mod_isapi.
- -
--enable-optional-fn-export
-
Enable the example for an optional function exporter, which is - provided by mod_optional_fn_export.
- - -
--enable-optional-fn-import
-
Enable the example for an optional function importer, which is - provided by mod_optional_fn_import.
- - -
--enable-optional-hook-export
-
Enable the example for an optional hook exporter, which is provided - by mod_optional_hook_export.
- - -
--enable-optional-hook-import
-
Enable the example optional hook importer, which is provided by - mod_optional_hook_import.
-
--enable-proxy
Enable the proxy/gateway functionality provided by mod_proxy. The proxying capabilities for @@ -555,6 +532,69 @@
Enable user-session tracking provided by mod_usertrack.
+
--enable-vhost-alias
+
Enable mass virtual hosting provided by + mod_vhost_alias.
+
+
+ +
Modules for developers +

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.

+ +
+ +
--enable-bucketeer
+
Enable the manipulation filter for buckets, which is provided by + mod_bucketeer.
+ + +
--enable-case-filter
+
Enable the example uppercase conversion output filter support of + mod_case_filter.
+ + +
--enable-case-filter-in
+
Enable the example uppercase conversion input filter support of + mod_case_filter_in.
+ +
--enable-echo
+
Enable the ECHO server provided by + mod_echo.
+ +
--enable-example
+
Enable the example and demo module + mod_example.
+ + +
--enable-optional-fn-export
+
Enable the example for an optional function exporter, which is + provided by mod_optional_fn_export.
+ + +
--enable-optional-fn-import
+
Enable the example for an optional function importer, which is + provided by mod_optional_fn_import.
+ + +
--enable-optional-hook-export
+
Enable the example for an optional hook exporter, which is provided + by mod_optional_hook_export.
+ + +
--enable-optional-hook-import
+
Enable the example optional hook importer, which is provided by + mod_optional_hook_import.
+
+
+ +
MPMs and third-party modules +

To add the necessary Multi Processing Module and additional third-party + modules use the following options:

+ +
--with-module=module-type:module-file

Add a third-party module to the list of statically linked @@ -562,25 +602,26 @@ will be searched in the modules/module-type subdirectory of your Apache HTTP server source tree so it has to be placed there before. If it is not found here - configure is considering module-file to be a + configure is considering module-file to be an absolute file path and tries to copy the source file into the module-type subdirectory.

This option is useful to add small external modules consisting of - one source file. For bigger modules you should read the vendor's - documentation.

+ one source file. For more complex modules you should read the + vendor's documentation.

Note - If you want to build a DSO module instead of a statically linked use - apxs. + If you want to build a DSO module instead of a statically linked + use apxs.
--with-mpm=MPM
Choose the process model for your server. You have to select - exactly one Multi-Processing Module. Otherwise - the default MPM for your operating - system will be taken. Possible MPMs are beos, - leader, mpmt_os2, - perchild, prefork, - threadpool and worker.
+ exactly one Multi-Processing Module. + Otherwise the default MPM for + your operating system will be taken. Possible MPMs are + beos, leader, + mpmt_os2, perchild, + prefork, threadpool and + worker.
@@ -621,17 +662,14 @@
--enable-v4-mapped
Allow IPv6 sockets to handle IPv4 connections.
-
--enable-vhost-alias
-
Enable mass virtual hosting provided by - mod_vhost_alias.
-
--with-port=PORT
This defines the port on which httpd will listen. This port number is used when generating the configuration file httpd.conf. The default is 80.
--with-program-name
-
Define an alternative executable name.
+
Define an alternative executable name. The default is + httpd.
@@ -692,6 +730,43 @@ (e.g., when mod_deflate is enabled). You can set the directory path to the compression library instead. + +

Several features of the Apache HTTP Server, including + mod_authn_dbm and mod_rewrite's DBM + RewriteMap 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:

+ +
+
--with-gdbm[=path]
+
If no path is specified, configure will + search for the include files and libraries of a GNU DBM + installation in the usual search paths. An explicit + path will cause configure to look in + path/lib and + path/include for the relevant files. + Finally, the path may specify specific include and + library paths separated by a colon.
+ +
--with-ndbm[=path]
+
Like --with-gdbm, bur searches for a New DBM + installation.
+ +
--with-berkeley-db[=path]
+
Like --with-gdbm, but searches for a Berkeley DB + installation.
+
+ + Note +

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 --with-apr-util.

+

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.

+ -- 2.47.3