Mailing List Archive: cvs commit: httpd-docs-2.0/htdocs/manual/mod module-dict.html

slive 00/09/22 12:58:18

Added: htdocs/manual/mod module-dict.html
Log:
Description of terms used to describe modules in the new (not yet
implemented) format.

Revision Changes Path
1.1 httpd-docs-2.0/htdocs/manual/mod/module-dict.html

Index: module-dict.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE>Definitions of terms used to describe Apache modules
</TITLE>
</HEAD>

<BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#000080"
ALINK="#FF0000"
>

<H1 ALIGN="CENTER">Terms Used to Describe Apache Modules</H1>

<P>
Each Apache module is described using a common format that looks
like this:
</P>
<DL>
<DD><A
HREF="#Status"
REL="Help"
><STRONG>Status:</STRONG></A> <EM>status</EM>
<BR>
<A
HREF="#SourceFile"
REL="Help"
><STRONG>Source File:</STRONG></A> <EM>source-file</EM>
<BR>
<A
HREF="#ModuleIdentifier"
REL="Help"
><STRONG>Module Identifier:</STRONG></A> <EM>module-identifier</EM>
<BR>
<A
HREF="#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> <EM>compatibility notes</EM>
</DD>
</DL>
<P>
Each of the attributes, complete with values where possible, are
described in this document.
</P>

<H2>Module Terms</H2>
<UL>
<LI><A HREF="#Status">Status</A>
</LI>
<LI><A HREF="#SourceFile">Source File</A>
</LI>
<LI><A HREF="#ModuleIdentifier">Module Identifier</A>
</LI>
<LI><A HREF="#Compatibility">Compatibility</A>
</LI>
</UL>

<HR>
<H2><A NAME="Status">Status</A></H2>
<P>
This indicates how tightly bound into the Apache Web server the
module is; in other words, you may need to recompile the server in
order to gain access to the module and its functionality. Possible
values for this attribute are:
</P>
<DL>
<DT><STRONG>Base</STRONG>
</DT>
<DD>A module labeled as having "Base" status is compiled
and loaded into the server by default, and is therefore normally
available unless you have taken steps to remove the module from your
configuration.
<P>
</P>
</DD>
<DT><STRONG>Extension</STRONG>
</DT>
<DD>A module with "Extension" status is not normally
compiled and loaded into the server. To enable the module and its
functionality, you may need to change the server build
configuration files and re-compile Apache.
<P>
</P>
</DD>
<DT><STRONG>Experimental</STRONG>
</DT>
<DD>"Experimental" status indicates that the module is
available as part of the Apache kit, but you are on your own if you
try to use it. The module is being documented for completeness,
and is not necessarily supported.
<P>
</P>
</DD>
<DT><STRONG>External</STRONG>
</DT>
<DD>Modules which are not included with the base Apache
distribution ("third-party modules") may use the
"External" status. We are not responsible for, nor do we
support such modules.
<P>
</P>
</DD>
</DL>

<HR>
<H2><A NAME="SourceFile">Source File</A></H2>
<P>
This quite simply lists the name of the source file which contains
the code for the module. This is also the name used by the <A
HREF="core.html#ifmodule"><CODE><IfModule></CODE></A>
directive.
</P>

<HR>
<H2><A NAME="ModuleIdentifier">Module Identifier</A></H2>
<P>
This is a string which identifies the module for use in the <A
HREF="mod_so.html#loadmodule">LoadModule</A> directive when
dynamically loading modules. In particular, it is the name
of the external variable of type module in the source file.
</P>

<HR>
<H2><A NAME="Compatibility">Compatibility</A></H2>
<P>
If the module was not part of the original Apache version 2
distribution, the version in which it was introduced should be listed
here.
</P>

</BODY>
</HTML>