httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sl...@apache.org
Subject cvs commit: httpd-2.0/docs/manual/mod directive-dict.xml module-dict.xml directive-dict.html.en module-dict.html.en
Date Fri, 06 Sep 2002 23:04:35 GMT
slive       2002/09/06 16:04:35

  Modified:    docs/manual/mod directive-dict.html.en module-dict.html.en
  Added:       docs/manual/mod directive-dict.xml module-dict.xml
  Log:
  Convert directive-dict and module-dict to xml (and sneak in a few
  small content changes).
  
  Revision  Changes    Path
  1.16      +60 -146   httpd-2.0/docs/manual/mod/directive-dict.html.en
  
  Index: directive-dict.html.en
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/mod/directive-dict.html.en,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -d -b -u -r1.15 -r1.16
  --- directive-dict.html.en	25 Jul 2002 21:46:40 -0000	1.15
  +++ directive-dict.html.en	6 Sep 2002 23:04:35 -0000	1.16
  @@ -1,72 +1,17 @@
  -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  -    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  -
  -<html xmlns="http://www.w3.org/1999/xhtml">
  -  <head>
  -    <meta name="generator" content="HTML Tidy, see www.w3.org" />
  -
  -    <title>Definitions of terms used to describe Apache
  -    directives</title>
  -  </head>
  -  <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
  -
  -  <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
  -  vlink="#000080" alink="#FF0000">
  -    <!--#include virtual="header.html" -->
  -
  -    <h1 align="center">Terms Used to Describe Apache
  -    Directives</h1>
  -
  -    <p>Each Apache configuration directive is described using a
  -    common format that looks like this:</p>
  -
  -    <dl>
  -      <dd><a href="#Syntax" rel="Help"><strong>Syntax:</strong></a>
  -      <em>directive-name</em> <em>some args</em><br />
  -       <a href="#Default" rel="Help"><strong>Default:</strong></a>
  -      <samp><em>directive-name default-value</em></samp><br />
  -       <a href="#Context" rel="Help"><strong>Context:</strong></a>
  -      <em>context-list</em><br />
  -       <a href="#Override"
  -      rel="Help"><strong>Override:</strong></a>
  -      <em>override</em><br />
  -       <a href="#Status" rel="Help"><strong>Status:</strong></a>
  -      <em>status</em><br />
  -       <a href="#Module" rel="Help"><strong>Module:</strong></a>
  -      <em>module-name</em><br />
  -       <a href="#Compatibility"
  -      rel="Help"><strong>Compatibility:</strong></a>
  -      <em>compatibility notes</em><br />
  -       <a href="#Deprecated"
  -      rel="Help"><strong>Deprecated:</strong></a> <em>see
  -      other</em></dd>
  -    </dl>
  -
  -    <p>Each of the directive's attributes, complete with possible
  -    values where possible, are described in this document.</p>
  -
  -    <h2>Directive Terms</h2>
  -
  -    <ul>
  -      <li><a href="#Syntax">Syntax</a></li>
  -
  -      <li><a href="#Default">Default</a></li>
  -
  -      <li><a href="#Context">Context</a></li>
  -
  -      <li><a href="#Override">Override</a></li>
  -
  -      <li><a href="#Status">Status</a></li>
  -
  -      <li><a href="#Module">Module</a></li>
  -
  -      <li><a href="#Compatibility">Compatibility</a></li>
  -
  -      <li><a href="#Deprecated">Deprecated</a></li>
  -    </ul>
  -    <hr />
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  +<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  +        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  +              This file is generated from xml source: DO NOT EDIT
  +        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  +      --><title>Terms Used to Describe Directives - Apache HTTP Server</title><link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="../images/favicon.ico" rel="shortcut icon" /></head><body id="manual-page"><div id="page-header"><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="../images/feather.gif" /></div><div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.0</a></div><div id="page-content"><div id="preamble"><h1>Terms Used to Describe Directives</h1>
  +    <p>This document describes the terms that are used to describe
  +    each Apache <a href="directives.html">configuration
  +    directive</a>.</p>
  +</div><div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="##Description">Description</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Syntax">Syntax</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Default">Default</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Context">Context</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Override">Override</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Status">Status</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Module">Module</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Compatibility">Compatibility</a></li></ul><h3>See also</h3><ul class="seealso"><li><a href="../configuring.html">Configuration files</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="#Description" id="#Description">Description</a></h2>
   
  -    <h2><a id="Syntax" name="Syntax">Syntax</a></h2>
  +<p>A brief description of the purpose of the directive.</p>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Syntax" id="Syntax">Syntax</a></h2>
   
       <p>This indicates the format of the directive as it would
       appear in a configuration file. This syntax is extremely
  @@ -106,8 +51,7 @@
         with the root directory as in
         <code>/usr/local/apache/htdocs/path/to/file.html</code>.
         Unless otherwise specified, a <em>file-path</em> which does
  -      not begin with a slash will be treated as relative to the <a
  -      href="core.html#serverroot">ServerRoot</a>.</dd>
  +      not begin with a slash will be treated as relative to the <a href="core.html#serverroot">ServerRoot</a>.</dd>
   
         <dt><em>directory-path</em></dt>
   
  @@ -150,13 +94,10 @@
         <dd>The name of an <a href="../env.html">environment
         variable</a> defined in the Apache configuration process.
         Note this is not necessarily the same as an operating system
  -      environment variable. See the <a
  -      href="../env.html">environment variable documentation</a> for
  +      environment variable. See the <a href="../env.html">environment variable documentation</a> for
         more details.</dd>
       </dl>
  -    <hr />
  -
  -    <h2><a id="Default" name="Default">Default</a></h2>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Default" id="Default">Default</a></h2>
   
       <p>If the directive has a default value (<em>i.e.</em>, if you
       omit it from your configuration entirely, the Apache Web server
  @@ -165,47 +106,46 @@
       should say "<em>None</em>". Note that the default listed here
       is not necessarily the same as the value the directive takes in
       the default httpd.conf distributed with the server.</p>
  -    <hr />
  -
  -    <h2><a id="Context" name="Context">Context</a></h2>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Context" id="Context">Context</a></h2>
   
       <p>This indicates where in the server's configuration files the
       directive is legal. It's a comma-separated list of one or more
       of the following values:</p>
   
       <dl>
  -      <dt><strong>server config</strong></dt>
  +      <dt>server config</dt>
   
         <dd>This means that the directive may be used in the server
  -      configuration files (<em>e.g.</em>, <samp>httpd.conf</samp>,
  -      <samp>srm.conf</samp>, and <samp>access.conf</samp>), but
  +      configuration files (<em>e.g.</em>, <code>httpd.conf</code>), but
         <strong>not</strong> within any
  -      <samp>&lt;VirtualHost&gt;</samp> or &lt;Directory&gt;
  -      containers. It is not allowed in <samp>.htaccess</samp> files
  +      <code class="directive"><a href="../mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
  +      or <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code>
  +      containers. It is not allowed in <code>.htaccess</code> files
         at all.</dd>
   
  -      <dt><strong>virtual host</strong></dt>
  +      <dt>virtual host</dt>
   
         <dd>This context means that the directive may appear inside
  -      <samp>&lt;VirtualHost&gt;</samp> containers in the server
  +      <code class="directive"><a href="../mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
  +      containers in the server
         configuration files.</dd>
   
  -      <dt><strong>directory</strong></dt>
  +      <dt>directory</dt>
   
         <dd>A directive marked as being valid in this context may be
  -      used inside <samp>&lt;Directory&gt;</samp>,
  -      <samp>&lt;Location&gt;</samp>, and <samp>&lt;Files&gt;</samp>
  +      used inside <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code>,
  +      <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>,
  +      and <code class="directive"><a href="../mod/core.html#files">&lt;Files&gt;</a></code>
         containers in the server configuration files, subject to the
         restrictions outlined in <a href="../sections.html">How
         Directory, Location and Files sections work</a>.</dd>
   
  -      <dt><strong>.htaccess</strong></dt>
  +      <dt>.htaccess</dt>
   
         <dd>If a directive is valid in this context, it means that it
         can appear inside <em>per</em>-directory
  -      <samp>.htaccess</samp> files. It may not be processed, though
  -      depending upon the <a href="#Override"
  -      rel="Help">overrides</a> currently active.</dd>
  +      <code>.htaccess</code> files. It may not be processed, though
  +      depending upon the <a href="#Override">overrides</a> currently active.</dd>
       </dl>
   
       <p>The directive is <em>only</em> allowed within the designated
  @@ -218,32 +158,27 @@
       <p>The valid locations for the directive are actually the
       result of a Boolean OR of all of the listed contexts. In other
       words, a directive that is marked as being valid in
  -    "<samp>server config, .htaccess</samp>" can be used in the
  -    <samp>httpd.conf</samp> file and in <samp>.htaccess</samp>
  -    files, but not within any &lt;Directory&gt; or
  -    &lt;VirtualHost&gt; containers.</p>
  -    <hr />
  -
  -    <h2><a id="Override" name="Override">Override</a></h2>
  +    "<code>server config, .htaccess</code>" can be used in the
  +    <code>httpd.conf</code> file and in <code>.htaccess</code>
  +    files, but not within any <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> or
  +    <code class="directive"><a href="../mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
  +    containers.</p>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Override" id="Override">Override</a></h2>
   
       <p>This directive attribute indicates which configuration
       override must be active in order for the directive to be
  -    processed when it appears in a <samp>.htaccess</samp> file. If
  -    the directive's <a href="#Context" rel="Help">context</a>
  -    doesn't permit it to appear in <samp>.htaccess</samp> files,
  -    this attribute should say "<em>Not applicable</em>".</p>
  +    processed when it appears in a <code>.htaccess</code> file. If
  +    the directive's <a href="#Context">context</a>
  +    doesn't permit it to appear in <code>.htaccess</code> files,
  +    then no context will be listed.</p>
   
  -    <p>Overrides are activated by the <a
  -    href="core.html#allowoverride"
  -    rel="Help"><samp>AllowOverride</samp></a> directive, and apply
  +    <p>Overrides are activated by the <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> directive, and apply
       to a particular scope (such as a directory) and all
       descendants, unless further modified by other
  -    <samp>AllowOverride</samp> directives at lower levels. The
  -    documentation for that directive also lists the possible
  -    override names available.</p>
  -    <hr />
  -
  -    <h2><a id="Status" name="Status">Status</a></h2>
  +    <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> directives at
  +    lower levels. The documentation for that directive also lists the
  +    possible override names available.</p>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Status" id="Status">Status</a></h2>
   
       <p>This indicates how tightly bound into the Apache Web server
       the directive is; in other words, you may need to recompile the
  @@ -252,22 +187,21 @@
       this attribute are:</p>
   
       <dl>
  -      <dt><strong>Core</strong></dt>
  +      <dt>Core</dt>
   
         <dd>If a directive is listed as having "Core" status, that
         means it is part of the innermost portions of the Apache Web
         server, and is always available.</dd>
   
  -      <dt><strong>MPM</strong></dt>
  +      <dt>MPM</dt>
   
         <dd>A directive labeled as having "MPM" status is provided by
         a <a href="../mpm.html">Multi-Processing Module</a>. This
         type of directive will be available if and only if you are
  -      using one of the MPMs listed on the <a
  -      href="#Module">Module</a> line of the directive
  +      using one of the MPMs listed on the <a href="#Module">Module</a> line of the directive
         definition.</dd>
   
  -      <dt><strong>Base</strong></dt>
  +      <dt>Base</dt>
   
         <dd>A directive labeled as having "Base" status is supported
         by one of the standard Apache modules which is compiled into
  @@ -275,7 +209,7 @@
         unless you've taken steps to remove the module from your
         configuration.</dd>
   
  -      <dt><strong>Extension</strong></dt>
  +      <dt>Extension</dt>
   
         <dd>A directive with "Extension" status is provided by one of
         the modules included with the Apache server kit, but the
  @@ -283,7 +217,7 @@
         directive and its functionality, you will need to change the
         server build configuration files and re-compile Apache.</dd>
   
  -      <dt><strong>Experimental</strong></dt>
  +      <dt>Experimental</dt>
   
         <dd>"Experimental" status indicates that the directive is
         available as part of the Apache kit, but you're on your own
  @@ -294,34 +228,14 @@
         directive and its module to see if it remarks on the
         availability.</dd>
       </dl>
  -    <hr />
  -
  -    <h2><a id="Module" name="Module">Module</a></h2>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Module" id="Module">Module</a></h2>
   
       <p>This quite simply lists the name of the source module which
       defines the directive.</p>
  -    <hr />
  -
  -    <h2><a id="Compatibility"
  -    name="Compatibility">Compatibility</a></h2>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Compatibility" id="Compatibility">Compatibility</a></h2>
   
       <p>If the directive wasn't part of the original Apache version
  -    1 distribution, the version in which it was introduced should
  -    be listed here. If the directive has the same name as one from
  -    the NCSA HTTPd server, any inconsistencies in behavior between
  -    the two should also be mentioned. Otherwise, this attribute
  -    should say "<em>No compatibility issues.</em>"</p>
  -    <hr />
  -
  -    <h2><a id="Deprecated" name="Deprecated">Deprecated</a></h2>
  -
  -    <p>If this directive is eliminated since the Apache version 1
  -    distribution, the directive or option that replaces the
  -    behavior should be cited here. In general, directives,
  -    features, and options are only deprecated to minimize debugging
  -    of conflicting features, or if the feature can only continue to
  -    be supported in an alternate manner.</p>
  -    <!--#include virtual="footer.html" -->
  -  </body>
  -</html>
  -
  +    2 distribution, the version in which it was introduced should
  +    be listed here.  In addition, if the directive is available
  +    only on certain platforms, it will be noted here.</p>
  +</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>
  \ No newline at end of file
  
  
  
  1.7       +26 -75    httpd-2.0/docs/manual/mod/module-dict.html.en
  
  Index: module-dict.html.en
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/mod/module-dict.html.en,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -d -b -u -r1.6 -r1.7
  --- module-dict.html.en	23 May 2002 14:38:48 -0000	1.6
  +++ module-dict.html.en	6 Sep 2002 23:04:35 -0000	1.7
  @@ -1,53 +1,16 @@
  -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  -    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  -
  -<html xmlns="http://www.w3.org/1999/xhtml">
  -  <head>
  -    <meta name="generator" content="HTML Tidy, see www.w3.org" />
  -
  -    <title>Definitions of terms used to describe Apache
  -    modules</title>
  -  </head>
  -  <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
  -
  -  <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
  -  vlink="#000080" alink="#FF0000">
  -    <!--#include virtual="header.html" -->
  -
  -    <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 />
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  +<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  +        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  +              This file is generated from xml source: DO NOT EDIT
  +        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  +      --><title>Terms Used to Describe Modules - Apache HTTP Server</title><link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="../images/favicon.ico" rel="shortcut icon" /></head><body id="manual-page"><div id="page-header"><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="../images/feather.gif" /></div><div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.0</a></div><div id="page-content"><div id="preamble"><h1>Terms Used to Describe Modules</h1>
  +   <p>This document describes the terms that are used to describe
  +    each Apache <a href="./">module</a>.</p>
  +</div><div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#Description">Description</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Status">Status</a></li><li><img alt="" src="../images/down.gif" /> <a href="#SourceFile">Source File</a></li><li><img alt="" src="../images/down.gif" /> <a href="#ModuleIdentifier">Module Identifier</a></li><li><img alt="" src="../images/down.gif" /> <a href="#Compatibility">Compatibility</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Description" id="Description">Description</a></h2>
   
  -    <h2><a id="Status" name="Status">Status</a></h2>
  +<p>A brief description of the purpose of the module.</p>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Status" id="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
  @@ -55,69 +18,57 @@
       functionality. Possible values for this attribute are:</p>
   
       <dl>
  -      <dt><strong>MPM</strong></dt>
  +      <dt>MPM</dt>
   
  -      <dd>A module with status "MPM" is a <a
  -      href="../mpm.html">Multi-Processing Module</a>. Unlike the
  +      <dd>A module with status "MPM" is a <a href="../mpm.html">Multi-Processing Module</a>. Unlike the
         other types of modules, Apache must have one and only one MPM
         in use at any time. This type of module is responsible for
         basic request handling and dispatching.</dd>
   
  -      <dt><strong>Base</strong></dt>
  +      <dt>Base</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.</dd>
   
  -      <dt><strong>Extension</strong></dt>
  +      <dt>Extension</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.</dd>
   
  -      <dt><strong>Experimental</strong></dt>
  +      <dt>Experimental</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.</dd>
   
  -      <dt><strong>External</strong></dt>
  +      <dt>External</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.</dd>
       </dl>
  -    <hr />
  -
  -    <h2><a id="SourceFile" name="SourceFile">Source File</a></h2>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="SourceFile" id="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>&lt;IfModule&gt;</code></a>
  +    the <code class="directive"><a href="../mod/core.html#ifmodule">&lt;IfModule&gt;</a></code>
       directive.</p>
  -    <hr />
  -
  -    <h2><a id="ModuleIdentifier" name="ModuleIdentifier">Module
  -    Identifier</a></h2>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="ModuleIdentifier" id="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
  +    <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code> 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 id="Compatibility"
  -    name="Compatibility">Compatibility</a></h2>
  +</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="Compatibility" id="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>
  -    <!--#include virtual="footer.html" -->
  -  </body>
  -</html>
  -
  +    listed here.  In addition, if the module is limited to
  +    particular platforms, the details will be listed here.</p>
  +</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>
  \ No newline at end of file
  
  
  
  1.1                  httpd-2.0/docs/manual/mod/directive-dict.xml
  
  Index: directive-dict.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8" ?>
  <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  
  <manualpage>
    <relativepath href=".."/>
  
    <title>Terms Used to Describe Directives</title>
  
  <summary>
      <p>This document describes the terms that are used to describe
      each Apache <a href="directives.html">configuration
      directive</a>.</p>
  </summary>
  <seealso><a href="../configuring.html">Configuration files</a></seealso>
  
  <section id="#Description"><title>Description</title>
  
  <p>A brief description of the purpose of the directive.</p>
  </section>
  
  <section id="Syntax"><title>Syntax</title>
  
      <p>This indicates the format of the directive as it would
      appear in a configuration file. This syntax is extremely
      directive-specific, and is described in detail in the
      directive's definition. Generally, the directive name is
      followed by a series of one or more space-separated arguments.
      If an argument contains a space, the argument must be enclosed
      in double quotes. Optional arguments are enclosed in square
      brackets. Where an argument can take on more than one possible
      value, the possible values are separated by vertical bars "|".
      Literal text is presented in the default font, while
      argument-types for which substitution is necessary are
      <em>emphasized</em>. Directives which can take a variable
      number of arguments will end in "..." indicating that the last
      argument is repeated.</p>
  
      <p>Directives use a great number of different argument types. A
      few common ones are defined below.</p>
  
      <dl>
        <dt><em>URL</em></dt>
  
        <dd>A complete Uniform Resource Locator including a scheme,
        hostname, and optional pathname as in
        <code>http://www.example.com/path/to/file.html</code></dd>
  
        <dt><em>URL-path</em></dt>
  
        <dd>The part of a <em>url</em> which follows the scheme and
        hostname as in <code>/path/to/file.html</code>. The
        <em>url-path</em> represents a web-view of a resource, as
        opposed to a file-system view.</dd>
  
        <dt><em>file-path</em></dt>
  
        <dd>The path to a file in the local file-system beginning
        with the root directory as in
        <code>/usr/local/apache/htdocs/path/to/file.html</code>.
        Unless otherwise specified, a <em>file-path</em> which does
        not begin with a slash will be treated as relative to the <a
        href="core.html#serverroot">ServerRoot</a>.</dd>
  
        <dt><em>directory-path</em></dt>
  
        <dd>The path to a directory in the local file-system
        beginning with the root directory as in
        <code>/usr/local/apache/htdocs/path/to/</code>.</dd>
  
        <dt><em>filename</em></dt>
  
        <dd>The name of a file with no accompanying path information
        as in <code>file.html</code>.</dd>
  
        <dt><em>regex</em></dt>
  
        <dd>A regular expression, which is a way of describing a
        pattern to match in text. The directive definition will
        specify what the <em>regex</em> is matching against.</dd>
  
        <dt><em>extension</em></dt>
  
        <dd>In general, this is the part of the <em>filename</em>
        which follows the last dot. However, Apache recognizes
        multiple filename extensions, so if a <em>filename</em>
        contains more than one dot, each dot-separated part of the
        filename following the first dot is an <em>extension</em>.
        For example, the <em>filename</em> <code>file.html.en</code>
        contains two extensions: <code>.html</code> and
        <code>.en</code>. For Apache directives, you may specify
        <em>extension</em>s with or without the leading dot. In
        addition, <em>extension</em>s are not case sensitive.</dd>
  
        <dt><em>MIME-type</em></dt>
  
        <dd>A method of describing the format of a file which
        consists of a major format type and a minor format type,
        separated by a slash as in <code>text/html</code>.</dd>
  
        <dt><em>env-variable</em></dt>
  
        <dd>The name of an <a href="../env.html">environment
        variable</a> defined in the Apache configuration process.
        Note this is not necessarily the same as an operating system
        environment variable. See the <a
        href="../env.html">environment variable documentation</a> for
        more details.</dd>
      </dl>
  </section>
  
  <section id="Default"><title>Default</title>
  
      <p>If the directive has a default value (<em>i.e.</em>, if you
      omit it from your configuration entirely, the Apache Web server
      will behave as though you set it to a particular value), it is
      described here. If there is no default value, this section
      should say "<em>None</em>". Note that the default listed here
      is not necessarily the same as the value the directive takes in
      the default httpd.conf distributed with the server.</p>
  </section>
  
  <section id="Context"><title>Context</title>
  
      <p>This indicates where in the server's configuration files the
      directive is legal. It's a comma-separated list of one or more
      of the following values:</p>
  
      <dl>
        <dt>server config</dt>
  
        <dd>This means that the directive may be used in the server
        configuration files (<em>e.g.</em>, <code>httpd.conf</code>), but
        <strong>not</strong> within any
        <directive module="core" type="section">VirtualHost</directive>
        or <directive module="core" type="section">Directory</directive>
        containers. It is not allowed in <code>.htaccess</code> files
        at all.</dd>
  
        <dt>virtual host</dt>
  
        <dd>This context means that the directive may appear inside
        <directive module="core" type="section">VirtualHost</directive>
        containers in the server
        configuration files.</dd>
  
        <dt>directory</dt>
  
        <dd>A directive marked as being valid in this context may be
        used inside <directive module="core"
        type="section">Directory</directive>,
        <directive type="section" module="core">Location</directive>,
        and <directive module="core" type="section">Files</directive>
        containers in the server configuration files, subject to the
        restrictions outlined in <a href="../sections.html">How
        Directory, Location and Files sections work</a>.</dd>
  
        <dt>.htaccess</dt>
  
        <dd>If a directive is valid in this context, it means that it
        can appear inside <em>per</em>-directory
        <code>.htaccess</code> files. It may not be processed, though
        depending upon the <a href="#Override"
        >overrides</a> currently active.</dd>
      </dl>
  
      <p>The directive is <em>only</em> allowed within the designated
      context; if you try to use it elsewhere, you'll get a
      configuration error that will either prevent the server from
      handling requests in that context correctly, or will keep the
      server from operating at all -- <em>i.e.</em>, the server won't
      even start.</p>
  
      <p>The valid locations for the directive are actually the
      result of a Boolean OR of all of the listed contexts. In other
      words, a directive that is marked as being valid in
      "<code>server config, .htaccess</code>" can be used in the
      <code>httpd.conf</code> file and in <code>.htaccess</code>
      files, but not within any <directive module="core"
      type="section">Directory</directive> or
      <directive module="core" type="section">VirtualHost</directive>
      containers.</p>
  </section>
  
  <section id="Override"><title>Override</title>
  
      <p>This directive attribute indicates which configuration
      override must be active in order for the directive to be
      processed when it appears in a <code>.htaccess</code> file. If
      the directive's <a href="#Context" >context</a>
      doesn't permit it to appear in <code>.htaccess</code> files,
      then no context will be listed.</p>
  
      <p>Overrides are activated by the <directive
      module="core">AllowOverride</directive> directive, and apply
      to a particular scope (such as a directory) and all
      descendants, unless further modified by other
      <directive module="core">AllowOverride</directive> directives at
      lower levels. The documentation for that directive also lists the
      possible override names available.</p>
  </section>
  
  <section id="Status"><title>Status</title>
  
      <p>This indicates how tightly bound into the Apache Web server
      the directive is; in other words, you may need to recompile the
      server with an enhanced set of modules in order to gain access
      to the directive and its functionality. Possible values for
      this attribute are:</p>
  
      <dl>
        <dt>Core</dt>
  
        <dd>If a directive is listed as having "Core" status, that
        means it is part of the innermost portions of the Apache Web
        server, and is always available.</dd>
  
        <dt>MPM</dt>
  
        <dd>A directive labeled as having "MPM" status is provided by
        a <a href="../mpm.html">Multi-Processing Module</a>. This
        type of directive will be available if and only if you are
        using one of the MPMs listed on the <a
        href="#Module">Module</a> line of the directive
        definition.</dd>
  
        <dt>Base</dt>
  
        <dd>A directive labeled as having "Base" status is supported
        by one of the standard Apache modules which is compiled into
        the server by default, and is therefore normally available
        unless you've taken steps to remove the module from your
        configuration.</dd>
  
        <dt>Extension</dt>
  
        <dd>A directive with "Extension" status is provided by one of
        the modules included with the Apache server kit, but the
        module isn't normally compiled into the server. To enable the
        directive and its functionality, you will need to change the
        server build configuration files and re-compile Apache.</dd>
  
        <dt>Experimental</dt>
  
        <dd>"Experimental" status indicates that the directive is
        available as part of the Apache kit, but you're on your own
        if you try to use it. The directive is being documented for
        completeness, and is not necessarily supported. The module
        which provides the directive may or may not be compiled in by
        default; check the top of the page which describes the
        directive and its module to see if it remarks on the
        availability.</dd>
      </dl>
  </section>
  
  <section id="Module"><title>Module</title>
  
      <p>This quite simply lists the name of the source module which
      defines the directive.</p>
  </section>
  
  <section id="Compatibility"><title>Compatibility</title>
  
      <p>If the directive wasn't part of the original Apache version
      2 distribution, the version in which it was introduced should
      be listed here.  In addition, if the directive is available
      only on certain platforms, it will be noted here.</p>
  </section>
  
  </manualpage>
  
  
  
  
  1.1                  httpd-2.0/docs/manual/mod/module-dict.xml
  
  Index: module-dict.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8" ?>
  <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  
  <manualpage>
    <relativepath href=".."/>
  
    <title>Terms Used to Describe Modules</title>
  
  <summary>
     <p>This document describes the terms that are used to describe
      each Apache <a href="./">module</a>.</p>
  </summary>
  
  <section id="Description"><title>Description</title>
  
  <p>A brief description of the purpose of the module.</p>
  </section>
  
  <section id="Status"><title>Status</title>
  
      <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>MPM</dt>
  
        <dd>A module with status "MPM" is a <a
        href="../mpm.html">Multi-Processing Module</a>. Unlike the
        other types of modules, Apache must have one and only one MPM
        in use at any time. This type of module is responsible for
        basic request handling and dispatching.</dd>
  
        <dt>Base</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.</dd>
  
        <dt>Extension</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.</dd>
  
        <dt>Experimental</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.</dd>
  
        <dt>External</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.</dd>
      </dl>
  </section>
  
  <section id="SourceFile"><title>Source File</title>
  
      <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 <directive module="core" type="section">IfModule</directive>
      directive.</p>
  </section>
  
  <section id="ModuleIdentifier"><title>Module Identifier</title>
  
      <p>This is a string which identifies the module for use in the
      <directive module="mod_so">LoadModule</directive> directive when
      dynamically loading modules. In particular, it is the name of
      the external variable of type module in the source file.</p>
  </section>
  
  <section id="Compatibility"><title>Compatibility</title>
  
      <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.  In addition, if the module is limited to
      particular platforms, the details will be listed here.</p>
  </section>
  
  </manualpage>
  
  

Mime
View raw message