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

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
   2 <HTML>
   3  <HEAD>
   4   <TITLE>Definitions of terms used to describe Apache modules
   5   </TITLE>
   6  </HEAD>
   7 <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
   8  <BODY
   9   BGCOLOR="#FFFFFF"
  10   TEXT="#000000"
  11   LINK="#0000FF"
  12   VLINK="#000080"
  13   ALINK="#FF0000"
  14  >
  15 <!--#include virtual="header.html" -->
  16   <H1 ALIGN="CENTER">Terms Used to Describe Apache Modules</H1>
  17
  18   <P>
  19   Each Apache module is described using a common format that looks
  20   like this:
  21   </P>
  22   <DL>
  23    <DD><A
  24         HREF="#Status"
  25         REL="Help"
  26        ><STRONG>Status:</STRONG></A> <EM>status</EM>
  27        <BR>
  28        <A
  29         HREF="#SourceFile"
  30         REL="Help"
  31        ><STRONG>Source File:</STRONG></A> <EM>source-file</EM>
  32        <BR>
  33        <A
  34         HREF="#ModuleIdentifier"
  35         REL="Help"
  36        ><STRONG>Module Identifier:</STRONG></A> <EM>module-identifier</EM>
  37        <BR>
  38        <A
  39         HREF="#Compatibility"
  40         REL="Help"
  41        ><STRONG>Compatibility:</STRONG></A> <EM>compatibility notes</EM>
  42    </DD>
  43   </DL>
  44   <P>
  45   Each of the attributes, complete with values where possible, are
  46   described in this document.
  47   </P>
  48
  49   <H2>Module Terms</H2>
  50   <UL>
  51    <LI><A HREF="#Status">Status</A>
  52    </LI>
  53    <LI><A HREF="#SourceFile">Source File</A>
  54    </LI>
  55    <LI><A HREF="#ModuleIdentifier">Module Identifier</A>
  56    </LI>
  57    <LI><A HREF="#Compatibility">Compatibility</A>
  58    </LI>
  59   </UL>
  60
  61   <HR>
  62   <H2><A NAME="Status">Status</A></H2>
  63   <P>
  64   This indicates how tightly bound into the Apache Web server the
  65   module is; in other words, you may need to recompile the server in
  66   order to gain access to the module and its functionality.  Possible
  67   values for this attribute are:
  68   </P>
  69   <DL>
  70    <DT><STRONG>Base</STRONG>
  71    </DT>
  72    <DD>A module labeled as having &quot;Base&quot; status is compiled
  73    and loaded into the server by default, and is therefore normally
  74    available unless you have taken steps to remove the module from your
  75    configuration.
  76     <P>
  77     </P>
  78    </DD>
  79    <DT><STRONG>Extension</STRONG>
  80    </DT>
  81    <DD>A module with &quot;Extension&quot; status is not normally
  82    compiled and loaded into the server.  To enable the module and its
  83    functionality, you may need to change the server build
  84    configuration files and re-compile Apache.
  85     <P>
  86     </P>
  87    </DD>
  88    <DT><STRONG>Experimental</STRONG>
  89    </DT>
  90    <DD>&quot;Experimental&quot; status indicates that the module is
  91     available as part of the Apache kit, but you are on your own if you
  92     try to use it.  The module is being documented for completeness,
  93     and is not necessarily supported.
  94     <P>
  95     </P>
  96    </DD>
  97    <DT><STRONG>External</STRONG>
  98    </DT>
  99    <DD>Modules which are not included with the base Apache
 100    distribution (&quot;third-party modules&quot;) may use the
 101    &quot;External&quot; status.  We are not responsible for, nor do we
 102    support such modules.
 103     <P>
 104     </P>
 105    </DD>
 106   </DL>
 107
 108   <HR>
 109   <H2><A NAME="SourceFile">Source File</A></H2>
 110   <P>
 111   This quite simply lists the name of the source file which contains
 112   the code for the module.  This is also the name used by the <A
 113   HREF="core.html#ifmodule"><CODE>&lt;IfModule&gt;</CODE></A>
 114   directive.
 115   </P>
 116
 117   <HR>
 118   <H2><A NAME="ModuleIdentifier">Module Identifier</A></H2>
 119   <P>
 120   This is a string which identifies the module for use in the <A
 121   HREF="mod_so.html#loadmodule">LoadModule</A> directive when
 122   dynamically loading modules.  In particular, it is the name
 123   of the external variable of type module in the source file.
 124   </P>
 125
 126   <HR>
 127   <H2><A NAME="Compatibility">Compatibility</A></H2>
 128   <P>
 129   If the module was not part of the original Apache version 2
 130   distribution, the version in which it was introduced should be listed
 131   here.
 132   </P>
 133 <!--#include virtual="footer.html" -->
 134  </BODY>
 135 </HTML>