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

   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$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  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.
  21 -->
  22
  23 <manualpage metafile="module-dict.xml.meta">
  24
  25   <title>Terms Used to Describe Modules</title>
  26
  27 <summary>
  28    <p>This document describes the terms that are used to describe
  29     each Apache <a href="./">module</a>.</p>
  30 </summary>
  31
  32 <section id="Description"><title>Description</title>
  33
  34 <p>A brief description of the purpose of the module.</p>
  35 </section>
  36
  37 <section id="Status"><title>Status</title>
  38
  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>
  43
  44     <dl>
  45       <dt>MPM</dt>
  46
  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>
  52
  53       <dt>Base</dt>
  54
  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>
  59
  60       <dt>Extension</dt>
  61
  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>
  66
  67       <dt>Experimental</dt>
  68
  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>
  73
  74       <dt>External</dt>
  75
  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
  79       modules.</dd>
  80     </dl>
  81 </section>
  82
  83 <section id="SourceFile"><title>Source File</title>
  84
  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>
  88     directive.</p>
  89 </section>
  90
  91 <section id="ModuleIdentifier"><title>Module Identifier</title>
  92
  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>
  97 </section>
  98
  99 <section id="Compatibility"><title>Compatibility</title>
 100
 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>
 105 </section>
 106
 107 </manualpage>