module-dict.xml revision 7db9f691a00ead175b03335457ca296a33ddf31b
1d363c6830b1389bb442b3110e1b803f2a69c979slive<?xml version="1.0" encoding="UTF-8" ?>
1d363c6830b1389bb442b3110e1b803f2a69c979slive<!DOCTYPE manualpage SYSTEM "/style/manualpage.dtd">
1d363c6830b1389bb442b3110e1b803f2a69c979slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
7db9f691a00ead175b03335457ca296a33ddf31bnd<manualpage metafile="module-dict.xml.meta">
1d363c6830b1389bb442b3110e1b803f2a69c979slive <relativepath href=".."/>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <title>Terms Used to Describe Modules</title>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive<summary>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This document describes the terms that are used to describe
1d363c6830b1389bb442b3110e1b803f2a69c979slive each Apache <a href="./">module</a>.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive</summary>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive<section id="Description"><title>Description</title>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive<p>A brief description of the purpose of the module.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive</section>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive<section id="Status"><title>Status</title>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This indicates how tightly bound into the Apache Web server
1d363c6830b1389bb442b3110e1b803f2a69c979slive the module is; in other words, you may need to recompile the
1d363c6830b1389bb442b3110e1b803f2a69c979slive server in order to gain access to the module and its
1d363c6830b1389bb442b3110e1b803f2a69c979slive functionality. Possible values for this attribute are:</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dl>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dt>MPM</dt>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A module with status "MPM" is a <a
1d363c6830b1389bb442b3110e1b803f2a69c979slive href="/mpm.html">Multi-Processing Module</a>. Unlike the
1d363c6830b1389bb442b3110e1b803f2a69c979slive other types of modules, Apache must have one and only one MPM
1d363c6830b1389bb442b3110e1b803f2a69c979slive in use at any time. This type of module is responsible for
1d363c6830b1389bb442b3110e1b803f2a69c979slive basic request handling and dispatching.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dt>Base</dt>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A module labeled as having "Base" status is compiled and
1d363c6830b1389bb442b3110e1b803f2a69c979slive loaded into the server by default, and is therefore normally
1d363c6830b1389bb442b3110e1b803f2a69c979slive available unless you have taken steps to remove the module
1d363c6830b1389bb442b3110e1b803f2a69c979slive from your configuration.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dt>Extension</dt>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A module with "Extension" status is not normally compiled
1d363c6830b1389bb442b3110e1b803f2a69c979slive and loaded into the server. To enable the module and its
1d363c6830b1389bb442b3110e1b803f2a69c979slive functionality, you may need to change the server build
1d363c6830b1389bb442b3110e1b803f2a69c979slive configuration files and re-compile Apache.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dt>Experimental</dt>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>"Experimental" status indicates that the module is
1d363c6830b1389bb442b3110e1b803f2a69c979slive available as part of the Apache kit, but you are on your own
1d363c6830b1389bb442b3110e1b803f2a69c979slive if you try to use it. The module is being documented for
1d363c6830b1389bb442b3110e1b803f2a69c979slive completeness, and is not necessarily supported.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dt>External</dt>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>Modules which are not included with the base Apache
1d363c6830b1389bb442b3110e1b803f2a69c979slive distribution ("third-party modules") may use the "External"
1d363c6830b1389bb442b3110e1b803f2a69c979slive status. We are not responsible for, nor do we support such
1d363c6830b1389bb442b3110e1b803f2a69c979slive modules.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive </dl>
1d363c6830b1389bb442b3110e1b803f2a69c979slive</section>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive<section id="SourceFile"><title>Source File</title>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This quite simply lists the name of the source file which
1d363c6830b1389bb442b3110e1b803f2a69c979slive contains the code for the module. This is also the name used by
1d363c6830b1389bb442b3110e1b803f2a69c979slive the <directive module="core" type="section">IfModule</directive>
1d363c6830b1389bb442b3110e1b803f2a69c979slive directive.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive</section>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive<section id="ModuleIdentifier"><title>Module Identifier</title>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This is a string which identifies the module for use in the
1d363c6830b1389bb442b3110e1b803f2a69c979slive <directive module="mod_so">LoadModule</directive> directive when
1d363c6830b1389bb442b3110e1b803f2a69c979slive dynamically loading modules. In particular, it is the name of
1d363c6830b1389bb442b3110e1b803f2a69c979slive the external variable of type module in the source file.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive</section>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive<section id="Compatibility"><title>Compatibility</title>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>If the module was not part of the original Apache version 2
1d363c6830b1389bb442b3110e1b803f2a69c979slive distribution, the version in which it was introduced should be
1d363c6830b1389bb442b3110e1b803f2a69c979slive listed here. In addition, if the module is limited to
1d363c6830b1389bb442b3110e1b803f2a69c979slive particular platforms, the details will be listed here.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive</section>
1d363c6830b1389bb442b3110e1b803f2a69c979slive
7db9f691a00ead175b03335457ca296a33ddf31bnd</manualpage>