module-dict.html revision 2eaf662cbc81e823e8d9aeb8d54e69e63032493e
fd5a4eacd56700ffb08a73121aeacdc806cb0132Sumit Bose<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
fd5a4eacd56700ffb08a73121aeacdc806cb0132Sumit Bose "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagher<html xmlns="http://www.w3.org/1999/xhtml">
df4cc3a83c5d6700b6a09ff96cb4a6b1949b1aa9Stephen Gallagher <meta name="generator" content="HTML Tidy, see www.w3.org" />
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <title>Definitions of terms used to describe Apache
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher modules</title>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <!--#include virtual="header.html" -->
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <h1 align="CENTER">Terms Used to Describe Apache Modules</h1>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <p>Each Apache module is described using a common format that
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher looks like this:</p>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <dd><a href="#Status" rel="Help"><strong>Status:</strong></a>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <a href="#SourceFile" rel="Help"><strong>Source
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <a href="#ModuleIdentifier" rel="Help"><strong>Module
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher Identifier:</strong></a> <em>module-identifier</em><br />
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher rel="Help"><strong>Compatibility:</strong></a>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <p>Each of the attributes, complete with values where possible,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher are described in this document.</p>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <li><a href="#SourceFile">Source File</a></li>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <li><a href="#ModuleIdentifier">Module Identifier</a></li>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <li><a href="#Compatibility">Compatibility</a></li>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <h2><a id="Status" name="Status">Status</a></h2>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <p>This indicates how tightly bound into the Apache Web server
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher the module is; in other words, you may need to recompile the
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher server in order to gain access to the module and its
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher functionality. Possible values for this attribute are:</p>
c737e1444fb186e349e59bfa9dac4995b720b4b1Jan Zeleny href="/mpm.html">Multi-Processing Module</a>. Unlike the
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher other types of modules, Apache must have one and only one MPM
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher in use at any time. This type of module is responsible for
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher basic request handling and dispatching.</dd>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <dd>A module labeled as having "Base" status is compiled and
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher loaded into the server by default, and is therefore normally
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher available unless you have taken steps to remove the module
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher from your configuration.</dd>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <dd>A module with "Extension" status is not normally compiled
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher and loaded into the server. To enable the module and its
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher functionality, you may need to change the server build
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher configuration files and re-compile Apache.</dd>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <dd>"Experimental" status indicates that the module is
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher available as part of the Apache kit, but you are on your own
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher if you try to use it. The module is being documented for
69aaef8719c5cf33ed1c4090fa313ba281bf8a02Jakub Hrozek completeness, and is not necessarily supported.</dd>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <dd>Modules which are not included with the base Apache
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher distribution ("third-party modules") may use the "External"
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher status. We are not responsible for, nor do we support such
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallagher <h2><a id="SourceFile" name="SourceFile">Source File</a></h2>
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallagher <p>This quite simply lists the name of the source file which
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallagher contains the code for the module. This is also the name used by
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallagher href="core.html#ifmodule"><code><IfModule></code></a>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher directive.</p>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <h2><a id="ModuleIdentifier" name="ModuleIdentifier">Module
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <p>This is a string which identifies the module for use in the
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <a href="mod_so.html#loadmodule">LoadModule</a> directive when
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher dynamically loading modules. In particular, it is the name of
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher the external variable of type module in the source file.</p>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher name="Compatibility">Compatibility</a></h2>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <p>If the module was not part of the original Apache version 2
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher distribution, the version in which it was introduced should be
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher listed here.</p>
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher <!--#include virtual="footer.html" -->