granicus.if.org Git - apache/blob - docs/manual/mod/module-dict.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       --><title>Terms Used to Describe Modules - Apache HTTP Server</title><link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="../images/favicon.ico" rel="shortcut icon" /></head><body id="manual-page"><div id="page-header"><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="../images/feather.gif" /></div><div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.0</a></div><div id="page-content"><div id="preamble"><h1>Terms Used to Describe Modules</h1>
   8    <p>This document describes the terms that are used to describe
   9     each Apache <a href="./">module</a>.</p>
  10 </div><div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#Description">Description</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Status">Status</a></li><li><img alt="" src="../images/down.gif" /> <a href="#SourceFile">Source File</a></li><li><img alt="" src="../images/down.gif" /> <a href="#ModuleIdentifier">Module Identifier</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Compatibility">Compatibility</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Description" id="Description">Description</a></h2>
  11
  12 <p>A brief description of the purpose of the module.</p>
  13 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Status" id="Status">Status</a></h2>
  14
  15     <p>This indicates how tightly bound into the Apache Web server
  16     the module is; in other words, you may need to recompile the
  17     server in order to gain access to the module and its
  18     functionality. Possible values for this attribute are:</p>
  19
  20     <dl>
  21       <dt>MPM</dt>
  22
  23       <dd>A module with status "MPM" is a <a href="../mpm.html">Multi-Processing Module</a>. Unlike the
  24       other types of modules, Apache must have one and only one MPM
  25       in use at any time. This type of module is responsible for
  26       basic request handling and dispatching.</dd>
  27
  28       <dt>Base</dt>
  29
  30       <dd>A module labeled as having "Base" status is compiled and
  31       loaded into the server by default, and is therefore normally
  32       available unless you have taken steps to remove the module
  33       from your configuration.</dd>
  34
  35       <dt>Extension</dt>
  36
  37       <dd>A module with "Extension" status is not normally compiled
  38       and loaded into the server. To enable the module and its
  39       functionality, you may need to change the server build
  40       configuration files and re-compile Apache.</dd>
  41
  42       <dt>Experimental</dt>
  43
  44       <dd>"Experimental" status indicates that the module is
  45       available as part of the Apache kit, but you are on your own
  46       if you try to use it. The module is being documented for
  47       completeness, and is not necessarily supported.</dd>
  48
  49       <dt>External</dt>
  50
  51       <dd>Modules which are not included with the base Apache
  52       distribution ("third-party modules") may use the "External"
  53       status. We are not responsible for, nor do we support such
  54       modules.</dd>
  55     </dl>
  56 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="SourceFile" id="SourceFile">Source File</a></h2>
  57
  58     <p>This quite simply lists the name of the source file which
  59     contains the code for the module. This is also the name used by
  60     the <code class="directive"><a href="../mod/core.html#ifmodule">&lt;IfModule&gt;</a></code>
  61     directive.</p>
  62 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="ModuleIdentifier" id="ModuleIdentifier">Module Identifier</a></h2>
  63
  64     <p>This is a string which identifies the module for use in the
  65     <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code> directive when
  66     dynamically loading modules. In particular, it is the name of
  67     the external variable of type module in the source file.</p>
  68 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Compatibility" id="Compatibility">Compatibility</a></h2>
  69
  70     <p>If the module was not part of the original Apache version 2
  71     distribution, the version in which it was introduced should be
  72     listed here.  In addition, if the module is limited to
  73     particular platforms, the details will be listed here.</p>
  74 </div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>