diff options
author | Rainer Jung <rjung@apache.org> | 2010-06-07 00:07:37 +0200 |
---|---|---|
committer | Rainer Jung <rjung@apache.org> | 2010-06-07 00:07:37 +0200 |
commit | 11b267acd89160cc750055eb5f4b81adc013290d (patch) | |
tree | 48a5962ee5dc7630eb5d5d9a76240369ccc14363 /docs | |
parent | Fix comment. DSO is now default. (diff) | |
download | apache2-11b267acd89160cc750055eb5f4b81adc013290d.tar.xz apache2-11b267acd89160cc750055eb5f4b81adc013290d.zip |
Adapt docs to modules now being build dynamically by default.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@952009 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs')
-rw-r--r-- | docs/manual/dso.xml | 48 | ||||
-rw-r--r-- | docs/manual/install.xml | 26 | ||||
-rw-r--r-- | docs/manual/programs/configure.xml | 46 |
3 files changed, 60 insertions, 60 deletions
diff --git a/docs/manual/dso.xml b/docs/manual/dso.xml index 0c7ea47a52..492a56c6a4 100644 --- a/docs/manual/dso.xml +++ b/docs/manual/dso.xml @@ -27,14 +27,14 @@ <summary> <p>The Apache HTTP Server is a modular program where the administrator can choose the functionality to include in the - server by selecting a set of modules. The modules can be - statically compiled into the <program>httpd</program> binary when the - server is built. Alternatively, modules can be compiled as - Dynamic Shared Objects (DSOs) that exist separately from the - main <program>httpd</program> binary file. DSO modules may be - compiled at the time the server is built, or they may be - compiled and added at a later time using the Apache Extension - Tool (<program>apxs</program>).</p> + server by selecting a set of modules. + Modules will be compiled as Dynamic Shared Objects (DSOs) + that exist separately from the main <program>httpd</program> + binary file. DSO modules may be compiled at the time the server + is built, or they may be compiled and added at a later time + using the Apache Extension Tool (<program>apxs</program>).</p> + <p>Alternatively, the modules can be statically compiled into + the <program>httpd</program> binary when the server is built.</p> <p>This document describes how to use DSO modules as well as the theory behind their use.</p> @@ -56,16 +56,16 @@ on a module named <module>mod_so</module> which must be statically compiled into the Apache httpd core. It is the only module besides <module>core</module> which cannot be put into a DSO - itself. Practically all other distributed Apache httpd modules can then - be placed into a DSO by individually enabling the DSO build for - them via <program>configure</program>'s - <code>--enable-mods-shared</code> option as discussed - in the <a href="install.html">install documentation</a>. After a - module is compiled into a DSO named <code>mod_foo.so</code> you - can use <module>mod_so</module>'s <directive + itself. Practically all other distributed Apache httpd modules will then + be placed into a DSO. After a module is compiled into a DSO named + <code>mod_foo.so</code> you can use <module>mod_so</module>'s <directive module="mod_so">LoadModule</directive> command in your <code>httpd.conf</code> file to load this module at server startup or restart.</p> + <p>The DSO builds for individual modules can be disabled via + <program>configure</program>'s <code>--enable-mods-static</code> + option as discussed in the <a href="install.html">install + documentation</a>.</p> <p>To simplify this creation of DSO files for Apache httpd modules (especially for third-party modules) a support program @@ -95,17 +95,7 @@ <code>mod_foo.so</code>:</p> <example> -$ ./configure --prefix=/path/to/install --enable-foo --enable-mods-shared=foo<br /> -$ make install -</example> - </li> - - <li> - <p>Configure Apache HTTP Server for <em>later installation</em> of shared - modules:</p> - -<example> -$ ./configure --enable-so<br /> +$ ./configure --prefix=/path/to/install --enable-foo<br /> $ make install </example> </li> @@ -118,13 +108,9 @@ $ make install <code>httpd.conf</code>.</p> <example> -$ ./configure --enable-modules=most --enable-mods-shared=all<br /> +$ ./configure --enable-mods-shared=all<br /> $ make install </example> - - <p>The <code>most</code> argument to - <code>--enable-modules</code> indicates that all modules - which are not experimental or example modules will be built.</p> </li> <li> diff --git a/docs/manual/install.xml b/docs/manual/install.xml index 94a6c71b98..69aef54c44 100644 --- a/docs/manual/install.xml +++ b/docs/manual/install.xml @@ -225,17 +225,18 @@ $ tar xvf httpd-<em>NN</em>.tar <p>Also at this point, you can specify which <a href="programs/configure.html#optionalfeatures">features</a> you want included in Apache by enabling and disabling <a - href="mod/">modules</a>. Apache comes with a <a - href="mod/module-dict.html#Status">Base</a> set of modules included by - default. Other modules are enabled using the + href="mod/">modules</a>. Apache comes with a wide range of modules + included by default. They will be compiled as + <a href="dso.html">shared objects (DSOs)</a> which can be loaded + or unloaded at runtime. + You can also choose to compile modules statically by using the option + <code>--enable-<var>module</var>=static</code>.</p> + + <p>Additional modules are enabled using the <code>--enable-<var>module</var></code> option, where <var>module</var> is the name of the module with the <code>mod_</code> string removed and with any underscore converted - to a dash. You can also choose to compile modules as <a - href="dso.html">shared objects (DSOs)</a> -- which can be loaded - or unloaded at runtime -- by using the option - <code>--enable-<var>module</var>=shared</code>. Similarly, you can - disable Base modules with the + to a dash. Similarly, you can disable modules with the <code>--disable-<var>module</var></code> option. Be careful when using these options, since <program>configure</program> cannot warn you if the module you specify does not exist; it will simply ignore the @@ -252,15 +253,14 @@ $ tar xvf httpd-<em>NN</em>.tar <p>For a short impression of what possibilities you have, here is a typical example which compiles Apache for the installation tree <code>/sw/pkg/apache</code> with a particular compiler and flags - plus the two additional modules <module>mod_rewrite</module> and - <module>mod_speling</module> for - later loading through the DSO mechanism:</p> + plus the two additional modules <module>mod_ldap</module> and + <module>mod_lua</module>:</p> <example> $ CC="pgcc" CFLAGS="-O2" \<br /> ./configure --prefix=/sw/pkg/apache \<br /> - --enable-rewrite=shared \<br /> - --enable-speling=shared + --enable-ldap=shared \<br /> + --enable-lua=shared </example> <p>When <program>configure</program> is run it will take several minutes to diff --git a/docs/manual/programs/configure.xml b/docs/manual/programs/configure.xml index 7553cde7e6..a63d12edda 100644 --- a/docs/manual/programs/configure.xml +++ b/docs/manual/programs/configure.xml @@ -274,11 +274,11 @@ is <code>yes</code>.</dd> <dt><code>--enable-<var>MODULE</var>=shared</code></dt> - <dd>The corresponding module will be build as DSO module.</dd> + <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>By default enabled modules are linked statically. You can force - this explicitly.</dd> + <dd>The corresponding module will be linked statically.</dd> </dl> <note><title>Note</title> @@ -291,8 +291,11 @@ <!-- 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. Use the following options to remove discrete modules from - the compilation process.</p> + 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> @@ -393,11 +396,12 @@ </section> <section id="disabledmodules"><title>Modules, disabled by default</title> - <p>Some modules are compiled by default and have to be enabled + <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-mods-shared</code> below for - further explanation) to be available. Therefore use the options - below.</p> + <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> @@ -556,8 +560,8 @@ <dt><code>--enable-so</code></dt> <dd>Enable DSO capability provided by <module>mod_so</module>. This - module will be automatically enabled if you use the - <code>--enable-mods-shared</code> option.</dd> + 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 @@ -716,14 +720,19 @@ <example> --enable-mods-shared='headers rewrite dav' </example> - <p>Additionally you can use the special keywords <code>all</code> and - <code>most</code>. For example,</p> + <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>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> + 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> @@ -736,13 +745,18 @@ </example> </dd> - <dt><code>--enable-modules=<var>MODULE-LIST</var></code></dt> + <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> |