diff options
| author | Joshua Slive <slive@apache.org> | 2002-05-23 14:38:48 +0000 |
|---|---|---|
| committer | Joshua Slive <slive@apache.org> | 2002-05-23 14:38:48 +0000 |
| commit | 84ed91d97ebf2b7a090f2fc4de58e6f6ed981bc2 (patch) | |
| tree | ecfd21f6f81ac9f2581b6607facdc1bb31d51f6d | |
| parent | 4e03c0b3a83ea2aceebfd2e8394eb3c250b94cdd (diff) | |
| download | httpd-84ed91d97ebf2b7a090f2fc4de58e6f6ed981bc2.tar.gz | |
A little too fast on the fingers. I didn't mean to remove these.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@95242 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | docs/manual/mod/directive-dict.html | 327 | ||||
| -rw-r--r-- | docs/manual/mod/directive-dict.html.en | 327 | ||||
| -rw-r--r-- | docs/manual/mod/footer.html | 6 | ||||
| -rw-r--r-- | docs/manual/mod/header.html | 6 | ||||
| -rw-r--r-- | docs/manual/mod/index-bytype.html | 289 | ||||
| -rw-r--r-- | docs/manual/mod/module-dict.html | 123 | ||||
| -rw-r--r-- | docs/manual/mod/module-dict.html.en | 123 |
7 files changed, 1201 insertions, 0 deletions
diff --git a/docs/manual/mod/directive-dict.html b/docs/manual/mod/directive-dict.html new file mode 100644 index 0000000000..deedf08aca --- /dev/null +++ b/docs/manual/mod/directive-dict.html @@ -0,0 +1,327 @@ +<!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 /> + + <h2><a id="Syntax" name="Syntax">Syntax</a></h2> + + <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> + <hr /> + + <h2><a id="Default" name="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 + 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> + <hr /> + + <h2><a id="Context" name="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> + + <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 + <strong>not</strong> within any + <samp><VirtualHost></samp> or <Directory> + containers. It is not allowed in <samp>.htaccess</samp> files + at all.</dd> + + <dt><strong>virtual host</strong></dt> + + <dd>This context means that the directive may appear inside + <samp><VirtualHost></samp> containers in the server + configuration files.</dd> + + <dt><strong>directory</strong></dt> + + <dd>A directive marked as being valid in this context may be + used inside <samp><Directory></samp>, + <samp><Location></samp>, and <samp><Files></samp> + 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> + + <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> + </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 + "<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 <Directory> or + <VirtualHost> containers.</p> + <hr /> + + <h2><a id="Override" name="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> + + <p>Overrides are activated by the <a + href="core.html#allowoverride" + rel="Help"><samp>AllowOverride</samp></a> 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> + + <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><strong>Core</strong></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> + + <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><strong>Base</strong></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><strong>Extension</strong></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><strong>Experimental</strong></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> + <hr /> + + <h2><a id="Module" name="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> + + <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> + diff --git a/docs/manual/mod/directive-dict.html.en b/docs/manual/mod/directive-dict.html.en new file mode 100644 index 0000000000..deedf08aca --- /dev/null +++ b/docs/manual/mod/directive-dict.html.en @@ -0,0 +1,327 @@ +<!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 /> + + <h2><a id="Syntax" name="Syntax">Syntax</a></h2> + + <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> + <hr /> + + <h2><a id="Default" name="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 + 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> + <hr /> + + <h2><a id="Context" name="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> + + <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 + <strong>not</strong> within any + <samp><VirtualHost></samp> or <Directory> + containers. It is not allowed in <samp>.htaccess</samp> files + at all.</dd> + + <dt><strong>virtual host</strong></dt> + + <dd>This context means that the directive may appear inside + <samp><VirtualHost></samp> containers in the server + configuration files.</dd> + + <dt><strong>directory</strong></dt> + + <dd>A directive marked as being valid in this context may be + used inside <samp><Directory></samp>, + <samp><Location></samp>, and <samp><Files></samp> + 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> + + <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> + </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 + "<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 <Directory> or + <VirtualHost> containers.</p> + <hr /> + + <h2><a id="Override" name="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> + + <p>Overrides are activated by the <a + href="core.html#allowoverride" + rel="Help"><samp>AllowOverride</samp></a> 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> + + <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><strong>Core</strong></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> + + <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><strong>Base</strong></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><strong>Extension</strong></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><strong>Experimental</strong></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> + <hr /> + + <h2><a id="Module" name="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> + + <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> + diff --git a/docs/manual/mod/footer.html b/docs/manual/mod/footer.html new file mode 100644 index 0000000000..54f6044a57 --- /dev/null +++ b/docs/manual/mod/footer.html @@ -0,0 +1,6 @@ + <hr /> + + <h3 align="CENTER">Apache HTTP Server Version 2.0</h3> + <a href="./"><img src="../images/index.gif" alt="Index" /></a> + <a href="../"><img src="../images/home.gif" alt="Home" /></a> + diff --git a/docs/manual/mod/header.html b/docs/manual/mod/header.html new file mode 100644 index 0000000000..749461de9e --- /dev/null +++ b/docs/manual/mod/header.html @@ -0,0 +1,6 @@ + <div align="CENTER"> + <img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]" /> + + <h3>Apache HTTP Server Version 2.0</h3> + </div> + diff --git a/docs/manual/mod/index-bytype.html b/docs/manual/mod/index-bytype.html new file mode 100644 index 0000000000..72bb095f1d --- /dev/null +++ b/docs/manual/mod/index-bytype.html @@ -0,0 +1,289 @@ +<!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>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">Apache modules</h1> + + <p>Below is a list of all of the modules that come as part of + the Apache distribution. See also the list of modules <a + href="index.html">sorted alphabetically</a> and the complete + alphabetical list of <a href="directives.html">all Apache + directives</a>.</p> + + <h2>Core Features and Multi-Processing Modules</h2> + + <dl> + <dt><a href="core.html">core</a></dt> + <dd>Core Apache HTTP Server features that are always available</dd> + + <dt><a href="mpm_common.html">mpm_common</a></dt> + <dd>A collection of directives that are implemented by more than + one multi-processing module (MPM)</dd> + + <dt><a href="mpm_netware.html">mpm_netware</a></dt> + <dd>Multi-Processing Module implementing an exclusively threaded web + server optimized for Novell NetWare</dd> + + <dt><a href="mpm_winnt.html">mpm_winnt</a></dt> + <dd>This Multi-Processing Module is optimized for Windows NT.</dd> + + <dt><a href="perchild.html">perchild</a></dt> + <dd>Multi-Processing Module allowing for daemon processes + serving requests to be assigned a variety of different + userids</dd> + + <dt><a href="prefork.html">prefork</a></dt> + <dd>Implements a non-threaded, pre-forking web server</dd> + + <dt><a href="worker.html">worker</a></dt> + <dd>Multi-Processing Module implementing a hybrid + multi-threaded multi-process web server</dd> + </dl> + + <h2>Environment Creation</h2> + + <dl> + <dt><a href="mod_env.html">mod_env</a></dt> + + <dd>Passing of environments to CGI scripts</dd> + + <dt><a href="mod_setenvif.html">mod_setenvif</a></dt> + + <dd>Set environment variables based on client + information</dd> + + <dt><a href="mod_unique_id.html">mod_unique_id</a></dt> + + <dd>Generate unique request identifier for every request</dd> + </dl> + + <h2>Content Type Decisions</h2> + + <dl> + <dt><a href="mod_mime.html">mod_mime</a></dt> + + <dd>Determining document types using file extensions.</dd> + + <dt><a href="mod_mime_magic.html">mod_mime_magic</a></dt> + + <dd>Determining document types using "magic numbers".</dd> + + <dt><a href="mod_negotiation.html">mod_negotiation</a></dt> + + <dd>Content negotiation.</dd> + + <dt><a href="mod_charset_lite.html">mod_charset_lite</a></dt> + + <dd>Configuring character set translation.</dd> + </dl> + + <h2>URL Mapping</h2> + + <dl> + <dt><a href="mod_alias.html">mod_alias</a></dt> + + <dd>Mapping different parts of the host filesystem in the + document tree, and URL redirection.</dd> + + <dt><a href="mod_rewrite.html">mod_rewrite</a></dt> + + <dd>Powerful URI-to-filename mapping using regular + expressions</dd> + + <dt><a href="mod_userdir.html">mod_userdir</a></dt> + + <dd>User home directories.</dd> + + <dt><a href="mod_speling.html">mod_speling</a></dt> + + <dd>Automatically correct minor typos in URLs</dd> + + <dt><a href="mod_vhost_alias.html">mod_vhost_alias</a></dt> + + <dd>Support for dynamically configured mass virtual + hosting</dd> + </dl> + + <h2>Directory Handling</h2> + + <dl> + <dt><a href="mod_dir.html">mod_dir</a></dt> + + <dd>Basic directory handling.</dd> + + <dt><a href="mod_autoindex.html">mod_autoindex</a></dt> + + <dd>Automatic directory listings.</dd> + </dl> + + <h2>Access Control</h2> + + <dl> + <dt><a href="mod_access.html">mod_access</a></dt> + + <dd>Access control based on client hostname or IP + address.</dd> + + <dt><a href="mod_auth.html">mod_auth</a></dt> + + <dd>User authentication using text files.</dd> + + <dt><a href="mod_auth_dbm.html">mod_auth_dbm</a></dt> + + <dd>User authentication using DBM files.</dd> + + <dt><a href="mod_auth_anon.html">mod_auth_anon</a></dt> + + <dd>Anonymous user access to authenticated areas.</dd> + + <dt><a href="mod_auth_digest.html">mod_auth_digest</a></dt> + + <dd>MD5 authentication</dd> + + <dt><a href="mod_auth_ldap.html">mod_auth_ldap</a></dt> + + <dd>User authentication using LDAP.</dd> + </dl> + + <h2>HTTP Response</h2> + + <dl> + <dt><a href="mod_headers.html">mod_headers</a></dt> + + <dd>Add arbitrary HTTP headers to resources</dd> + + <dt><a href="mod_cern_meta.html">mod_cern_meta</a></dt> + + <dd>Support for HTTP header metafiles.</dd> + + <dt><a href="mod_expires.html">mod_expires</a></dt> + + <dd>Apply Expires: headers to resources</dd> + + <dt><a href="mod_asis.html">mod_asis</a></dt> + + <dd>Sending files which contain their own HTTP headers.</dd> + </dl> + + <h2>Dynamic Content</h2> + + <dl> + <dt><a href="mod_include.html">mod_include</a></dt> + + <dd>Server-parsed documents.</dd> + + <dt><a href="mod_cgi.html">mod_cgi</a></dt> + + <dd>Invoking CGI scripts.</dd> + + <dt><a href="mod_cgid.html">mod_cgid</a></dt> + + <dd>Invoking CGI scripts using an external daemon.</dd> + + <dt><a href="mod_actions.html">mod_actions</a></dt> + + <dd>Executing CGI scripts based on media type or request + method.</dd> + + <dt><a href="mod_isapi.html">mod_isapi</a></dt> + + <dd>Windows ISAPI Extension support</dd> + + <dt><a href="mod_ext_filter.html">mod_ext_filter</a></dt> + + <dd>Filtering content with external programs.</dd> + + <dt><a href="mod_suexec.html">mod_suexec</a></dt> + + <dd>Run CGI requests as a specified user and group.</dd> + </dl> + + <h2>Internal Content Handlers</h2> + + <dl> + <dt><a href="mod_status.html">mod_status</a></dt> + + <dd>Server status display</dd> + + <dt><a href="mod_info.html">mod_info</a></dt> + + <dd>Server configuration information</dd> + </dl> + + <h2>Logging</h2> + + <dl> + <dt><a href="mod_log_config.html">mod_log_config</a></dt> + + <dd>User-configurable logging replacement for + mod_log_common.</dd> + + <dt><a href="mod_usertrack.html">mod_usertrack</a></dt> + + <dd>User tracking using Cookies</dd> + </dl> + + <h2>Miscellaneous</h2> + + <dl> + <dt><a href="mod_imap.html">mod_imap</a></dt> + + <dd>The imagemap file handler.</dd> + + <dt><a href="mod_proxy.html">mod_proxy</a></dt> + + <dd>Caching proxy abilities</dd> + + <dt><a href="mod_so.html">mod_so</a></dt> + + <dd>Support for loading modules at runtime</dd> + + <dt><a href="mod_file_cache.html">mod_file_cache</a></dt> + + <dd>Caching files in memory for faster serving.</dd> + + <dt><a href="mod_cache.html">mod_cache</a></dt> + + <dd>Content cache keyed to URIs</dd> + + <dt><a href="mod_dav.html">mod_dav</a></dt> + + <dd>Class 1,2 <a href="http://www.webdav.org">WebDAV</a> HTTP + extensions</dd> + + <dt><a href="mod_deflate.html">mod_deflate</a></dt> + + <dd>Compression of content</dd> + + <dt><a href="mod_ssl.html">mod_ssl</a></dt> + + <dd>strong cryptography using the Secure Sockets Layer (SSL) and + Transport Layer Security (TLS) protocols</dt> + + <dt><a href="mod_ldap.html">mod_ldap</a></dt> + + <dd>LDAP connection pool and shared memory cache.</dd> + </dl> + + <h2>Development</h2> + + <dl> + <dt><a href="mod_example.html">mod_example</a></dt> + + <dd>Demonstrates Apache API</dd> + </dl> + <!--#include virtual="footer.html" --> + </body> +</html> + diff --git a/docs/manual/mod/module-dict.html b/docs/manual/mod/module-dict.html new file mode 100644 index 0000000000..5e7cadb821 --- /dev/null +++ b/docs/manual/mod/module-dict.html @@ -0,0 +1,123 @@ +<!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 /> + + <h2><a id="Status" 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>MPM</strong></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><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.</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.</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.</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.</dd> + </dl> + <hr /> + + <h2><a id="SourceFile" 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 id="ModuleIdentifier" 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 id="Compatibility" + 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> + <!--#include virtual="footer.html" --> + </body> +</html> + diff --git a/docs/manual/mod/module-dict.html.en b/docs/manual/mod/module-dict.html.en new file mode 100644 index 0000000000..5e7cadb821 --- /dev/null +++ b/docs/manual/mod/module-dict.html.en @@ -0,0 +1,123 @@ +<!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 /> + + <h2><a id="Status" 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>MPM</strong></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><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.</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.</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.</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.</dd> + </dl> + <hr /> + + <h2><a id="SourceFile" 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 id="ModuleIdentifier" 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 id="Compatibility" + 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> + <!--#include virtual="footer.html" --> + </body> +</html> + |