1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
4 <!-- $LastChangedRevision$ -->
7 Copyright 2002-2005 The Apache Software Foundation or its licensors, as
10 Licensed under the Apache License, Version 2.0 (the "License");
11 you may not use this file except in compliance with the License.
12 You may obtain a copy of the License at
14 http://www.apache.org/licenses/LICENSE-2.0
16 Unless required by applicable law or agreed to in writing, software
17 distributed under the License is distributed on an "AS IS" BASIS,
18 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 See the License for the specific language governing permissions and
20 limitations under the License.
23 <manualpage metafile="module-dict.xml.meta">
25 <title>Terms Used to Describe Modules</title>
28 <p>This document describes the terms that are used to describe
29 each Apache <a href="./">module</a>.</p>
32 <section id="Description"><title>Description</title>
34 <p>A brief description of the purpose of the module.</p>
37 <section id="Status"><title>Status</title>
39 <p>This indicates how tightly bound into the Apache Web server
40 the module is; in other words, you may need to recompile the
41 server in order to gain access to the module and its
42 functionality. Possible values for this attribute are:</p>
47 <dd>A module with status "MPM" is a <a
48 href="../mpm.html">Multi-Processing Module</a>. Unlike the
49 other types of modules, Apache must have one and only one MPM
50 in use at any time. This type of module is responsible for
51 basic request handling and dispatching.</dd>
55 <dd>A module labeled as having "Base" status is compiled and
56 loaded into the server by default, and is therefore normally
57 available unless you have taken steps to remove the module
58 from your configuration.</dd>
62 <dd>A module with "Extension" status is not normally compiled
63 and loaded into the server. To enable the module and its
64 functionality, you may need to change the server build
65 configuration files and re-compile Apache.</dd>
69 <dd>"Experimental" status indicates that the module is
70 available as part of the Apache kit, but you are on your own
71 if you try to use it. The module is being documented for
72 completeness, and is not necessarily supported.</dd>
76 <dd>Modules which are not included with the base Apache
77 distribution ("third-party modules") may use the "External"
78 status. We are not responsible for, nor do we support such
83 <section id="SourceFile"><title>Source File</title>
85 <p>This quite simply lists the name of the source file which
86 contains the code for the module. This is also the name used by
87 the <directive module="core" type="section">IfModule</directive>
91 <section id="ModuleIdentifier"><title>Module Identifier</title>
93 <p>This is a string which identifies the module for use in the
94 <directive module="mod_so">LoadModule</directive> directive when
95 dynamically loading modules. In particular, it is the name of
96 the external variable of type module in the source file.</p>
99 <section id="Compatibility"><title>Compatibility</title>
101 <p>If the module was not part of the original Apache version 2
102 distribution, the version in which it was introduced should be
103 listed here. In addition, if the module is limited to
104 particular platforms, the details will be listed here.</p>