module-dict.html revision afabe9e0b89e3e59688fec2805c283a2833d990b
0N/A<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
328N/A<HTML>
0N/A <HEAD>
0N/A <TITLE>Definitions of terms used to describe Apache modules
0N/A </TITLE>
0N/A </HEAD>
180N/A<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
0N/A <BODY
180N/A BGCOLOR="#FFFFFF"
0N/A TEXT="#000000"
0N/A LINK="#0000FF"
0N/A VLINK="#000080"
0N/A ALINK="#FF0000"
0N/A >
0N/A<!--#include virtual="header.html" -->
0N/A <H1 ALIGN="CENTER">Terms Used to Describe Apache Modules</H1>
0N/A
0N/A <P>
0N/A Each Apache module is described using a common format that looks
0N/A like this:
180N/A </P>
180N/A <DL>
180N/A <DD><A
0N/A HREF="#Status"
0N/A REL="Help"
5N/A ><STRONG>Status:</STRONG></A> <EM>status</EM>
5N/A <BR>
0N/A <A
8N/A HREF="#SourceFile"
0N/A REL="Help"
0N/A ><STRONG>Source File:</STRONG></A> <EM>source-file</EM>
0N/A <BR>
0N/A <A
0N/A HREF="#ModuleIdentifier"
0N/A REL="Help"
0N/A ><STRONG>Module Identifier:</STRONG></A> <EM>module-identifier</EM>
0N/A <BR>
0N/A <A
27N/A HREF="#Compatibility"
0N/A REL="Help"
27N/A ><STRONG>Compatibility:</STRONG></A> <EM>compatibility notes</EM>
27N/A </DD>
27N/A </DL>
0N/A <P>
0N/A Each of the attributes, complete with values where possible, are
0N/A described in this document.
0N/A </P>
0N/A
0N/A <H2>Module Terms</H2>
0N/A <UL>
0N/A <LI><A HREF="#Status">Status</A>
0N/A </LI>
0N/A <LI><A HREF="#SourceFile">Source File</A>
286N/A </LI>
27N/A <LI><A HREF="#ModuleIdentifier">Module Identifier</A>
27N/A </LI>
27N/A <LI><A HREF="#Compatibility">Compatibility</A>
27N/A </LI>
27N/A </UL>
27N/A
27N/A <HR>
27N/A <H2><A NAME="Status">Status</A></H2>
27N/A <P>
32N/A This indicates how tightly bound into the Apache Web server the
32N/A module is; in other words, you may need to recompile the server in
315N/A order to gain access to the module and its functionality. Possible
315N/A values for this attribute are:
311N/A </P>
311N/A <DL>
27N/A <DT><STRONG>MPM</STRONG>
27N/A </DT>
27N/A <DD>A module with status &quot;MPM&quot; is a <a
27N/A href="/mpm.html">Multi-Processing Module</a>. Unlike the other
27N/A types of modules, Apache must have one and only one MPM in use at
27N/A any time. This type of module is responsible for basic request
27N/A handling and dispatching.
311N/A <P>
27N/A </P>
27N/A <DT><STRONG>Base</STRONG>
27N/A </DT>
27N/A <DD>A module labeled as having &quot;Base&quot; status is compiled
311N/A and loaded into the server by default, and is therefore normally
27N/A available unless you have taken steps to remove the module from your
27N/A configuration.
27N/A <P>
27N/A </P>
27N/A </DD>
27N/A <DT><STRONG>Extension</STRONG>
311N/A </DT>
311N/A <DD>A module with &quot;Extension&quot; status is not normally
311N/A compiled and loaded into the server. To enable the module and its
311N/A functionality, you may need to change the server build
311N/A configuration files and re-compile Apache.
311N/A <P>
311N/A </P>
311N/A </DD>
311N/A <DT><STRONG>Experimental</STRONG>
27N/A </DT>
189N/A <DD>&quot;Experimental&quot; status indicates that the module is
27N/A available as part of the Apache kit, but you are on your own if you
27N/A try to use it. The module is being documented for completeness,
27N/A and is not necessarily supported.
311N/A <P>
27N/A </P>
27N/A </DD>
27N/A <DT><STRONG>External</STRONG>
27N/A </DT>
27N/A <DD>Modules which are not included with the base Apache
27N/A distribution (&quot;third-party modules&quot;) may use the
27N/A &quot;External&quot; status. We are not responsible for, nor do we
27N/A support such modules.
27N/A <P>
27N/A </P>
27N/A </DD>
27N/A </DL>
27N/A
27N/A <HR>
27N/A <H2><A NAME="SourceFile">Source File</A></H2>
27N/A <P>
27N/A This quite simply lists the name of the source file which contains
27N/A the code for the module. This is also the name used by the <A
27N/A HREF="core.html#ifmodule"><CODE>&lt;IfModule&gt;</CODE></A>
27N/A directive.
27N/A </P>
27N/A
27N/A <HR>
27N/A <H2><A NAME="ModuleIdentifier">Module Identifier</A></H2>
27N/A <P>
27N/A This is a string which identifies the module for use in the <A
27N/A HREF="mod_so.html#loadmodule">LoadModule</A> directive when
27N/A dynamically loading modules. In particular, it is the name
27N/A of the external variable of type module in the source file.
27N/A </P>
27N/A
27N/A <HR>
27N/A <H2><A NAME="Compatibility">Compatibility</A></H2>
27N/A <P>
27N/A If the module was not part of the original Apache version 2
27N/A distribution, the version in which it was introduced should be listed
311N/A here.
311N/A </P>
311N/A<!--#include virtual="footer.html" -->
27N/A </BODY>
27N/A</HTML>
27N/A