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