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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml">
   5   <head>
   6     <meta name="generator" content="HTML Tidy, see www.w3.org" />
   7
   8     <title>Definitions of terms used to describe Apache
   9     modules</title>
  10   </head>
  11   <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
  12
  13   <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
  14   vlink="#000080" alink="#FF0000">
  15     <!--#include virtual="header.html" -->
  16
  17     <h1 align="CENTER">Terms Used to Describe Apache Modules</h1>
  18
  19     <p>Each Apache module is described using a common format that
  20     looks like this:</p>
  21
  22     <dl>
  23       <dd><a href="#Status" rel="Help"><strong>Status:</strong></a>
  24       <em>status</em><br />
  25        <a href="#SourceFile" rel="Help"><strong>Source
  26       File:</strong></a> <em>source-file</em><br />
  27        <a href="#ModuleIdentifier" rel="Help"><strong>Module
  28       Identifier:</strong></a> <em>module-identifier</em><br />
  29        <a href="#Compatibility"
  30       rel="Help"><strong>Compatibility:</strong></a>
  31       <em>compatibility notes</em></dd>
  32     </dl>
  33
  34     <p>Each of the attributes, complete with values where possible,
  35     are described in this document.</p>
  36
  37     <h2>Module Terms</h2>
  38
  39     <ul>
  40       <li><a href="#Status">Status</a></li>
  41
  42       <li><a href="#SourceFile">Source File</a></li>
  43
  44       <li><a href="#ModuleIdentifier">Module Identifier</a></li>
  45
  46       <li><a href="#Compatibility">Compatibility</a></li>
  47     </ul>
  48     <hr />
  49
  50     <h2><a id="Status" name="Status">Status</a></h2>
  51
  52     <p>This indicates how tightly bound into the Apache Web server
  53     the module is; in other words, you may need to recompile the
  54     server in order to gain access to the module and its
  55     functionality. Possible values for this attribute are:</p>
  56
  57     <dl>
  58       <dt><strong>MPM</strong></dt>
  59
  60       <dd>A module with status "MPM" is a <a
  61       href="../mpm.html">Multi-Processing Module</a>. Unlike the
  62       other types of modules, Apache must have one and only one MPM
  63       in use at any time. This type of module is responsible for
  64       basic request handling and dispatching.</dd>
  65
  66       <dt><strong>Base</strong></dt>
  67
  68       <dd>A module labeled as having "Base" status is compiled and
  69       loaded into the server by default, and is therefore normally
  70       available unless you have taken steps to remove the module
  71       from your configuration.</dd>
  72
  73       <dt><strong>Extension</strong></dt>
  74
  75       <dd>A module with "Extension" status is not normally compiled
  76       and loaded into the server. To enable the module and its
  77       functionality, you may need to change the server build
  78       configuration files and re-compile Apache.</dd>
  79
  80       <dt><strong>Experimental</strong></dt>
  81
  82       <dd>"Experimental" status indicates that the module is
  83       available as part of the Apache kit, but you are on your own
  84       if you try to use it. The module is being documented for
  85       completeness, and is not necessarily supported.</dd>
  86
  87       <dt><strong>External</strong></dt>
  88
  89       <dd>Modules which are not included with the base Apache
  90       distribution ("third-party modules") may use the "External"
  91       status. We are not responsible for, nor do we support such
  92       modules.</dd>
  93     </dl>
  94     <hr />
  95
  96     <h2><a id="SourceFile" name="SourceFile">Source File</a></h2>
  97
  98     <p>This quite simply lists the name of the source file which
  99     contains the code for the module. This is also the name used by
 100     the <a
 101     href="core.html#ifmodule"><code>&lt;IfModule&gt;</code></a>
 102     directive.</p>
 103     <hr />
 104
 105     <h2><a id="ModuleIdentifier" name="ModuleIdentifier">Module
 106     Identifier</a></h2>
 107
 108     <p>This is a string which identifies the module for use in the
 109     <a href="mod_so.html#loadmodule">LoadModule</a> directive when
 110     dynamically loading modules. In particular, it is the name of
 111     the external variable of type module in the source file.</p>
 112     <hr />
 113
 114     <h2><a id="Compatibility"
 115     name="Compatibility">Compatibility</a></h2>
 116
 117     <p>If the module was not part of the original Apache version 2
 118     distribution, the version in which it was introduced should be
 119     listed here.</p>
 120     <!--#include virtual="footer.html" -->
 121   </body>
 122 </html>
 123