You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by sl...@apache.org on 2002/03/06 18:08:22 UTC
cvs commit: httpd-2.0/docs/manual/mod core.html mod_access.html mod_actions.html mod_alias.html mod_asis.html mod_auth.html mod_auth_anon.html mod_auth_dbm.html mod_auth_digest.html mod_autoindex.html mod_cern_meta.html mod_cgi.html mod_cgid.html mod_charset_lite.html mod_dav.html mod_deflate.html mod_dir.html mod_env.html mod_include.html mod_info.html mod_log_config.html mod_rewrite.html mod_setenvif.html mod_so.html mod_speling.html mod_status.html mod_suexec.html mod_unique_id.html mod_userdir.html mod_vhost_alias.html mpm_common.html mpm_winnt.html prefork.html
slive 02/03/06 09:08:21
Modified: docs/manual/mod core.html mod_access.html mod_actions.html
mod_alias.html mod_asis.html mod_auth.html
mod_auth_anon.html mod_auth_dbm.html
mod_auth_digest.html mod_autoindex.html
mod_cern_meta.html mod_cgi.html mod_cgid.html
mod_charset_lite.html mod_dav.html mod_deflate.html
mod_dir.html mod_env.html mod_include.html
mod_info.html mod_log_config.html mod_rewrite.html
mod_setenvif.html mod_so.html mod_speling.html
mod_status.html mod_suexec.html mod_unique_id.html
mod_userdir.html mod_vhost_alias.html
mpm_common.html mpm_winnt.html prefork.html
Log:
Bring the html transformations up-to-date.
Revision Changes Path
1.217 +642 -3743 httpd-2.0/docs/manual/mod/core.html
Index: core.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/core.html,v
retrieving revision 1.216
retrieving revision 1.217
diff -u -d -b -u -r1.216 -r1.217
--- core.html 19 Feb 2002 18:37:19 -0000 1.216
+++ core.html 6 Mar 2002 17:08:19 -0000 1.217
@@ -1,301 +1,45 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>core - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module core</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Core Apache HTTP Server features that are always
-available</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#acceptpathinfo">AcceptPathInfo</a>
-</li>
-<li>
-<a href="#accessfilename">AccessFileName</a>
-</li>
-<li>
-<a href="#adddefaultcharset">AddDefaultCharset</a>
-</li>
-<li>
-<a href="#addmodule">AddModule</a>
-</li>
-<li>
-<a href="#allowoverride">AllowOverride</a>
-</li>
-<li>
-<a href="#authname">AuthName</a>
-</li>
-<li>
-<a href="#authtype">AuthType</a>
-</li>
-<li>
-<a href="#contentdigest">ContentDigest</a>
-</li>
-<li>
-<a href="#defaulttype">DefaultType</a>
-</li>
-<li>
-<a href="#directory">Directory</a>
-</li>
-<li>
-<a href="#directorymatch">DirectoryMatch</a>
-</li>
-<li>
-<a href="#documentroot">DocumentRoot</a>
-</li>
-<li>
-<a href="#errordocument">ErrorDocument</a>
-</li>
-<li>
-<a href="#errorlog">ErrorLog</a>
-</li>
-<li>
-<a href="#fileetag">FileETag</a>
-</li>
-<li>
-<a href="#files">Files</a>
-</li>
-<li>
-<a href="#filesmatch">FilesMatch</a>
-</li>
-<li>
-<a href="#forcetype">ForceType</a>
-</li>
-<li>
-<a href="#hostnamelookups">HostnameLookups</a>
-</li>
-<li>
-<a href="#identitycheck">IdentityCheck</a>
-</li>
-<li>
-<a href="#ifdefine">IfDefine</a>
-</li>
-<li>
-<a href="#ifmodule">IfModule</a>
-</li>
-<li>
-<a href="#include">Include</a>
-</li>
-<li>
-<a href="#keepalive">KeepAlive</a>
-</li>
-<li>
-<a href="#keepalivetimeout">KeepAliveTimeout</a>
-</li>
-<li>
-<a href="#limit">Limit</a>
-</li>
-<li>
-<a href="#limitexcept">LimitExcept</a>
-</li>
-<li>
-<a href="#limitrequestbody">LimitRequestBody</a>
-</li>
-<li>
-<a href="#limitrequestfields">LimitRequestFields</a>
-</li>
-<li>
-<a href="#limitrequestfieldsize">LimitRequestFieldSize</a>
-</li>
-<li>
-<a href="#limitrequestline">LimitRequestLine</a>
-</li>
-<li>
-<a href="#limitxmlrequestbody">LimitXMLRequestBody</a>
-</li>
-<li>
-<a href="#location">Location</a>
-</li>
-<li>
-<a href="#locationmatch">LocationMatch</a>
-</li>
-<li>
-<a href="#loglevel">LogLevel</a>
-</li>
-<li>
-<a href="#maxkeepaliverequests">MaxKeepAliveRequests</a>
-</li>
-<li>
-<a href="#namevirtualhost">NameVirtualHost</a>
-</li>
-<li>
-<a href="#options">Options</a>
-</li>
-<li>
-<a href="#require">Require</a>
-</li>
-<li>
-<a href="#rlimitcpu">RLimitCPU</a>
-</li>
-<li>
-<a href="#rlimitmem">RLimitMEM</a>
-</li>
-<li>
-<a href="#rlimitnproc">RLimitNPROC</a>
-</li>
-<li>
-<a href="#satisfy">Satisfy</a>
-</li>
-<li>
-<a href="#scriptinterpretersource">ScriptInterpreterSource</a>
-</li>
-<li>
-<a href="#serveradmin">ServerAdmin</a>
-</li>
-<li>
-<a href="#serveralias">ServerAlias</a>
-</li>
-<li>
-<a href="#servername">ServerName</a>
-</li>
-<li>
-<a href="#serverpath">ServerPath</a>
-</li>
-<li>
-<a href="#serverroot">ServerRoot</a>
-</li>
-<li>
-<a href="#serversignature">ServerSignature</a>
-</li>
-<li>
-<a href="#servertokens">ServerTokens</a>
-</li>
-<li>
-<a href="#sethandler">SetHandler</a>
-</li>
-<li>
-<a href="#setinputfilter">SetInputFilter</a>
-</li>
-<li>
-<a href="#setoutputfilter">SetOutputFilter</a>
-</li>
-<li>
-<a href="#timeout">TimeOut</a>
-</li>
-<li>
-<a href="#usecanonicalname">UseCanonicalName</a>
-</li>
-<li>
-<a href="#virtualhost">VirtualHost</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="AcceptPathInfo">AcceptPathInfo</a> <a name="acceptpathinfo">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Controls whether requests can contain trailing pathname information</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AcceptPathInfo On|Off|Default</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AcceptPathInfo Default</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in Apache 2.0.30 and later</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
+--><title>core - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module core</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Core Apache HTTP Server features that are always
+available</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr></table></td></tr></table><h2>Directives</h2><ul><li><a href="#acceptpathinfo">AcceptPathInfo</a></li><li><a href="#accessfilename">AccessFileName</a></li><li><a href="#adddefaultcharset">AddDefaultCharset</a></li><li><a href="#addmodule">AddModule</a></li><li><a href="#allowoverride">AllowOverride</a></li><li><a href="#authname">AuthName</a></li><li><a href="#authtype">AuthType</a></li><li><a href="#contentdigest">ContentDigest</a></li><li><a href="#defaulttype">DefaultType</a></li><li><a href="#directory">Directory</a></li><li><a href="#directorymatch">DirectoryMatch</a></li><li><a href="#documentroot">DocumentRoot</a></li><li><a href="#errordocument">ErrorDocument</a></li><li><a href="#errorlog">ErrorLog</a></li><li><a href="#fileetag">FileETag</a></li><li><a href="#files">Files</a></li><li><a href="#filesmatch">FilesMatch</a></li><li><a href="#forcetype">ForceType</a></li><li><a href="#hostnamelookups">HostnameLookups</a></li><li><a href="#identitycheck">IdentityCheck</a></li><li><a href="#ifdefine">IfDefine</a></li><li><a href="#ifmodule">IfModule</a></li><li><a href="#include">Include</a></li><li><a href="#keepalive">KeepAlive</a></li><li><a href="#keepalivetimeout">KeepAliveTimeout</a></li><li><a href="#limit">Limit</a></li><li><a href="#limitexcept">LimitExcept</a></li><li><a href="#limitrequestbody">LimitRequestBody</a></li><li><a href="#limitrequestfields">LimitRequestFields</a></li><li><a href="#limitrequestfieldsize">LimitRequestFieldSize</a></li><li><a href="#limitrequestline">LimitRequestLine</a></li><li><a href="#limitxmlrequestbody">LimitXMLRequestBody</a></li><li><a href="#location">Location</a></li><li><a href="#locationmatch">LocationMatch</a></li><li><a href="#loglevel">LogLevel</a></li><li><a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></li><li><a href="#namevirtualhost">NameVirtualHost</a></li><li><a href="#options">Options</a></li><li><a href="#require">Require</a></li><li><a href="#rlimitcpu">RLimitCPU</a></li><li><a href="#rlimitmem">RLimitMEM</a></li><li><a href="#rlimitnproc">RLimitNPROC</a></li><li><a href="#satisfy">Satisfy</a></li><li><a href="#scriptinterpretersource">ScriptInterpreterSource</a></li><li><a href="#serveradmin">ServerAdmin</a></li><li><a href="#serveralias">ServerAlias</a></li><li><a href="#servername">ServerName</a></li><li><a href="#serverpath">ServerPath</a></li><li><a href="#serverroot">ServerRoot</a></li><li><a href="#serversignature">ServerSignature</a></li><li><a href="#servertokens">ServerTokens</a></li><li><a href="#sethandler">SetHandler</a></li><li><a href="#setinputfilter">SetInputFilter</a></li><li><a href="#setoutputfilter">SetOutputFilter</a></li><li><a href="#timeout">TimeOut</a></li><li><a href="#usecanonicalname">UseCanonicalName</a></li><li><a href="#virtualhost">VirtualHost</a></li></ul><hr/><h2><a name="AcceptPathInfo">AcceptPathInfo</a> <a name="acceptpathinfo">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Controls whether requests can contain trailing pathname information</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AcceptPathInfo On|Off|Default</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AcceptPathInfo Default</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in Apache 2.0.30 and later</td></tr></table></td></tr></table><usage>
-<p>This directive controls whether requests that contain trailing
+ <p>This directive controls whether requests that contain trailing
pathname information that follows an actual filename (or
non-existent file in an existing directory) will be accepted or
rejected. The trailing pathname information can be made
available to scripts in the PATH_INFO environment variable.</p>
-
-<p>For example, assume the location <code>/test/</code> points to
+ <p>For example, assume the location <code>/test/</code> points to
a directory that contains only the single file
<code>here.html</code>. Then requests for
<code>/test/here.html/more</code> and
<code>/test/nothere.html/more</code> both collect
<code>/more</code> as PATH_INFO.</p>
-
-<p>The three possible arguments for the
+ <p>The three possible arguments for the
<code class="directive">AcceptPathInfo</code> directive are:</p>
-
-<dl>
-
-<dt>
-<code>off</code>
-</dt>
-<dd>A request will only be accepted if it
+ <dl>
+ <dt><code>off</code></dt><dd>A request will only be accepted if it
maps to a literal path that exists. Therefore a request with
trailing pathname information after the true filename such as
<code>/test/here.html/more</code> in the above example will return
a 404 NOT FOUND error.</dd>
-
-<dt>
-<code>on</code>
-</dt>
-<dd>A request will be accepted if a
+ <dt><code>on</code></dt><dd>A request will be accepted if a
leading path component maps to a file that exists. The above
example <code>/test/here.html/more</code> will be accepted if
<code>/test/here.html</code> maps to a valid file.</dd>
-
-<dt>
-<code>default</code>
-</dt>
-<dd>The treatment of requests with
+ <dt><code>default</code></dt><dd>The treatment of requests with
trailing pathname information is determined by the <a href="../handler.html">handler</a> responsible for the request.
The core handler for normal files defaults to rejecting PATH_INFO.
Handlers that serve scripts, such as <a href="mod_cgi.html">cgi-script</a> and <a href="mod_isapi.html">isapi-isa</a>, generally accept PATH_INFO by
default.</dd>
+ </dl>
-</dl>
-
-
-<p>The primary purpose of the <code>AcceptPathInfo</code>
+ <p>The primary purpose of the <code>AcceptPathInfo</code>
directive is to allow you to override the handler's choice of
accepting or rejecting PATH_INFO. This override is required, for
example, when you use a <a href="../filter.html">filter</a>, such
@@ -303,142 +47,38 @@
based on PATH_INFO. The core handler would usually reject the
request, so you can use the following configuration to enable
such a script:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Files "mypaths.shtml"><br>
Options +Includes<br>
SetOutputFilter INCLUDES<br>
AcceptPathInfo on<br>
</Files>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AccessFileName">AccessFileName</a> <a name="accessfilename">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the name of the .htaccess file</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AccessFileName <em>filename</em> [<em>filename</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AccessFileName .htaccess</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>When returning a document to the client the server looks for
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="AccessFileName">AccessFileName</a> <a name="accessfilename">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the name of the .htaccess file</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AccessFileName <em>filename</em> [<em>filename</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AccessFileName .htaccess</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>When returning a document to the client the server looks for
the first existing access control file from this list of names
in every directory of the path to the document, if access
control files are enabled for that directory. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AccessFileName .acl
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>before returning the document
+ <p>before returning the document
<code>/usr/local/web/index.html</code>, the server will read
<code>/.acl</code>, <code>/usr/.acl</code>,
<code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
for directives, unless they have been disabled with</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory /><br>
AllowOverride None<br>
</Directory>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#allowoverride" class="directive">AllowOverride</a></code>
-</li>
-<li>
-<a href="../configuring.html">Configuration Files</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Specifies the default character set to be added for a
-response without an explicit character set</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddDefaultCharset On|Off|<em>charset</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AddDefaultCharset Off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
+</code></td></tr></table></blockquote>
+</usage><p><strong>See also </strong></p><ul><li><a href="#allowoverride" class="directive"><code class="directive">AllowOverride</code></a></li><li><a href="../configuring.html">Configuration Files</a></li></ul><hr/><h2><a name="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Specifies the default character set to be added for a
+response without an explicit character set</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddDefaultCharset On|Off|<em>charset</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AddDefaultCharset Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
-<p>This directive specifies the name of the character set that
+ <p>This directive specifies the name of the character set that
will be added to any response that does not have any parameter on
the content type in the HTTP headers. This will override any
character set specified in the body of the document via a
@@ -449,504 +89,162 @@
required by the directive. You can also specify an alternate
<em>charset</em> to be used. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddDefaultCharset utf-8
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AddModule">AddModule</a> <a name="addmodule">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddModule <em>module</em> [<em>module</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The server can have modules compiled in which are not
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="AddModule">AddModule</a> <a name="addmodule">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddModule <em>module</em> [<em>module</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The server can have modules compiled in which are not
actively in use. This directive can be used to enable the use
of those modules. The server comes with a pre-loaded list of
- active modules; this list can be cleared with the <code class="directive"><a href="#clearmodulelist" class="directive">ClearModuleList</a></code> directive.</p>
-
-
-<p>For example:</p>
+ active modules; this list can be cleared with the <a href="#clearmodulelist" class="directive"><code class="directive">ClearModuleList</code></a> directive.</p>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+ <p>For example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddDefaultCharset utf-8
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AllowOverride">AllowOverride</a> <a name="allowoverride">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the types of directives that are allowed in
-.htaccess files</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AllowOverride All|None|<em>directive-type</em> [<em>directive-type</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AllowOverride All</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>When the server finds an .htaccess file (as specified by <code class="directive"><a href="#accessfilename" class="directive">AccessFileName</a></code>) it needs to know
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="AllowOverride">AllowOverride</a> <a name="allowoverride">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the types of directives that are allowed in
+.htaccess files</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AllowOverride All|None|<em>directive-type</em> [<em>directive-type</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AllowOverride All</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>When the server finds an .htaccess file (as specified by <a href="#accessfilename" class="directive"><code class="directive">AccessFileName</code></a>) it needs to know
which directives declared in that file can override earlier
access information.</p>
-
-<p>When this directive is set to <code>None</code>, then
+ <p>When this directive is set to <code>None</code>, then
.htaccess files are completely ignored. In this case, the
server will not even attempt to read .htaccess files in the
filesystem.</p>
-
-<p>When this directive is set to <code>All</code>, then any
+ <p>When this directive is set to <code>All</code>, then any
directive which has the .htaccess <a href="directive-dict.html#Context">Context</a> is allowed in
.htaccess files.</p>
-
-<p>The <em>directive-type</em> can be one of the following
+ <p>The <em>directive-type</em> can be one of the following
groupings of directives.</p>
+ <dl>
+ <dt>AuthConfig</dt>
-<dl>
-
-<dt>AuthConfig</dt>
-
-
-<dd>
-
- Allow use of the authorization directives (<code class="directive"><a href="mod_auth_dbm.html#authdbmgroupfile" class="directive">AuthDBMGroupFile</a></code>,
- <code class="directive"><a href="mod_auth_dbm.html#authdbmuserfile" class="directive">AuthDBMUserFile</a></code>,
- <code class="directive"><a href="mod_auth.html#authgroupfile" class="directive">AuthGroupFile</a></code>,
- <code class="directive"><a href="#authname" class="directive">AuthName</a></code>,
- <code class="directive"><a href="#authtype" class="directive">AuthType</a></code>, <code class="directive"><a href="mod_auth.html#authuserfile" class="directive">AuthUserFile</a></code>, <code class="directive"><a href="#require" class="directive">Require</a></code>, <em>etc.</em>).</dd>
-
+ <dd>
-<dt>FileInfo</dt>
+ Allow use of the authorization directives (<a href="mod_auth_dbm.html#authdbmgroupfile" class="directive"><code class="directive">AuthDBMGroupFile</code></a>,
+ <a href="mod_auth_dbm.html#authdbmuserfile" class="directive"><code class="directive">AuthDBMUserFile</code></a>,
+ <a href="mod_auth.html#authgroupfile" class="directive"><code class="directive">AuthGroupFile</code></a>,
+ <a href="#authname" class="directive"><code class="directive">AuthName</code></a>,
+ <a href="#authtype" class="directive"><code class="directive">AuthType</code></a>, <a href="mod_auth.html#authuserfile" class="directive"><code class="directive">AuthUserFile</code></a>, <a href="#require" class="directive"><code class="directive">Require</code></a>, <em>etc.</em>).</dd>
+ <dt>FileInfo</dt>
-<dd>
- Allow use of the directives controlling document types (<code class="directive"><a href="#defaulttype" class="directive">DefaultType</a></code>, <code class="directive"><a href="#errordocument" class="directive">ErrorDocument</a></code>, <code class="directive"><a href="#forcetype" class="directive">ForceType</a></code>, <code class="directive"><a href="mod_negotiation.html#languagepriority" class="directive">LanguagePriority</a></code>,
- <code class="directive"><a href="#sethandler" class="directive">SetHandler</a></code>, <code class="directive"><a href="#setinputfilter" class="directive">SetInputFilter</a></code>, <code class="directive"><a href="#setoutputfilter" class="directive">SetOutputFilter</a></code>, and
+ <dd>
+ Allow use of the directives controlling document types (<a href="#defaulttype" class="directive"><code class="directive">DefaultType</code></a>, <a href="#errordocument" class="directive"><code class="directive">ErrorDocument</code></a>, <a href="#forcetype" class="directive"><code class="directive">ForceType</code></a>, <a href="mod_negotiation.html#languagepriority" class="directive"><code class="directive">LanguagePriority</code></a>,
+ <a href="#sethandler" class="directive"><code class="directive">SetHandler</code></a>, <a href="#setinputfilter" class="directive"><code class="directive">SetInputFilter</code></a>, <a href="#setoutputfilter" class="directive"><code class="directive">SetOutputFilter</code></a>, and
<code><a href="mod_mime.html">mod_mime</a></code> Add* and Remove*
directives, <em>etc.</em>).</dd>
+ <dt>Indexes</dt>
-<dt>Indexes</dt>
-
-
-<dd>
+ <dd>
Allow use of the directives controlling directory indexing
- (<code class="directive"><a href="mod_autoindex.html#adddescription" class="directive">AddDescription</a></code>,
- <code class="directive"><a href="mod_autoindex.html#addicon" class="directive">AddIcon</a></code>, <code class="directive"><a href="mod_autoindex.html#addiconbyencoding" class="directive">AddIconByEncoding</a></code>,
- <code class="directive"><a href="mod_autoindex.html#addiconbytype" class="directive">AddIconByType</a></code>,
- <code class="directive"><a href="mod_autoindex.html#defaulticon" class="directive">DefaultIcon</a></code>, <code class="directive"><a href="mod_dir.html#directoryindex" class="directive">DirectoryIndex</a></code>, <code class="directive"><a href="mod_autoindex.html#fancyindexing" class="directive">FancyIndexing</a></code>, <code class="directive"><a href="mod_autoindex.html#headername" class="directive">HeaderName</a></code>, <code class="directive"><a href="mod_autoindex.html#indexignore" class="directive">IndexIgnore</a></code>, <code class="directive"><a href="mod_autoindex.html#indexoptions" class="directive">IndexOptions</a></code>, <code class="directive"><a href="mod_autoindex.html#readmename" class="directive">ReadmeName</a></code>,
+ (<a href="mod_autoindex.html#adddescription" class="directive"><code class="directive">AddDescription</code></a>,
+ <a href="mod_autoindex.html#addicon" class="directive"><code class="directive">AddIcon</code></a>, <a href="mod_autoindex.html#addiconbyencoding" class="directive"><code class="directive">AddIconByEncoding</code></a>,
+ <a href="mod_autoindex.html#addiconbytype" class="directive"><code class="directive">AddIconByType</code></a>,
+ <a href="mod_autoindex.html#defaulticon" class="directive"><code class="directive">DefaultIcon</code></a>, <a href="mod_dir.html#directoryindex" class="directive"><code class="directive">DirectoryIndex</code></a>, <a href="mod_autoindex.html#fancyindexing" class="directive"><code class="directive">FancyIndexing</code></a>, <a href="mod_autoindex.html#headername" class="directive"><code class="directive">HeaderName</code></a>, <a href="mod_autoindex.html#indexignore" class="directive"><code class="directive">IndexIgnore</code></a>, <a href="mod_autoindex.html#indexoptions" class="directive"><code class="directive">IndexOptions</code></a>, <a href="mod_autoindex.html#readmename" class="directive"><code class="directive">ReadmeName</code></a>,
<em>etc.</em>).</dd>
+ <dt>Limit</dt>
-<dt>Limit</dt>
-
-
-<dd>
- Allow use of the directives controlling host access (<code class="directive"><a href="mod_access.html#allow" class="directive">Allow</a></code>, <code class="directive"><a href="mod_access.html#deny" class="directive">Deny</a></code> and <code class="directive"><a href="mod_access.html#order" class="directive">Order</a></code>).</dd>
-
-
-<dt>Options</dt>
+ <dd>
+ Allow use of the directives controlling host access (<a href="mod_access.html#allow" class="directive"><code class="directive">Allow</code></a>, <a href="mod_access.html#deny" class="directive"><code class="directive">Deny</code></a> and <a href="mod_access.html#order" class="directive"><code class="directive">Order</code></a>).</dd>
+ <dt>Options</dt>
-<dd>
+ <dd>
Allow use of the directives controlling specific directory
- features (<code class="directive"><a href="#options" class="directive">Options</a></code> and
- <code class="directive"><a href="mod_include.html#xbithack" class="directive">XBitHack</a></code>).</dd>
-
-</dl>
-
-
-<p>Example:</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>AllowOverride AuthConfig Indexes</code></td>
-</tr>
-</table>
-</blockquote>
+ features (<a href="#options" class="directive"><code class="directive">Options</code></a> and
+ <a href="mod_include.html#xbithack" class="directive"><code class="directive">XBitHack</code></a>).</dd>
+ </dl>
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#accessfilename" class="directive">AccessFileName</a></code>
-</li>
-<li>
-<a href="../configuring.html">Configuration Files</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="AuthName">AuthName</a> <a name="authname">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the authorization realm for use in HTTP
-authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthName <em>auth-domain</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
+ <p>Example:</p>
-<p>This directive sets the name of the authorization realm for a
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AllowOverride AuthConfig Indexes</code></td></tr></table></blockquote>
+</usage><p><strong>See also </strong></p><ul><li><a href="#accessfilename" class="directive"><code class="directive">AccessFileName</code></a></li><li><a href="../configuring.html">Configuration Files</a></li></ul><hr/><h2><a name="AuthName">AuthName</a> <a name="authname">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the authorization realm for use in HTTP
+authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthName <em>auth-domain</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive sets the name of the authorization realm for a
directory. This realm is given to the client so that the user
knows which username and password to send.
<code class="directive">AuthName</code> takes a single argument; if the
realm name contains spaces, it must be enclosed in quotation
- marks. It must be accompanied by <code class="directive"><a href="#authtype" class="directive">AuthType</a></code> and <code class="directive"><a href="#require" class="directive">Require</a></code> directives, and directives such
- as <code class="directive"><a href="mod_auth.html#authuserfile" class="directive">AuthUserFile</a></code> and
- <code class="directive"><a href="mod_auth.html#authgroupfile" class="directive">AuthGroupFile</a></code> to
+ marks. It must be accompanied by <a href="#authtype" class="directive"><code class="directive">AuthType</code></a> and <a href="#require" class="directive"><code class="directive">Require</code></a> directives, and directives such
+ as <a href="mod_auth.html#authuserfile" class="directive"><code class="directive">AuthUserFile</code></a> and
+ <a href="mod_auth.html#authgroupfile" class="directive"><code class="directive">AuthGroupFile</code></a> to
work.</p>
+ <p>For example:</p>
-<p>For example:</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>AuthName "Top Secret"</code></td>
-</tr>
-</table>
-</blockquote>
-
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AuthName "Top Secret"</code></td></tr></table></blockquote>
-<p>The string provided for the <code>AuthRealm</code> is what will
+ <p>The string provided for the <code>AuthRealm</code> is what will
appear in the password dialog provided by most browsers.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../howto/auth.html">Authentication, Authorization, and
- Access Control</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="AuthType">AuthType</a> <a name="authtype">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Selects the type of user authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthType Basic|Digest</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive selects the type of user authentication for a
+</usage><p><strong>See also </strong></p><ul><li><a href="../howto/auth.html">Authentication, Authorization, and
+ Access Control</a></li></ul><hr/><h2><a name="AuthType">AuthType</a> <a name="authtype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Selects the type of user authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthType Basic|Digest</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive selects the type of user authentication for a
directory. Only <code>Basic</code> and <code>Digest</code> are
currently implemented.
- It must be accompanied by <code class="directive"><a href="#authname" class="directive">AuthName</a></code> and <code class="directive"><a href="#require" class="directive">Require</a></code> directives, and directives such
- as <code class="directive"><a href="mod_auth.html#authuserfile" class="directive">AuthUserFile</a></code> and
- <code class="directive"><a href="mod_auth.html#authgroupfile" class="directive">AuthGroupFile</a></code> to
+ It must be accompanied by <a href="#authname" class="directive"><code class="directive">AuthName</code></a> and <a href="#require" class="directive"><code class="directive">Require</code></a> directives, and directives such
+ as <a href="mod_auth.html#authuserfile" class="directive"><code class="directive">AuthUserFile</code></a> and
+ <a href="mod_auth.html#authgroupfile" class="directive"><code class="directive">AuthGroupFile</code></a> to
work.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../howto/auth.html">Authentication, Authorization,
-and Access Control</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="ContentDigest">ContentDigest</a> <a name="contentdigest">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Enables the generation of Content-MD5 HTTP Response
-headers</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ContentDigest on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ContentDigest off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in Apache 1.1 and later</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive enables the generation of
+</usage><p><strong>See also </strong></p><ul><li><a href="../howto/auth.html">Authentication, Authorization,
+and Access Control</a></li></ul><hr/><h2><a name="ContentDigest">ContentDigest</a> <a name="contentdigest">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enables the generation of Content-MD5 HTTP Response
+headers</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ContentDigest on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ContentDigest off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in Apache 1.1 and later</td></tr></table></td></tr></table><usage>
+ <p>This directive enables the generation of
<code>Content-MD5</code> headers as defined in RFC1864
respectively RFC2068.</p>
-
-<p>MD5 is an algorithm for computing a "message digest"
+ <p>MD5 is an algorithm for computing a "message digest"
(sometimes called "fingerprint") of arbitrary-length data, with
a high degree of confidence that any alterations in the data
will be reflected in alterations in the message digest.</p>
-
-<p>The <code>Content-MD5</code> header provides an end-to-end
+ <p>The <code>Content-MD5</code> header provides an end-to-end
message integrity check (MIC) of the entity-body. A proxy or
client may check this header for detecting accidental
modification of the entity-body in transit. Example header:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>Note that this can cause performance problems on your server
+ <p>Note that this can cause performance problems on your server
since the message digest is computed on every request (the
values are not cached).</p>
-
-<p>
-<code>Content-MD5</code> is only sent for documents served
+ <p><code>Content-MD5</code> is only sent for documents served
by the core, and not by any module. For example, SSI documents,
output from CGI scripts, and byte range responses do not have
this header.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="DefaultType">DefaultType</a> <a name="defaulttype">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the MIME content-type that will be sent if the
-server cannot determine a type in any other way</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>DefaultType <em>MIME-type</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DefaultType text/html</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>There will be times when the server is asked to provide a
+</usage><hr/><h2><a name="DefaultType">DefaultType</a> <a name="defaulttype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the MIME content-type that will be sent if the
+server cannot determine a type in any other way</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DefaultType <em>MIME-type</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DefaultType text/html</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>There will be times when the server is asked to provide a
document whose type cannot be determined by its MIME types
mappings.</p>
-
-<p>The server must inform the client of the content-type of the
+ <p>The server must inform the client of the content-type of the
document, so in the event of an unknown type it uses the
<code>DefaultType</code>. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<code>DefaultType image/gif</code>
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
would be appropriate for a directory which contained many gif
images with filenames missing the .gif extension.
- <p>Note that unlike <code class="directive"><a href="#forcetype" class="directive">ForceType</a></code>, this directive is only
+ <p>Note that unlike <a href="#forcetype" class="directive"><code class="directive">ForceType</code></a>, this directive is only
provides the default mime-type. All other mime-type definitions,
including filename extensions, that might identify the media type
will override this default.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Directory"><Directory></a> <a name="directory">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Enclose a group of directives that apply only to the
-named file-system directory and sub-directories</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><Directory <em>directory-path</em>>
-... </Directory></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<code class="directive"><Directory></code> and
+</usage><hr/><h2><a name="Directory"><Directory></a> <a name="directory">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enclose a group of directives that apply only to the
+named file-system directory and sub-directories</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><Directory <em>directory-path</em>>
+... </Directory></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p><code class="directive"><Directory></code> and
<code></Directory></code> are used to enclose a group of
directives which will apply only to the named directory and
sub-directories of that directory. Any directive which is allowed
@@ -957,34 +255,18 @@
also use `[]' character ranges like in the shell. Also as of
Apache 1.3 none of the wildcards match a `/' character, which more
closely mimics the behavior of Unix shells. Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory /usr/local/httpd/htdocs><br>
Options Indexes FollowSymLinks<br>
</Directory><br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>Extended regular
+ <p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory ~ "^/www/.*/[0-9]{3}">
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
would match directories in /www/ that consisted of three
numbers.
@@ -994,345 +276,141 @@
first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example,
with</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory /><br>
AllowOverride None<br>
</Directory><br>
-
-<br>
+ <br>
<Directory /home/*><br>
AllowOverride FileInfo<br>
</Directory>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>for access to the document <code>/home/web/dir/doc.html</code>
+</code></td></tr></table></blockquote>
+ <p>for access to the document <code>/home/web/dir/doc.html</code>
the steps are:</p>
-
-<ul>
-
-<li>Apply directive <code>AllowOverride None</code>
+ <ul>
+ <li>Apply directive <code>AllowOverride None</code>
(disabling <code>.htaccess</code> files).</li>
-
-<li>Apply directive <code>AllowOverride FileInfo</code> (for
+ <li>Apply directive <code>AllowOverride FileInfo</code> (for
directory <code>/home/web</code>).</li>
+ <li>Apply any FileInfo directives in
+ <code>/home/web/.htaccess</code></li>
+ </ul>
-<li>Apply any FileInfo directives in
- <code>/home/web/.htaccess</code>
-</li>
-
-</ul>
-
-
-<p>Regular expressions are not considered until after all of the
+ <p>Regular expressions are not considered until after all of the
normal sections have been applied. Then all of the regular
expressions are tested in the order they appeared in the
configuration file. For example, with</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code><Directory ~ abc$><br>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code><Directory ~ abc$><br>
... directives here ...<br>
</Directory><br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>The regular expression section won't be considered until after
+ <p>The regular expression section won't be considered until after
all normal <Directory>s and <code>.htaccess</code> files
have been applied. Then the regular expression will match on
<code>/home/abc/public_html/abc</code> and be applied.</p>
-
-<p>
-<strong>Note that the default Apache access for
+ <p><strong>Note that the default Apache access for
<Directory /> is <samp>Allow from All</samp>. This means
that Apache will serve any file mapped from an URL. It is
recommended that you change this with a block such
- as</strong>
-</p>
-
+ as</strong></p>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory /><br>
Order Deny,Allow<br>
Deny from All<br>
</Directory>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>
-<strong>and then override this for directories you
+ <p><strong>and then override this for directories you
<em>want</em> accessible. See the <a href="../misc/security_tips.html">Security Tips</a> page for more
- details.</strong>
-</p>
-
+ details.</strong></p>
-<p>The directory sections typically occur in
+ <p>The directory sections typically occur in
the access.conf file, but they may appear in any configuration
file. <code class="directive"><Directory></code> directives
- cannot nest, and cannot appear in a <code class="directive"><a href="#limit" class="directive"><Limit></a></code> or <code class="directive"><a href="#limitexcept" class="directive"><LimitExcept></a></code> section.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../sections.html">How
+ cannot nest, and cannot appear in a <a href="#limit" class="directive"><code class="directive"><Limit></code></a> or <a href="#limitexcept" class="directive"><code class="directive"><LimitExcept></code></a> section.</p>
+</usage><p><strong>See also </strong></p><ul><li><a href="../sections.html">How
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</li>
-</ul>
-<hr>
-<h2>
-<a name="DirectoryMatch"><DirectoryMatch></a> <a name="directorymatch">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Enclose a group of directives that apply only to
+ request is received</li></ul><hr/><h2><a name="DirectoryMatch"><DirectoryMatch></a> <a name="directorymatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enclose a group of directives that apply only to
file-system directories that match a regular expression and their
-subdirectories</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><Directory <em>regex</em>>
-... </Directory></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<code class="directive"><DirectoryMatch></code> and
+subdirectories</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><Directory <em>regex</em>>
+... </Directory></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p><code class="directive"><DirectoryMatch></code> and
<code></DirectoryMatch></code> are used to enclose a group
of directives which will apply only to the named directory and
- sub-directories of that directory, the same as <code class="directive"><a href="#directory" class="directive"><Directory></a></code>. However, it
+ sub-directories of that directory, the same as <a href="#directory" class="directive"><code class="directive"><Directory></code></a>. However, it
takes as an argument a regular expression. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<DirectoryMatch "^/www/.*/[0-9]{3}">
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>would match directories in <code>/www/</code> that consisted of three
+ <p>would match directories in <code>/www/</code> that consisted of three
numbers.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#directory" class="directive"><Directory></a></code> for
+</usage><p><strong>See also </strong></p><ul><li><a href="#directory" class="directive"><code class="directive"><Directory></code></a> for
a description of how regular expressions are mixed in with normal
-<code><Directory></code>s</li>
-<li>
-<a href="../sections.html">How Directory, Location and Files sections
+<code><Directory></code>s</li><li><a href="../sections.html">How Directory, Location and Files sections
work</a> for an explanation of how these different sections are
-combined when a request is received</li>
-</ul>
-<hr>
-<h2>
-<a name="DocumentRoot">DocumentRoot</a> <a name="documentroot">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the directory that forms the main document tree visible
-from the web</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>DocumentRoot <em>directory-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DocumentRoot /usr/local/apache/htdocs</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive sets the directory from which httpd will
+combined when a request is received</li></ul><hr/><h2><a name="DocumentRoot">DocumentRoot</a> <a name="documentroot">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the directory that forms the main document tree visible
+from the web</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DocumentRoot <em>directory-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DocumentRoot /usr/local/apache/htdocs</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive sets the directory from which httpd will
serve files. Unless matched by a directive like Alias, the
server appends the path from the requested URL to the document
root to make the path to the document. Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
DocumentRoot /usr/web
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>then an access to
+</code></td></tr></table></blockquote>
+ <p>then an access to
<code>http://www.my.host.com/index.html</code> refers to
<code>/usr/web/index.html</code>.</p>
-
-<p>The <code class="directive">DocumentRoot</code> should be specified without
+ <p>The <code class="directive">DocumentRoot</code> should be specified without
a trailing slash.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../urlmapping.html">Mapping URLs to Filesystem
-Location</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="ErrorDocument">ErrorDocument</a> <a name="errordocument">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Specifies what the server will return to the client
-in case of an error</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ErrorDocument <em>error-code document</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Quoting syntax for text messages is different in Apache
-2.0</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>In the event of a problem or error, Apache can be configured
+</usage><p><strong>See also </strong></p><ul><li><a href="../urlmapping.html">Mapping URLs to Filesystem
+Location</a></li></ul><hr/><h2><a name="ErrorDocument">ErrorDocument</a> <a name="errordocument">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Specifies what the server will return to the client
+in case of an error</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ErrorDocument <em>error-code document</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Quoting syntax for text messages is different in Apache
+2.0</td></tr></table></td></tr></table><usage>
+ <p>In the event of a problem or error, Apache can be configured
to do one of four things,</p>
+ <ol>
+ <li>output a simple hardcoded error message</li>
-<ol>
-
-<li>output a simple hardcoded error message</li>
-
-
-<li>output a customized message</li>
-
+ <li>output a customized message</li>
-<li>redirect to a local <em>URL-path</em> to handle the
+ <li>redirect to a local <em>URL-path</em> to handle the
problem/error</li>
-
-<li>redirect to an external <em>URL</em> to handle the
+ <li>redirect to an external <em>URL</em> to handle the
problem/error</li>
+ </ol>
-</ol>
-
-
-<p>The first option is the default, while options 2-4 are
+ <p>The first option is the default, while options 2-4 are
configured using the <code class="directive">ErrorDocument</code>
directive, which is followed by the HTTP response code and a URL
or a message. Apache will sometimes offer additional information
regarding the problem/error.</p>
-
-<p>URLs can begin with a slash (/) for local URLs, or be a full
+ <p>URLs can begin with a slash (/) for local URLs, or be a full
URL which the client can resolve. Alternatively, a message can
be provided to be displayed by the browser. Examples:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
ErrorDocument 500
http://foo.example.com/cgi-bin/tester<br>
ErrorDocument 404 /cgi-bin/bad_urls.pl<br>
ErrorDocument 401 /subscription_info.html<br>
ErrorDocument 403 "Sorry can't allow you access
today"
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>Note that when you specify an <code class="directive">ErrorDocument</code>
+ <p>Note that when you specify an <code class="directive">ErrorDocument</code>
that points to a remote URL (ie. anything with a method such as
"http" in front of it), Apache will send a redirect to the
client to tell it where to find the document, even if the
@@ -1346,128 +424,35 @@
know to prompt the user for a password since it will not
receive the 401 status code. Therefore, <strong>if you use an
"ErrorDocument 401" directive then it must refer to a local
- document.</strong>
-</p>
-
+ document.</strong></p>
-<p>Prior to version 2.0, messages were indicated by prefixing
+ <p>Prior to version 2.0, messages were indicated by prefixing
them with a single unmatched double quote character.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../custom-error.html">documentation of
- customizable responses</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="ErrorLog">ErrorLog</a> <a name="errorlog">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the name of the file to which the server
-will log errors</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax> ErrorLog <em>file-path</em>|syslog[:<em>facility</em>]</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ErrorLog logs/error_log (Unix)
-ErrorLog logs/error.log (Windows and OS/2)</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ErrorLog</code> directive sets the name of
+</usage><p><strong>See also </strong></p><ul><li><a href="../custom-error.html">documentation of
+ customizable responses</a></li></ul><hr/><h2><a name="ErrorLog">ErrorLog</a> <a name="errorlog">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the name of the file to which the server
+will log errors</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax> ErrorLog <em>file-path</em>|syslog[:<em>facility</em>]</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ErrorLog logs/error_log (Unix)
+ErrorLog logs/error.log (Windows and OS/2)</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ErrorLog</code> directive sets the name of
the file to which the server will log any errors it encounters. If
the <em>file-path</em> does not begin with a slash (/) then it is
- assumed to be relative to the <code class="directive"><a href="#serverroot" class="directive">ServerRoot</a></code>. If the <em>file-path</em>
+ assumed to be relative to the <a href="#serverroot" class="directive"><code class="directive">ServerRoot</code></a>. If the <em>file-path</em>
begins with a pipe (|) then it is assumed to be a command to spawn
to handle the error log.</p>
-
-<p>Using <code>syslog</code> instead of a filename enables logging
+ <p>Using <code>syslog</code> instead of a filename enables logging
via syslogd(8) if the system supports it. The default is to use
syslog facility <code>local7</code>, but you can override this by
using the <code>syslog:</code><em>facility</em> syntax where
<em>facility</em> can be one of the names usually documented in
syslog(1).</p>
-
-<p>SECURITY: See the <a href="../misc/security_tips.html#serverroot">security tips</a>
+ <p>SECURITY: See the <a href="../misc/security_tips.html#serverroot">security tips</a>
document for details on why your security could be compromised
if the directory where logfiles are stored is writable by
anyone other than the user that starts the server.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#loglevel" class="directive">LogLevel</a></code>
-</li>
-<li>
-<a href="../logs.html">Apache Log Files</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="FileETag">FileETag</a> <a name="fileetag">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Configures the file attributes used to create the ETag
-HTTP response header</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>FileETag <em>component</em> ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
+</usage><p><strong>See also </strong></p><ul><li><a href="#loglevel" class="directive"><code class="directive">LogLevel</code></a></li><li><a href="../logs.html">Apache Log Files</a></li></ul><hr/><h2><a name="FileETag">FileETag</a> <a name="fileetag">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures the file attributes used to create the ETag
+HTTP response header</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>FileETag <em>component</em> ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>
The <code class="directive">FileETag</code> directive configures the file
attributes that are used to create the ETag (entity tag) response
header field when the document is based on a file. (The ETag
@@ -1477,52 +462,28 @@
FileETag directive allows you to choose which of these -- if any
-- should be used. The recognized keywords are:
</p>
-
-<dl compact="compact">
-
-<dt>
-<b>INode</b>
-</dt>
-
-<dd>The file's i-node number will be included in the calculation</dd>
-
-<dt>
-<b>MTime</b>
-</dt>
-
-<dd>The date and time the file was last modified will be included</dd>
-
-<dt>
-<b>Size</b>
-</dt>
-
-<dd>The number of bytes in the file will be included</dd>
-
-<dt>
-<b>All</b>
-</dt>
-
-<dd>All available fields will be used (equivalent to
+ <dl compact="compact">
+ <dt><b>INode</b></dt>
+ <dd>The file's i-node number will be included in the calculation</dd>
+ <dt><b>MTime</b></dt>
+ <dd>The date and time the file was last modified will be included</dd>
+ <dt><b>Size</b></dt>
+ <dd>The number of bytes in the file will be included</dd>
+ <dt><b>All</b></dt>
+ <dd>All available fields will be used (equivalent to
'<code>FileETag INode MTime Size</code>')</dd>
-
-<dt>
-<b>None</b>
-</dt>
-
-<dd>If a document is file-based, no ETag field will be included in the
+ <dt><b>None</b></dt>
+ <dd>If a document is file-based, no ETag field will be included in the
response</dd>
-
-</dl>
-
-<p>
+ </dl>
+ <p>
The INode, MTime, and Size keywords may be prefixed with either '+'
or '-', which allow changes to be made to the default setting
inherited from a broader scope. Any keyword appearing without
such a prefix immediately and completely cancels the inherited
setting.
</p>
-
-<p>
+ <p>
If a directory's configuration includes
'<code>FileETag INode MTime Size</code>', and a
subdirectory's includes '<code>FileETag -INode</code>',
@@ -1530,249 +491,74 @@
any sub-subdirectories that don't override it) will be equivalent to
'<code>FileETag MTime Size</code>'.
</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Files"><Files></a> <a name="files">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Contains that directives that apply to matched
-filenames</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><Files <em>filename</em>> ... </Files></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive"><Files></code> directive
+</usage><hr/><h2><a name="Files"><Files></a> <a name="files">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Contains that directives that apply to matched
+filenames</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><Files <em>filename</em>> ... </Files></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive"><Files></code> directive
provides for access control by filename. It is comparable to the
- <code class="directive"><a href="#directory" class="directive">Directory</a></code>
- directive and <code class="directive"><a href="#location" class="directive">Location</a></code> directives. It should be
+ <a href="#directory" class="directive"><code class="directive">Directory</code></a>
+ directive and <a href="#location" class="directive"><code class="directive">Location</code></a> directives. It should be
matched with a <code></Files></code> directive. The
directives given within this section will be applied to any object
with a basename (last component of filename) matching the
specified filename. <code class="directive"><Files></code>
sections are processed in the order they appear in the
- configuration file, after the <code class="directive"><a href="#directory" class="directive"><Directory></a></code> sections and
- <code>.htaccess</code> files are read, but before <code class="directive"><a href="#location" class="directive"><Location></a></code> sections. Note
+ configuration file, after the <a href="#directory" class="directive"><code class="directive"><Directory></code></a> sections and
+ <code>.htaccess</code> files are read, but before <a href="#location" class="directive"><code class="directive"><Location></code></a> sections. Note
that <code class="directive"><Files></code> can be nested
- inside <code class="directive"><a href="#directory" class="directive"><Directory></a></code> sections to restrict the
+ inside <a href="#directory" class="directive"><code class="directive"><Directory></code></a> sections to restrict the
portion of the filesystem they apply to.</p>
-
-<p>The <em>filename</em> argument should include a filename, or
+ <p>The <em>filename</em> argument should include a filename, or
a wild-card string, where `?' matches any single character, and
`*' matches any sequences of characters. Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Files ~ "\.(gif|jpe?g|png)$">
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>would match most common Internet graphics formats. In Apache 1.3
- and later, <code class="directive"><a href="#filesmatch" class="directive"><FilesMatch></a></code> is preferred, however.</p>
-
+</code></td></tr></table></blockquote>
+ <p>would match most common Internet graphics formats. In Apache 1.3
+ and later, <a href="#filesmatch" class="directive"><code class="directive"><FilesMatch></code></a> is preferred, however.</p>
-<p>Note that unlike <code class="directive"><a href="#directory" class="directive"><Directory></a></code> and <code class="directive"><a href="#location" class="directive"><Location></a></code> sections, <code class="directive"><Files></code> sections can be used inside
+ <p>Note that unlike <a href="#directory" class="directive"><code class="directive"><Directory></code></a> and <a href="#location" class="directive"><code class="directive"><Location></code></a> sections, <code class="directive"><Files></code> sections can be used inside
.htaccess files. This allows users to control access to their own
files, at a file-by-file level.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../sections.html">How
+</usage><p><strong>See also </strong></p><ul><li><a href="../sections.html">How
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</li>
-</ul>
-<hr>
-<h2>
-<a name="FilesMatch"><FilesMatch></a> <a name="filesmatch">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Contains that directives that apply to regular-expression matched
-filenames</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><FilesMatch <em>regex</em>> ... </FilesMatch></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive"><FilesMatch></code> directive
- provides for access control by filename, just as the <code class="directive"><a href="#files" class="directive"><Files></a></code> directive
+ request is received</li></ul><hr/><h2><a name="FilesMatch"><FilesMatch></a> <a name="filesmatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Contains that directives that apply to regular-expression matched
+filenames</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><FilesMatch <em>regex</em>> ... </FilesMatch></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive"><FilesMatch></code> directive
+ provides for access control by filename, just as the <a href="#files" class="directive"><code class="directive"><Files></code></a> directive
does. However, it accepts a regular expression. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<FilesMatch "\.(gif|jpe?g|png)$">
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>would match most common Internet graphics formats.</p>
+</code></td></tr></table></blockquote>
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../sections.html">How
+ <p>would match most common Internet graphics formats.</p>
+</usage><p><strong>See also </strong></p><ul><li><a href="../sections.html">How
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</li>
-</ul>
-<hr>
-<h2>
-<a name="ForceType">ForceType</a> <a name="forcetype">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Forces all matching files to be served with the specified
-MIME content-type</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ForceType <em>mime-type</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved to the core in Apache 2.0</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>When placed into an <code>.htaccess</code> file or a
- <code class="directive"><a href="#directory" class="directive"><Directory></a></code>, or
- <code class="directive"><a href="#location" class="directive"><Location></a></code> or
- <code class="directive"><a href="#files" class="directive"><Files></a></code>
+ request is received</li></ul><hr/><h2><a name="ForceType">ForceType</a> <a name="forcetype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Forces all matching files to be served with the specified
+MIME content-type</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ForceType <em>mime-type</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved to the core in Apache 2.0</td></tr></table></td></tr></table><usage>
+ <p>When placed into an <code>.htaccess</code> file or a
+ <a href="#directory" class="directive"><code class="directive"><Directory></code></a>, or
+ <a href="#location" class="directive"><code class="directive"><Location></code></a> or
+ <a href="#files" class="directive"><code class="directive"><Files></code></a>
section, this directive forces all matching files to be served
with the content type identification given by
<em>mime-type</em>. For example, if you had a directory full of
GIF files, but did not want to label them all with ".gif", you
might want to use:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
ForceType image/gif
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>Note that unlike <code class="directive"><a href="#defaulttype" class="directive">DefaultType</a></code>,
+ <p>Note that unlike <a href="#defaulttype" class="directive"><code class="directive">DefaultType</code></a>,
this directive overrides all mime-type associations, including
filename extensions, that might identify the media type.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="HostnameLookups">HostnameLookups</a> <a name="hostnamelookups">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Enables DNS lookups on client IP addresses</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>HostnameLookups on|off|double</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>HostnameLookups off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive enables DNS lookups so that host names can be
+</usage><hr/><h2><a name="HostnameLookups">HostnameLookups</a> <a name="hostnamelookups">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enables DNS lookups on client IP addresses</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>HostnameLookups on|off|double</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>HostnameLookups off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive enables DNS lookups so that host names can be
logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
The value <code>double</code> refers to doing double-reverse
DNS. That is, after a reverse lookup is performed, a forward
@@ -1781,8 +567,7 @@
address. (In "tcpwrappers" terminology this is called
<code>PARANOID</code>.)</p>
-
-<p>Regardless of the setting, when <code><a href="mod_access.html">mod_access</a></code> is
+ <p>Regardless of the setting, when <code><a href="mod_access.html">mod_access</a></code> is
used for controlling access by hostname, a double reverse lookup
will be performed. This is necessary for security. Note that the
result of this double-reverse isn't generally available unless you
@@ -1792,8 +577,7 @@
the double-reverse fails or not, CGIs will still be passed the
single-reverse result in <code>REMOTE_HOST</code>.</p>
-
-<p>The default is off in order to save the network
+ <p>The default is off in order to save the network
traffic for those sites that don't truly need the reverse
lookups done. It is also better for the end users because they
don't have to suffer the extra latency that a lookup entails.
@@ -1802,143 +586,56 @@
amounts of time. The utility <a href="../programs/logresolve.html">logresolve</a>, provided in
the <em>/support</em> directory, can be used to look up host
names from logged IP addresses offline.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="IdentityCheck">IdentityCheck</a> <a name="identitycheck">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Enables logging of the RFC1413 identity of the remote
-user</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>IdentityCheck on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>IdentityCheck off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive enables RFC1413-compliant logging of the
+</usage><hr/><h2><a name="IdentityCheck">IdentityCheck</a> <a name="identitycheck">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enables logging of the RFC1413 identity of the remote
+user</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>IdentityCheck on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>IdentityCheck off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive enables RFC1413-compliant logging of the
remote user name for each connection, where the client machine
runs identd or something similar. This information is logged in
the access log.</p>
-
-<p>The information should not be trusted in any way except for
+ <p>The information should not be trusted in any way except for
rudimentary usage tracking.</p>
-
-<p>Note that this can cause serious latency problems accessing
+ <p>Note that this can cause serious latency problems accessing
your server since every request requires one of these lookups
to be performed. When firewalls are involved each lookup might
possibly fail and add 30 seconds of latency to each hit. So in
general this is not very useful on public servers accessible
from the Internet.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="IfDefine"><IfDefine></a> <a name="ifdefine">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Encloses directives that will be processed only
-if a test is true at startup</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><IfDefine [!]<em>parameter-name</em>> <em>...</em>
- </IfDefine></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code><IfDefine
+</usage><hr/><h2><a name="IfDefine"><IfDefine></a> <a name="ifdefine">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Encloses directives that will be processed only
+if a test is true at startup</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><IfDefine [!]<em>parameter-name</em>> <em>...</em>
+ </IfDefine></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code><IfDefine
<em>test</em>>...</IfDefine></code> section is used to
mark directives that are conditional. The directives within an
<code class="directive"><IfDefine></code> section are only
processed if the <em>test</em> is true. If <em>test</em> is false,
everything between the start and end markers is ignored.</p>
-
-<p>The <em>test</em> in the <code class="directive"><IfDefine></code> section directive can be one
+ <p>The <em>test</em> in the <code class="directive"><IfDefine></code> section directive can be one
of two forms:</p>
+ <ul>
+ <li><em>parameter-name</em></li>
-<ul>
-
-<li>
-<em>parameter-name</em>
-</li>
-
-
-<li>
-<code>!</code><em>parameter-name</em>
-</li>
-
-</ul>
-
+ <li><code>!</code><em>parameter-name</em></li>
+ </ul>
-<p>In the former case, the directives between the start and end
+ <p>In the former case, the directives between the start and end
markers are only processed if the parameter named
<em>parameter-name</em> is defined. The second format reverses
the test, and only processes the directives if
<em>parameter-name</em> is <strong>not</strong> defined.</p>
-
-<p>The <em>parameter-name</em> argument is a define as given on
+ <p>The <em>parameter-name</em> argument is a define as given on
the <code>httpd</code> command line via
<code>-D</code><em>parameter-</em>, at the time the server was
started.</p>
-
-<p>
-<code class="directive"><IfDefine></code> sections are
+ <p><code class="directive"><IfDefine></code> sections are
nest-able, which can be used to implement simple
multiple-parameter tests. Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code><pre>
$ httpd -DReverseProxy ...
# httpd.conf
@@ -1946,170 +643,70 @@
LoadModule rewrite_module modules/mod_rewrite.so
LoadModule proxy_module modules/libproxy.so
</IfDefine>
-</pre>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-</usage>
-<hr>
-<h2>
-<a name="IfModule"><IfModule></a> <a name="ifmodule">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Encloses directives that are processed conditional on the
-presence of absence of a specific module</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><IfModule [!]<em>module-name</em>> <em>...</em>
- </IfModule></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
+</pre></code></td></tr></table></blockquote>
-<p>The <code><IfModule
+</usage><hr/><h2><a name="IfModule"><IfModule></a> <a name="ifmodule">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Encloses directives that are processed conditional on the
+presence of absence of a specific module</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><IfModule [!]<em>module-name</em>> <em>...</em>
+ </IfModule></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code><IfModule
<em>test</em>>...</IfModule></code> section is used to
mark directives that are conditional. The directives within an
<code class="directive"><IfModule></code> section are only
processed if the <em>test</em> is true. If <em>test</em> is false,
everything between the start and end markers is ignored.</p>
-
-<p>The <em>test</em> in the <code class="directive"><IfModule></code> section directive can be one
+ <p>The <em>test</em> in the <code class="directive"><IfModule></code> section directive can be one
of two forms:</p>
+ <ul>
+ <li><em>module name</em></li>
-<ul>
-
-<li>
-<em>module name</em>
-</li>
-
-
-<li>!<em>module name</em>
-</li>
-
-</ul>
-
+ <li>!<em>module name</em></li>
+ </ul>
-<p>In the former case, the directives between the start and end
+ <p>In the former case, the directives between the start and end
markers are only processed if the module named <em>module
name</em> is included in Apache -- either compiled in or
- dynamically loaded using <code class="directive"><a href="mod_so.html#loadmodule" class="directive">LoadModule</a></code>. The second format
+ dynamically loaded using <a href="mod_so.html#loadmodule" class="directive"><code class="directive">LoadModule</code></a>. The second format
reverses the test, and only processes the directives if <em>module
name</em> is <strong>not</strong> included.</p>
-
-<p>The <em>module name</em> argument is the file name of the
+ <p>The <em>module name</em> argument is the file name of the
module, at the time it was compiled.
For example, <code>mod_rewrite.c</code>.</p>
-
-<p>
-<code class="directive"><IfModule></code> sections are
+ <p><code class="directive"><IfModule></code> sections are
nest-able, which can be used to implement simple multiple-module
tests.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Include">Include</a> <a name="include">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Includes other configuration files from within
-the server configuration files</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Include <em>file-path</em>|<em>directory-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive allows inclusion of other configuration files
+</usage><hr/><h2><a name="Include">Include</a> <a name="include">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Includes other configuration files from within
+the server configuration files</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Include <em>file-path</em>|<em>directory-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive allows inclusion of other configuration files
from within the server configuration files.</p>
-
-<p>If <code class="directive">Include</code> points to a directory, rather than a
+ <p>If <code class="directive">Include</code> points to a directory, rather than a
file, Apache will read all files in that directory, and any
subdirectory, and parse those as configuration files.</p>
-
-<p>The file path specified may be a fully qualified path (i.e.
+ <p>The file path specified may be a fully qualified path (i.e.
starting with a slash), or may be relative to the
- <code class="directive"><a href="#serverroot" class="directive">ServerRoot</a></code> directory.</p>
-
-
-<p>Examples:</p>
+ <a href="#serverroot" class="directive"><code class="directive">ServerRoot</code></a> directory.</p>
+ <p>Examples:</p>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Include /usr/local/apache/conf/ssl.conf<br>
Include /usr/local/apache/conf/vhosts/
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>Or, providing paths relative to your <code>ServerRoot</code>
+ <p>Or, providing paths relative to your <code>ServerRoot</code>
directory:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Include conf/ssl.conf<br>
Include conf/vhosts/
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>Make sure that an included directory does not contain any stray
+ <p>Make sure that an included directory does not contain any stray
files, such as editor temporary files, for example, as Apache will
attempt to read them in and use the contents as configuration
directives, which may cause the server to fail on start up.
@@ -2117,71 +714,18 @@
the files that are being processed during the configuration
check:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code><pre>
root@host# apachectl configtest
Processing config directory: /usr/local/apache/conf/vhosts
Processing config file: /usr/local/apache/conf/vhosts/vhost1
Processing config file: /usr/local/apache/conf/vhosts/vhost2
Syntax OK
-</pre>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</pre></code></td></tr></table></blockquote>
-<p>This will help in verifying that you are getting only the files
+ <p>This will help in verifying that you are getting only the files
that you intended as part of your configuration.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../programs/apachectl.html">apachectl</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="KeepAlive">KeepAlive</a> <a name="keepalive">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Turns on or off HTTP persistent connections.</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>KeepAlive on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>KeepAlive On</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The Keep-Alive extension to HTTP/1.0 and the persistent
+</usage><p><strong>See also </strong></p><ul><li><a href="../programs/apachectl.html">apachectl</a></li></ul><hr/><h2><a name="KeepAlive">KeepAlive</a> <a name="keepalive">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Turns on or off HTTP persistent connections.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>KeepAlive on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>KeepAlive On</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The Keep-Alive extension to HTTP/1.0 and the persistent
connection feature of HTTP/1.1 provide long-lived HTTP sessions
which allow multiple requests to be sent over the same TCP
connection. In some cases this has been shown to result in an
@@ -2189,8 +733,7 @@
many images. To enable Keep-Alive connections in Apache 1.2 and
later, set <code>KeepAlive On</code>.</p>
-
-<p>For HTTP/1.0 clients, Keep-Alive connections will only be
+ <p>For HTTP/1.0 clients, Keep-Alive connections will only be
used if they are specifically requested by a client. In
addition, a Keep-Alive connection with an HTTP/1.0 client can
only be used when the length of the content is known in
@@ -2201,106 +744,27 @@
unless otherwise specified. If the client requests it, chunked
encoding will be used in order to send content of unknown
length over persistent connections.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#maxkeepaliverequests" class="directive">MaxKeepAliveRequests</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the amount of time the server will wait for subsequent
-requests on a persistent connection</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>KeepAliveTimeout <em>seconds</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>KeepAliveTimeout 15</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The number of seconds Apache will wait for a subsequent
+</usage><p><strong>See also </strong></p><ul><li><a href="#maxkeepaliverequests" class="directive"><code class="directive">MaxKeepAliveRequests</code></a></li></ul><hr/><h2><a name="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the amount of time the server will wait for subsequent
+requests on a persistent connection</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>KeepAliveTimeout <em>seconds</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>KeepAliveTimeout 15</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The number of seconds Apache will wait for a subsequent
request before closing the connection. Once a request has been
received, the timeout value specified by the
- <code class="directive"><a href="#timeout" class="directive">Timeout</a></code> directive applies.</p>
-
+ <a href="#timeout" class="directive"><code class="directive">Timeout</code></a> directive applies.</p>
-<p>Setting <code class="directive">KeepAliveTimeout</code> to a high value
+ <p>Setting <code class="directive">KeepAliveTimeout</code> to a high value
may cause performance problems in heavily loaded servers. The
higher the timeout, the more server processes will be kept
occupied waiting on connections with idle clients.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Limit"><Limit></a> <a name="limit">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Restrict access controls to only certain HTTP
-methods</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><Limit <em>method</em> [<em>method</em>] ... > ...
- </Limit></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Access controls are normally effective for
+</usage><hr/><h2><a name="Limit"><Limit></a> <a name="limit">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Restrict access controls to only certain HTTP
+methods</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><Limit <em>method</em> [<em>method</em>] ... > ...
+ </Limit></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>Access controls are normally effective for
<strong>all</strong> access methods, and this is the usual
desired behavior. <strong>In the general case, access control
directives should not be placed within a
- <code class="directive"><limit></code> section.</strong>
-</p>
-
+ <code class="directive"><limit></code> section.</strong></p>
-<p>The purpose of the <code class="directive"><Limit></code>
+ <p>The purpose of the <code class="directive"><Limit></code>
directive is to restrict the effect of the access controls to the
nominated HTTP methods. For all other methods, the access
restrictions that are enclosed in the <code><Limit></code>
@@ -2308,113 +772,35 @@
example applies the access control only to the methods POST, PUT,
and DELETE, leaving all other methods unprotected:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<code><Limit POST PUT DELETE><br>
Require valid-user<br>
</Limit></code>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>The method names listed can be one or more of: GET, POST, PUT,
+</code></td></tr></table></blockquote>
+ <p>The method names listed can be one or more of: GET, POST, PUT,
DELETE, CONNECT, OPTIONS, TRACE, PATCH, PROPFIND, PROPPATCH,
MKCOL, COPY, MOVE, LOCK, and UNLOCK. <strong>The method name is
case-sensitive.</strong> If GET is used it will also restrict
HEAD requests.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="LimitExcept"><LimitExcept></a> <a name="limitexcept">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Restrict access controls to all HTTP methods
-except the named ones</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><LimitExcept <em>method</em> [<em>method</em>] ... > ...
- </LimitExcept></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<code class="directive"><LimitExcept></code> and
+</usage><hr/><h2><a name="LimitExcept"><LimitExcept></a> <a name="limitexcept">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Restrict access controls to all HTTP methods
+except the named ones</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><LimitExcept <em>method</em> [<em>method</em>] ... > ...
+ </LimitExcept></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p><code class="directive"><LimitExcept></code> and
<code></LimitExcept></code> are used to enclose a group of
access control directives which will then apply to any HTTP access
method <strong>not</strong> listed in the arguments; i.e., it is
- the opposite of a <code class="directive"><a href="#limit" class="directive"><Limit></a></code> section and can be used to control
+ the opposite of a <a href="#limit" class="directive"><code class="directive"><Limit></code></a> section and can be used to control
both standard and nonstandard/unrecognized methods. See the
- documentation for <code class="directive"><a href="#limit" class="directive"><Limit></a></code> for more details.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Restricts the total size of the HTTP request body sent
-from the client</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>LimitRequestBody <em>bytes</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestBody 0</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive specifies the number of <em>bytes</em> from 0
+ documentation for <a href="#limit" class="directive"><code class="directive"><Limit></code></a> for more details.</p>
+</usage><hr/><h2><a name="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Restricts the total size of the HTTP request body sent
+from the client</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LimitRequestBody <em>bytes</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestBody 0</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive specifies the number of <em>bytes</em> from 0
(meaning unlimited) to 2147483647 (2GB) that are allowed in a
request body. The default value is defined by the compile-time
constant <code>DEFAULT_LIMIT_REQUEST_BODY</code> (0 as
distributed).</p>
-
-<p>The <code class="directive">LimitRequestBody</code> directive allows
+ <p>The <code class="directive">LimitRequestBody</code> directive allows
the user to set a limit on the allowed size of an HTTP request
message body within the context in which the directive is given
(server, per-directory, per-file or per-location). If the client
@@ -2427,57 +813,18 @@
least as large as any representation that the server wishes to
accept for that resource.</p>
-
-<p>This directive gives the server administrator greater
+ <p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service
attacks.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Limits the number of HTTP request header fields that
-will be accepted from the client</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>LimitRequestFields <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestFields 100</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<em>Number</em> is an integer from 0 (meaning unlimited) to
+</usage><hr/><h2><a name="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Limits the number of HTTP request header fields that
+will be accepted from the client</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LimitRequestFields <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestFields 100</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p><em>Number</em> is an integer from 0 (meaning unlimited) to
32767. The default value is defined by the compile-time
constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
distributed).</p>
-
-<p>The <code class="directive">LimitRequestFields</code> directive allows
+ <p>The <code class="directive">LimitRequestFields</code> directive allows
the server administrator to modify the limit on the number of
request header fields allowed in an HTTP request. A server needs
this value to be larger than the number of fields that a normal
@@ -2488,59 +835,21 @@
content negotiation. Optional HTTP extensions are often expressed
using request header fields.</p>
-
-<p>This directive gives the server administrator greater
+ <p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.
The value should be increased if normal clients see an error
response from the server that indicates too many fields were
sent in the request.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Limits the size of the HTTP request header allowed from the
-client</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>LimitRequestFieldsize <em>bytes</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestFieldsize 8190</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive specifies the number of <em>bytes</em> from 0
+</usage><hr/><h2><a name="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Limits the size of the HTTP request header allowed from the
+client</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LimitRequestFieldsize <em>bytes</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestFieldsize 8190</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive specifies the number of <em>bytes</em> from 0
to the value of the compile-time constant
<code>DEFAULT_LIMIT_REQUEST_FIELDSIZE</code> (8190 as
distributed) that will be allowed in an HTTP request
header.</p>
-
-<p>The <code class="directive">LimitRequestFieldsize</code> directive
+ <p>The <code class="directive">LimitRequestFieldsize</code> directive
allows the server administrator to reduce the limit on the allowed
size of an HTTP request header field below the normal input buffer
size compiled with the server. A server needs this value to be
@@ -2550,57 +859,19 @@
upon the extent to which a user has configured their browser to
support detailed content negotiation.</p>
-
-<p>This directive gives the server administrator greater
+ <p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.
Under normal conditions, the value should not be changed from
the default.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Limit the size of the HTTP request line that will be accepted
-from the client</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>LimitRequestLine <em>bytes</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestLine 8190</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive sets the number of <em>bytes</em> from 0 to
+</usage><hr/><h2><a name="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Limit the size of the HTTP request line that will be accepted
+from the client</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LimitRequestLine <em>bytes</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestLine 8190</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive sets the number of <em>bytes</em> from 0 to
the value of the compile-time constant
<code>DEFAULT_LIMIT_REQUEST_LINE</code> (8190 as distributed)
that will be allowed on the HTTP request-line.</p>
-
-<p>The <code class="directive">LimitRequestLine</code> directive allows
+ <p>The <code class="directive">LimitRequestLine</code> directive allows
the server administrator to reduce the limit on the allowed size
of a client's HTTP request-line below the normal input buffer size
compiled with the server. Since the request-line consists of the
@@ -2611,170 +882,73 @@
hold any of its resource names, including any information that
might be passed in the query part of a GET request.</p>
-
-<p>This directive gives the server administrator greater
+ <p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.
Under normal conditions, the value should not be changed from
the default.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Limits the size of an XML-based request body</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>LimitXMLRequestBody <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitXMLRequestBody 1000000</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Limit (in bytes) on maximum size of an XML-based request
+</usage><hr/><h2><a name="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Limits the size of an XML-based request body</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LimitXMLRequestBody <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitXMLRequestBody 1000000</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>Limit (in bytes) on maximum size of an XML-based request
body. A value of <code>0</code> will disable any checking.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Location"><Location></a> <a name="location">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Applies the enclosed directives only to matching
-URLs</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><Location
- <em>URL-path</em>|<em>URL</em>> ... </Location></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive"><Location></code> directive
+</usage><hr/><h2><a name="Location"><Location></a> <a name="location">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Applies the enclosed directives only to matching
+URLs</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><Location
+ <em>URL-path</em>|<em>URL</em>> ... </Location></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive"><Location></code> directive
provides for access control by URL. It is similar to the
- <code class="directive"><a href="#directory" class="directive"><Directory></a></code>
+ <a href="#directory" class="directive"><code class="directive"><Directory></code></a>
directive, and starts a subsection which is terminated with a
<code></Location></code> directive. <code class="directive"><Location></code> sections are processed in the
- order they appear in the configuration file, after the <code class="directive"><a href="#directory" class="directive"><Directory></a></code> sections and
- <code>.htaccess</code> files are read, and after the <code class="directive"><a href="#files" class="directive"><Files></a></code> sections.</p>
-
+ order they appear in the configuration file, after the <a href="#directory" class="directive"><code class="directive"><Directory></code></a> sections and
+ <code>.htaccess</code> files are read, and after the <a href="#files" class="directive"><code class="directive"><Files></code></a> sections.</p>
-<p>Note that URLs do not have to line up with the filesystem at
+ <p>Note that URLs do not have to line up with the filesystem at
all, it should be emphasized that <Location> operates
completely outside the filesystem.</p>
-
-<p>For all origin (non-proxy) requests, the URL to be matched
+ <p>For all origin (non-proxy) requests, the URL to be matched
is of the form <code>/path/</code>, and you should not include
any <code>http://servername</code> prefix. For proxy requests,
the URL to be matched is of the form
<code>scheme://servername/path</code>, and you must include the
prefix.</p>
-
-<p>The URL may use wildcards In a wild-card string, `?' matches
+ <p>The URL may use wildcards In a wild-card string, `?' matches
any single character, and `*' matches any sequences of
characters.</p>
-
-<p>Extended regular
+ <p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Location ~ "/(extra|special)/data">
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>would match URLs that contained the substring "/extra/data" or
+ <p>would match URLs that contained the substring "/extra/data" or
"/special/data". In Apache 1.3 and above, a new directive
- <code class="directive"><a href="#locationmatch" class="directive"><LocationMatch></a></code>
+ <a href="#locationmatch" class="directive"><code class="directive"><LocationMatch></code></a>
exists which behaves identical to the regex version of
<code class="directive"><Location></code>.</p>
-
-<p>The <code class="directive"><Location></code>
+ <p>The <code class="directive"><Location></code>
functionality is especially useful when combined with the
- <code class="directive"><a href="#sethandler" class="directive">SetHandler</a></code>
+ <a href="#sethandler" class="directive"><code class="directive">SetHandler</code></a>
directive. For example, to enable status requests, but allow them
only from browsers at foo.com, you might use:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Location /status><br>
SetHandler server-status<br>
Order Deny,Allow<br>
Deny from all<br>
Allow from .foo.com<br>
</Location>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Note about / (slash)</strong>
-</p>
-<p>The slash character has
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note about / (slash)</strong></p> <p>The slash character has
special meaning depending on where in a URL it appears. People may be
used to its behavior in the filesystem where multiple adjacent slashes
are frequently collapsed to a single slash (<em>i.e.</em>,
<code>/home///foo</code> is the same as <code>/home/foo</code>). In
-URL-space this is not necessarily true. The <code class="directive"><a href="#locationmatch" class="directive"><LocationMatch></a></code> directive and the regex
+URL-space this is not necessarily true. The <a href="#locationmatch" class="directive"><code class="directive"><LocationMatch></code></a> directive and the regex
version of <code class="directive"><Location></code> require you
to explicitly specify multiple slashes if that is your intention. For
example, <code><LocationMatch ^/abc></code> would match the
@@ -2784,413 +958,182 @@
will implicitly match multiple slashes with a single slash. For
example, if you specify <code><Location /abc/def></code> and the
request is to <code>/abc//def</code> then it will match.</p>
-
-</td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../sections.html">How
+</td></tr></table></blockquote>
+</usage><p><strong>See also </strong></p><ul><li><a href="../sections.html">How
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</li>
-</ul>
-<hr>
-<h2>
-<a name="LocationMatch"><LocationMatch></a> <a name="locationmatch">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Applies the enclosed directives only to regular-expression
-matching URLs</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><LocationMatch
- <em>regex</em>> ... </Location></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive"><LocationMatch></code> directive
+ request is received</li></ul><hr/><h2><a name="LocationMatch"><LocationMatch></a> <a name="locationmatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Applies the enclosed directives only to regular-expression
+matching URLs</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><LocationMatch
+ <em>regex</em>> ... </Location></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive"><LocationMatch></code> directive
provides for access control by URL, in an identical manner to
- <code class="directive"><a href="#location" class="directive"><Location></a></code>. However, it takes a regular
+ <a href="#location" class="directive"><code class="directive"><Location></code></a>. However, it takes a regular
expression as an argument instead of a simple string. For
example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<LocationMatch "/(extra|special)/data">
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>would match URLs that contained the substring "/extra/data"
+ <p>would match URLs that contained the substring "/extra/data"
or "/special/data".</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../sections.html">How
+</usage><p><strong>See also </strong></p><ul><li><a href="../sections.html">How
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</li>
-</ul>
-<hr>
-<h2>
-<a name="LogLevel">LogLevel</a> <a name="loglevel">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Controls the verbosity of the ErrorLog</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>LogLevel <em>level</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LogLevel warn</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<code class="directive">LogLevel</code> adjusts the verbosity of the
- messages recorded in the error logs (see <code class="directive"><a href="#errorlog" class="directive">ErrorLog</a></code> directive). The following
+ request is received</li></ul><hr/><h2><a name="LogLevel">LogLevel</a> <a name="loglevel">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Controls the verbosity of the ErrorLog</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LogLevel <em>level</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LogLevel warn</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p><code class="directive">LogLevel</code> adjusts the verbosity of the
+ messages recorded in the error logs (see <a href="#errorlog" class="directive"><code class="directive">ErrorLog</code></a> directive). The following
<em>level</em>s are available, in order of decreasing
significance:</p>
-
-<table>
-
-<tr>
-
-<th align="LEFT"><strong>Level</strong> </th>
+ <table>
+ <tr>
+ <th align="LEFT"><strong>Level</strong> </th>
<th align="LEFT"><strong>Description</strong> </th>
+ </tr>
-</tr>
-
-
-<tr>
-
-<th>
+ <tr>
+ <th>
</th>
<th align="LEFT"><strong>Example</strong> </th>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td><code>emerg</code> </td>
+ <tr>
+ <td><code>emerg</code> </td>
<td>Emergencies - system is unusable.</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td>
+ <tr>
+ <td>
</td>
<td>"Child cannot open lock file. Exiting"</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td><code>alert</code> </td>
+ <tr>
+ <td><code>alert</code> </td>
<td>Action must be taken immediately.</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td>
+ <tr>
+ <td>
</td>
<td>"getpwuid: couldn't determine user name from uid"</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td><code>crit</code> </td>
+ <tr>
+ <td><code>crit</code> </td>
<td>Critical Conditions.</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td>
+ <tr>
+ <td>
</td>
<td>"socket: Failed to get a socket, exiting child"</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td><code>error</code> </td>
+ <tr>
+ <td><code>error</code> </td>
<td>Error conditions.</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td>
+ <tr>
+ <td>
</td>
<td>"Premature end of script headers"</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td><code>warn</code> </td>
+ <tr>
+ <td><code>warn</code> </td>
<td>Warning conditions.</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td>
+ <tr>
+ <td>
</td>
<td>"child process 1234 did not exit, sending another
SIGHUP"</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td><code>notice</code> </td>
+ <tr>
+ <td><code>notice</code> </td>
<td>Normal but significant condition.</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td>
+ <tr>
+ <td>
</td>
<td>"httpd: caught SIGBUS, attempting to dump core in
..."</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td><code>info</code> </td>
+ <tr>
+ <td><code>info</code> </td>
<td>Informational.</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td>
+ <tr>
+ <td>
</td>
<td>"Server seems busy, (you may need to increase
StartServers, or Min/MaxSpareServers)..."</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td><code>debug</code> </td>
+ <tr>
+ <td><code>debug</code> </td>
<td>Debug-level messages</td>
+ </tr>
-</tr>
-
-
-<tr>
-
-<td>
+ <tr>
+ <td>
</td>
<td>"Opening config file ..."</td>
+ </tr>
+ </table>
-</tr>
-
-</table>
-
-
-<p>When a particular level is specified, messages from all
+ <p>When a particular level is specified, messages from all
other levels of higher significance will be reported as well.
<em>E.g.</em>, when <code>LogLevel info</code> is specified,
then messages with log levels of <code>notice</code> and
<code>warn</code> will also be posted.</p>
-
-<p>Using a level of at least <code>crit</code> is
+ <p>Using a level of at least <code>crit</code> is
recommended.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the number of requests allowed on a persistent
-connection</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MaxKeepAliveRequests <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxKeepAliveRequests 100</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">MaxKeepAliveRequests</code> directive
+</usage><hr/><h2><a name="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the number of requests allowed on a persistent
+connection</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MaxKeepAliveRequests <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxKeepAliveRequests 100</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">MaxKeepAliveRequests</code> directive
limits the number of requests allowed per connection when
- <code class="directive"><a href="#keepalive" class="directive">KeepAlive</a></code> is on. If it is
+ <a href="#keepalive" class="directive"><code class="directive">KeepAlive</code></a> is on. If it is
set to "<code>0</code>", unlimited requests will be allowed. We
recommend that this setting be kept to a high value for maximum
server performance.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Configures an IP address for name-virtual
-hosting</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>NameVirtualHost <em>addr</em>[:<em>port</em>]</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">NameVirtualHost</code> directive is a
+</usage><hr/><h2><a name="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures an IP address for name-virtual
+hosting</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>NameVirtualHost <em>addr</em>[:<em>port</em>]</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">NameVirtualHost</code> directive is a
required directive if you want to configure <a href="../vhosts/">name-based virtual hosts</a>.</p>
+ <p>Although <em>addr</em> can be hostname it is recommended
+ that you always use an IP address, <em>e.g.</em></p>
-<p>Although <em>addr</em> can be hostname it is recommended
- that you always use an IP address, <em>e.g.</em>
-</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>NameVirtualHost 111.22.33.44</code></td>
-</tr>
-</table>
-</blockquote>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>NameVirtualHost 111.22.33.44</code></td></tr></table></blockquote>
-<p>With the <code class="directive">NameVirtualHost</code> directive you
+ <p>With the <code class="directive">NameVirtualHost</code> directive you
specify the IP address on which the server will receive requests
for the name-based virtual hosts. This will usually be the address
to which your name-based virtual host names resolve. In cases
@@ -3200,173 +1143,92 @@
servicing the requests. If you have multiple name-based hosts on
multiple addresses, repeat the directive for each address.</p>
-
-<p>Note: the "main server" and any _default_ servers will
+ <p>Note: the "main server" and any _default_ servers will
<strong>never</strong> be served for a request to a
<code class="directive">NameVirtualHost</code> IP Address (unless for some
reason you specify <code class="directive">NameVirtualHost</code> but then
don't define any VirtualHosts for that address).</p>
+ <p>Optionally you can specify a port number on which the
+ name-based virtual hosts should be used, <em>e.g.</em></p>
-<p>Optionally you can specify a port number on which the
- name-based virtual hosts should be used, <em>e.g.</em>
-</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>NameVirtualHost 111.22.33.44:8080</code></td>
-</tr>
-</table>
-</blockquote>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>NameVirtualHost 111.22.33.44:8080</code></td></tr></table></blockquote>
-<p>IPv6 addresses must be enclosed in square brackets, as shown
+ <p>IPv6 addresses must be enclosed in square brackets, as shown
in the following example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</code></td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-</usage>
-<hr>
-<h2>
-<a name="Options">Options</a> <a name="options">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Configures what features are available in a particular
-directory</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Options
- [+|-]<em>option</em> [[+|-]<em>option</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Options All</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">Options</code> directive controls which
+</usage><hr/><h2><a name="Options">Options</a> <a name="options">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures what features are available in a particular
+directory</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Options
+ [+|-]<em>option</em> [[+|-]<em>option</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Options All</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">Options</code> directive controls which
server features are available in a particular directory.</p>
-
-<p>
-<em>option</em> can be set to <code>None</code>, in which
+ <p><em>option</em> can be set to <code>None</code>, in which
case none of the extra features are enabled, or one or more of
the following:</p>
+ <dl>
+ <dt>All</dt>
-<dl>
-
-<dt>All</dt>
-
-
-<dd>All options except for MultiViews. This is the default
+ <dd>All options except for MultiViews. This is the default
setting.</dd>
+ <dt>ExecCGI</dt>
-<dt>ExecCGI</dt>
-
-
-<dd>
+ <dd>
Execution of CGI scripts is permitted.</dd>
+ <dt>FollowSymLinks</dt>
-<dt>FollowSymLinks</dt>
-
-
-<dd>
+ <dd>
The server will follow symbolic links in this directory.<br>
-
-<strong>Note</strong>: even though the server follows the
+ <strong>Note</strong>: even though the server follows the
symlink it does <em>not</em> change the pathname used to match
- against <code class="directive"><a href="#directory" class="directive"><Directory></a></code> sections.<br>
-
-<strong>Note</strong>: this option gets ignored if set inside a
- <code class="directive"><a href="#location" class="directive"><Location></a></code>
+ against <a href="#directory" class="directive"><code class="directive"><Directory></code></a> sections.<br>
+ <strong>Note</strong>: this option gets ignored if set inside a
+ <a href="#location" class="directive"><code class="directive"><Location></code></a>
section.</dd>
+ <dt>Includes</dt>
-<dt>Includes</dt>
-
-
-<dd>
+ <dd>
Server-side includes are permitted.</dd>
+ <dt>IncludesNOEXEC</dt>
-<dt>IncludesNOEXEC</dt>
-
-
-<dd>
+ <dd>
Server-side includes are permitted, but the #exec command and
#exec CGI are disabled. It is still possible to #include
virtual CGI scripts from ScriptAliase'd directories.</dd>
+ <dt>Indexes</dt>
-<dt>Indexes</dt>
-
-
-<dd>
+ <dd>
If a URL which maps to a directory is requested, and the
there is no DirectoryIndex (<em>e.g.</em>, index.html) in
that directory, then the server will return a formatted
listing of the directory.</dd>
+ <dt>MultiViews</dt>
-<dt>MultiViews</dt>
-
-
-<dd>
-
-<a href="../content-negotiation.html">Content negotiated</a>
+ <dd>
+ <a href="../content-negotiation.html">Content negotiated</a>
MultiViews are allowed.</dd>
+ <dt>SymLinksIfOwnerMatch</dt>
-<dt>SymLinksIfOwnerMatch</dt>
-
-
-<dd>
+ <dd>
The server will only follow symbolic links for which the target
- file or directory is owned by the same user id as the link.<br>
-<strong>Note</strong>: this option gets ignored if set inside
- a <code class="directive"><a href="#location" class="directive"><Location></a></code>
+ file or directory is owned by the same user id as the link.<br> <strong>Note</strong>: this option gets ignored if set inside
+ a <a href="#location" class="directive"><code class="directive"><Location></code></a>
section.</dd>
-
-</dl>
-
-<p>Normally, if multiple <code class="directive">Options</code> could apply to a
+ </dl>
+ <p>Normally, if multiple <code class="directive">Options</code> could apply to a
directory, then the most specific one is taken complete; the
options are not merged. However if <em>all</em> the options on
the <code class="directive">Options</code> directive are preceded by a + or -
@@ -3375,213 +1237,90 @@
preceded by a - are removed from the options currently in
force. </p>
-
-<p>For example, without any + and - symbols:</p>
-
+ <p>For example, without any + and - symbols:</p>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code><Directory /web/docs><br>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code><Directory /web/docs><br>
Options Indexes FollowSymLinks<br>
</Directory><br>
<Directory /web/docs/spec><br>
Options Includes<br>
</Directory>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>then only <code>Includes</code> will be set for the
+</code></td></tr></table></blockquote>
+ <p>then only <code>Includes</code> will be set for the
/web/docs/spec directory. However if the second
<code class="directive">Options</code> directive uses the + and - symbols:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory /web/docs><br>
Options Indexes FollowSymLinks<br>
</Directory><br>
<Directory /web/docs/spec><br>
Options +Includes -Indexes<br>
</Directory>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>then the options <code>FollowSymLinks</code> and
+</code></td></tr></table></blockquote>
+ <p>then the options <code>FollowSymLinks</code> and
<code>Includes</code> are set for the /web/docs/spec directory.</p>
-
-<p>
-<strong>Note:</strong> Using <code>-IncludesNOEXEC</code> or
+ <p><strong>Note:</strong> Using <code>-IncludesNOEXEC</code> or
<code>-Includes</code> disables server-side includes completely
regardless of the previous setting.</p>
-
-<p>The default in the absence of any other settings is
+ <p>The default in the absence of any other settings is
<code>All</code>.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Require">Require</a> <a name="require">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Selects which authenticated users can access
-a resource</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Require <em>entity-name</em> [<em>entity-name</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive selects which authenticated users can access
+</usage><hr/><h2><a name="Require">Require</a> <a name="require">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Selects which authenticated users can access
+a resource</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Require <em>entity-name</em> [<em>entity-name</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive selects which authenticated users can access
a directory. The allowed syntaxes are:</p>
-
-<ul>
-
-<li>
+ <ul>
+ <li>
Require user <em>userid</em> [<em>userid</em>] ...
<p>Only the named users can access the directory.</p>
+ </li>
-</li>
-
-
-<li>
+ <li>
Require group <em>group-name</em> [<em>group-name</em>] ...
<p>Only users in the named groups can access the
directory.</p>
+ </li>
-</li>
-
-
-<li>
+ <li>
Require valid-user
<p>All valid users can access the directory.</p>
+ </li>
+ </ul>
-</li>
-
-</ul>
-
-
-<p>
-<code class="directive">Require</code> must be accompanied by
- <code class="directive"><a href="#authname" class="directive">AuthName</a></code> and <code class="directive"><a href="#authtype" class="directive">AuthType</a></code> directives, and directives such
- as <code class="directive"><a href="mod_auth.html#authuserfile" class="directive">AuthUserFile</a></code>
- and <code class="directive"><a href="mod_auth.html#authgroupfile" class="directive">AuthGroupFile</a></code> (to
+ <p><code class="directive">Require</code> must be accompanied by
+ <a href="#authname" class="directive"><code class="directive">AuthName</code></a> and <a href="#authtype" class="directive"><code class="directive">AuthType</code></a> directives, and directives such
+ as <a href="mod_auth.html#authuserfile" class="directive"><code class="directive">AuthUserFile</code></a>
+ and <a href="mod_auth.html#authgroupfile" class="directive"><code class="directive">AuthGroupFile</code></a> (to
define users and groups) in order to work correctly. Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AuthType Basic<br>
AuthName "Restricted Directory"<br>
AuthUserFile /web/users<br>
AuthGroupFile /web/groups<br>
Require group admin<br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>Access controls which are applied in this way are effective for
+ <p>Access controls which are applied in this way are effective for
<strong>all</strong> methods. <strong>This is what is normally
desired.</strong> If you wish to apply access controls only to
specific methods, while leaving other methods unprotected, then
place the <code class="directive">Require</code> statement into a
- <code class="directive"><a href="#limit" class="directive"><Limit></a></code>
+ <a href="#limit" class="directive"><code class="directive"><Limit></code></a>
section.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#satisfy" class="directive">Satisfy</a></code>
-</li>
-<li>
-<code><a href="mod_access.html">mod_access</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Limits the CPU consumption of processes launched
-by Apache children</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RLimitCPU <em>number</em>|max [<em>number</em>|max]</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to
- the MPMs</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Takes 1 or 2 parameters. The first parameter sets the soft
+</usage><p><strong>See also </strong></p><ul><li><a href="#satisfy" class="directive"><code class="directive">Satisfy</code></a></li><li><code><a href="mod_access.html">mod_access</a></code></li></ul><hr/><h2><a name="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Limits the CPU consumption of processes launched
+by Apache children</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RLimitCPU <em>number</em>|max [<em>number</em>|max]</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to
+ the MPMs</td></tr></table></td></tr></table><usage>
+ <p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <em>max</em> to indicate to the server that the limit should
@@ -3590,68 +1329,17 @@
the server is running as root, or in the initial startup
phase.</p>
-
-<p>This applies to processes forked off from Apache children
+ <p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
-
-<p>CPU resource limits are expressed in seconds per
+ <p>CPU resource limits are expressed in seconds per
process.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#rlimitmem" class="directive">RLimitMEM</a></code>
-</li>
-<li>
-<code class="directive"><a href="#rlimitnproc" class="directive">RLimitNPROC</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="RLimitMEM">RLimitMEM</a> <a name="rlimitmem">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Limits the memory consumption of processes launched
-by Apache children</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RLimitMEM <em>number</em>|max [<em>number</em>|max]</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to the MPMs.</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Takes 1 or 2 parameters. The first parameter sets the soft
+</usage><p><strong>See also </strong></p><ul><li><a href="#rlimitmem" class="directive"><code class="directive">RLimitMEM</code></a></li><li><a href="#rlimitnproc" class="directive"><code class="directive">RLimitNPROC</code></a></li></ul><hr/><h2><a name="RLimitMEM">RLimitMEM</a> <a name="rlimitmem">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Limits the memory consumption of processes launched
+by Apache children</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RLimitMEM <em>number</em>|max [<em>number</em>|max]</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to the MPMs.</td></tr></table></td></tr></table><usage>
+ <p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <em>max</em> to indicate to the server that the limit should
@@ -3660,68 +1348,17 @@
the server is running as root, or in the initial startup
phase.</p>
-
-<p>This applies to processes forked off from Apache children
+ <p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
-
-<p>Memory resource limits are expressed in bytes per
+ <p>Memory resource limits are expressed in bytes per
process.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#rlimitcpu" class="directive">RLimitCPU</a></code>
-</li>
-<li>
-<code class="directive"><a href="#rlimitnproc" class="directive">RLimitNPROC</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Limits the number of processes that can be launched by
-processes launched by Apache children</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RLimitNPROC <em>number</em>|max [<em>number</em>|max]</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to the MPMs.</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Takes 1 or 2 parameters. The first parameter sets the soft
+</usage><p><strong>See also </strong></p><ul><li><a href="#rlimitcpu" class="directive"><code class="directive">RLimitCPU</code></a></li><li><a href="#rlimitnproc" class="directive"><code class="directive">RLimitNPROC</code></a></li></ul><hr/><h2><a name="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Limits the number of processes that can be launched by
+processes launched by Apache children</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RLimitNPROC <em>number</em>|max [<em>number</em>|max]</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to the MPMs.</td></tr></table></td></tr></table><usage>
+ <p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit
@@ -3730,72 +1367,23 @@
the server is running as root, or in the initial startup
phase.</p>
-
-<p>This applies to processes forked off from Apache children
+ <p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
+ <p>Process limits control the number of processes per user.</p>
-<p>Process limits control the number of processes per user.</p>
-
-
-<p>Note: If CGI processes are <strong>not</strong> running
+ <p>Note: If CGI processes are <strong>not</strong> running
under userids other than the web server userid, this directive
will limit the number of processes that the server itself can
create. Evidence of this situation will be indicated by
<strong><em>cannot fork</em></strong> messages in the
error_log.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#rlimitmem" class="directive">RLimitMEM</a></code>
-</li>
-<li>
-<code class="directive"><a href="#rlimitcpu" class="directive">RLimitCPU</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="Satisfy">Satisfy</a> <a name="satisfy">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Configures how host-level access control and user authentication
-interact</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Satisfy any|all</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Satisfy all</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Access policy if both <code class="directive"><a href="#allow" class="directive">Allow</a></code> and <code class="directive"><a href="#require" class="directive">Require</a></code> used. The parameter can be
+</usage><p><strong>See also </strong></p><ul><li><a href="#rlimitmem" class="directive"><code class="directive">RLimitMEM</code></a></li><li><a href="#rlimitcpu" class="directive"><code class="directive">RLimitCPU</code></a></li></ul><hr/><h2><a name="Satisfy">Satisfy</a> <a name="satisfy">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures how host-level access control and user authentication
+interact</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Satisfy any|all</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Satisfy all</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>Access policy if both <a href="#allow" class="directive"><code class="directive">Allow</code></a> and <a href="#require" class="directive"><code class="directive">Require</code></a> used. The parameter can be
either <em>'all'</em> or <em>'any'</em>. This directive is only
useful if access to a particular area is being restricted by both
username/password <em>and</em> client host address. In this case
@@ -3806,206 +1394,42 @@
valid username and password. This can be used to password restrict
an area, but to let clients from particular addresses in without
prompting for a password.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Controls how the interpreter for CGI scripts is
-located</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ScriptInterpreterSource registry|script</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptInterpreterSource script</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Win32 only</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive is used to control how Apache finds the
+</usage><hr/><h2><a name="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Controls how the interpreter for CGI scripts is
+located</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ScriptInterpreterSource registry|script</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptInterpreterSource script</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Win32 only</td></tr></table></td></tr></table><usage>
+ <p>This directive is used to control how Apache finds the
interpreter used to run CGI scripts. The default technique is to
use the interpreter pointed to by the #! line in the
script. Setting <code>ScriptInterpreterSource registry</code> will
cause the Windows Registry to be searched using the script file
extension (e.g., .pl) as a search key.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ServerAdmin">ServerAdmin</a> <a name="serveradmin">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the email address that the server includes in error
-messages sent to the client</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ServerAdmin <em>email-address</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ServerAdmin</code> sets the e-mail address
+</usage><hr/><h2><a name="ServerAdmin">ServerAdmin</a> <a name="serveradmin">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the email address that the server includes in error
+messages sent to the client</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerAdmin <em>email-address</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ServerAdmin</code> sets the e-mail address
that the server includes in any error messages it returns to the
client.</p>
-
-<p>It may be worth setting up a dedicated address for this,
- <em>e.g.</em>
-</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>ServerAdmin www-admin@foo.bar.com</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>as users do not always mention that they are talking about the
+ <p>It may be worth setting up a dedicated address for this,
+ <em>e.g.</em></p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>ServerAdmin www-admin@foo.bar.com</code></td></tr></table></blockquote>
+ <p>as users do not always mention that they are talking about the
server!</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ServerAlias">ServerAlias</a> <a name="serveralias">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets alternate names for a host used when matching requests
-to name-virtual hosts</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ServerAlias <em>hostname</em> [<em>hostname</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ServerAlias</code> directive sets the
+</usage><hr/><h2><a name="ServerAlias">ServerAlias</a> <a name="serveralias">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets alternate names for a host used when matching requests
+to name-virtual hosts</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerAlias <em>hostname</em> [<em>hostname</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ServerAlias</code> directive sets the
alternate names for a host, for use with <a href="../vhosts/name-based.html">name-based virtual hosts</a>.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<VirtualHost *><br>
ServerName server.domain.com<br>
ServerAlias server server2.domain.com server2<br>
...<br>
</VirtualHost>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../vhosts/">Apache Virtual Host documentation</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="ServerName">ServerName</a> <a name="servername">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the hostname and port that the server uses to identify
-itself</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ServerName <em>fully-qualified-domain-name[:port]</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>In version 2.0, this
+</code></td></tr></table></blockquote>
+</usage><p><strong>See also </strong></p><ul><li><a href="../vhosts/">Apache Virtual Host documentation</a></li></ul><hr/><h2><a name="ServerName">ServerName</a> <a name="servername">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the hostname and port that the server uses to identify
+itself</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerName <em>fully-qualified-domain-name[:port]</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>In version 2.0, this
directive supersedes the functionality of the Port
- directive from version 1.3.</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ServerName</code> directive sets the hostname and
+ directive from version 1.3.</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ServerName</code> directive sets the hostname and
port that the server uses to identify itself. This is used when
creating redirection URLs. For example, if the name of the
machine hosting the webserver is <code>simple.example.com</code>,
@@ -4013,17 +1437,9 @@
and you wish the webserver to be so identified, the following
directive should be used:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>ServerName www.example.com:80</code></td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>ServerName www.example.com:80</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>If no <code class="directive">ServerName</code> is specified, then the
+ <p>If no <code class="directive">ServerName</code> is specified, then the
server attempts to deduce the hostname by performing a reverse
lookup on the IP address. If no port is specified in the
servername, then the server will use the port from the incoming
@@ -4031,178 +1447,34 @@
specify an explicit hostname and port using the
<code class="directive">ServerName</code> directive.</p>
-
-<p>If you are using <a href="../vhosts/name-based.html">name-based virtual hosts</a>,
+ <p>If you are using <a href="../vhosts/name-based.html">name-based virtual hosts</a>,
the <code class="directive">ServerName</code> inside a
- <code class="directive"><a href="#virtualhost" class="directive"><VirtualHost></a></code>
+ <a href="#virtualhost" class="directive"><code class="directive"><VirtualHost></code></a>
section specifies what hostname must appear in the request's
<code>Host:</code> header to match this virtual host.</p>
-
-<p>See the description of the
- <code class="directive"><a href="#usecanonicalname" class="directive">UseCanonicalName</a></code> directive for
+ <p>See the description of the
+ <a href="#usecanonicalname" class="directive"><code class="directive">UseCanonicalName</code></a> directive for
settings which determine whether self-referential URL's (e.g., by the
<code><a href="mod_dir.html">mod_dir</a></code> module) will refer to the
specified port, or to the port number given in the client's request.
</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../dns-caveats.html">DNS Issues</a>
-</li>
-<li>
-<a href="../vhosts/">Apache virtual host
- documentation</a>
-</li>
-<li>
-<code class="directive"><a href="#usecanonicalname" class="directive">UseCanonicalName</a></code>
-</li>
-<li>
-<code class="directive"><a href="#namevirtualhost" class="directive">NameVirtualHost</a></code>
-</li>
-<li>
-<code class="directive"><a href="#serveralias" class="directive">ServerAlias</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="ServerPath">ServerPath</a> <a name="serverpath">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the legacy URL pathname for a name-virtual host that
-is accessed by an incompatible browser</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ServerPath <em>directory-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ServerPath</code> directive sets the legacy
+</usage><p><strong>See also </strong></p><ul><li><a href="../dns-caveats.html">DNS Issues</a></li><li><a href="../vhosts/">Apache virtual host
+ documentation</a></li><li><a href="#usecanonicalname" class="directive"><code class="directive">UseCanonicalName</code></a></li><li><a href="#namevirtualhost" class="directive"><code class="directive">NameVirtualHost</code></a></li><li><a href="#serveralias" class="directive"><code class="directive">ServerAlias</code></a></li></ul><hr/><h2><a name="ServerPath">ServerPath</a> <a name="serverpath">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the legacy URL pathname for a name-virtual host that
+is accessed by an incompatible browser</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerPath <em>directory-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ServerPath</code> directive sets the legacy
URL pathname for a host, for use with <a href="../vhosts/">name-based virtual hosts</a>.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../vhosts/">Apache Virtual Host documentation</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="ServerRoot">ServerRoot</a> <a name="serverroot">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the base directory for the server installation</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ServerRoot <em>directory-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerRoot /usr/local/apache</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ServerRoot</code> directive sets the
+</usage><p><strong>See also </strong></p><ul><li><a href="../vhosts/">Apache Virtual Host documentation</a></li></ul><hr/><h2><a name="ServerRoot">ServerRoot</a> <a name="serverroot">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the base directory for the server installation</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerRoot <em>directory-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerRoot /usr/local/apache</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ServerRoot</code> directive sets the
directory in which the server lives. Typically it will contain the
subdirectories <code>conf/</code> and <code>logs/</code>. Relative
paths for other configuration files are taken as relative to this
directory.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../invoking.html">the <code>-d</code>
- option to <code>httpd</code></a>
-</li>
-<li>
-<a href="../misc/security_tips.html#serverroot">the
+</usage><p><strong>See also </strong></p><ul><li><a href="../invoking.html">the <code>-d</code>
+ option to <code>httpd</code></a></li><li><a href="../misc/security_tips.html#serverroot">the
security tips</a> for information on how to properly set
- permissions on the ServerRoot</li>
-</ul>
-<hr>
-<h2>
-<a name="ServerSignature">ServerSignature</a> <a name="serversignature">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Configures the footer on server-generated documents</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ServerSignature On|Off|EMail</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerSignature Off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ServerSignature</code> directive allows the
+ permissions on the ServerRoot</li></ul><hr/><h2><a name="ServerSignature">ServerSignature</a> <a name="serversignature">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures the footer on server-generated documents</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerSignature On|Off|EMail</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerSignature Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ServerSignature</code> directive allows the
configuration of a trailing footer line under server-generated
documents (error messages, mod_proxy ftp directory listings,
mod_info output, ...). The reason why you would want to enable
@@ -4212,407 +1484,130 @@
setting, which is the default, suppresses the error line (and is
therefore compatible with the behavior of Apache-1.2 and
below). The <samp>On</samp> setting simply adds a line with the
- server version number and <code class="directive"><a href="#servername" class="directive">ServerName</a></code> of the serving virtual host,
+ server version number and <a href="#servername" class="directive"><code class="directive">ServerName</code></a> of the serving virtual host,
and the <samp>EMail</samp> setting additionally creates a
- "mailto:" reference to the <code class="directive"><a href="#serveradmin" class="directive">ServerAdmin</a></code> of the referenced
+ "mailto:" reference to the <a href="#serveradmin" class="directive"><code class="directive">ServerAdmin</code></a> of the referenced
document.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ServerTokens">ServerTokens</a> <a name="servertokens">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Configures the Server HTTP response header</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ServerTokens Minimal|ProductOnly|OS|Full</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerTokens Full</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive controls whether <samp>Server</samp> response
+</usage><hr/><h2><a name="ServerTokens">ServerTokens</a> <a name="servertokens">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures the Server HTTP response header</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerTokens Minimal|ProductOnly|OS|Full</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerTokens Full</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>This directive controls whether <samp>Server</samp> response
header field which is sent back to clients includes a
description of the generic OS-type of the server as well as
information about compiled-in modules.</p>
+ <dl>
+ <dt><code>ServerTokens Prod[uctOnly]</code></dt>
-<dl>
-
-<dt>
-<code>ServerTokens Prod[uctOnly]</code>
-</dt>
-
-
-<dd>Server sends (<em>e.g.</em>): <samp>Server:
- Apache</samp>
-</dd>
-
-
-<dt>
-<code>ServerTokens Min[imal]</code>
-</dt>
-
-
-<dd>Server sends (<em>e.g.</em>): <samp>Server:
- Apache/1.3.0</samp>
-</dd>
-
-
-<dt>
-<code>ServerTokens OS</code>
-</dt>
-
-
-<dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0
- (Unix)</samp>
-</dd>
+ <dd>Server sends (<em>e.g.</em>): <samp>Server:
+ Apache</samp></dd>
+ <dt><code>ServerTokens Min[imal]</code></dt>
-<dt>
-<code>ServerTokens Full</code> (or not specified)</dt>
+ <dd>Server sends (<em>e.g.</em>): <samp>Server:
+ Apache/1.3.0</samp></dd>
+ <dt><code>ServerTokens OS</code></dt>
-<dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0
- (Unix) PHP/3.0 MyMod/1.2</samp>
-</dd>
+ <dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0
+ (Unix)</samp></dd>
-</dl>
+ <dt><code>ServerTokens Full</code> (or not specified)</dt>
+ <dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0
+ (Unix) PHP/3.0 MyMod/1.2</samp></dd>
+ </dl>
-<p>This setting applies to the entire server, and cannot be
+ <p>This setting applies to the entire server, and cannot be
enabled or disabled on a virtualhost-by-virtualhost basis.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="SetHandler">SetHandler</a> <a name="sethandler">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Forces all matching files to be processed by a
-handler</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>SetHandler <em>handler-name</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved into the core in Apache 2.0</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>When placed into an <code>.htaccess</code> file or a
- <code class="directive"><a href="#directory" class="directive"><Directory></a></code> or
- <code class="directive"><a href="#location" class="directive"><Location></a></code>
+</usage><hr/><h2><a name="SetHandler">SetHandler</a> <a name="sethandler">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Forces all matching files to be processed by a
+handler</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SetHandler <em>handler-name</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved into the core in Apache 2.0</td></tr></table></td></tr></table><usage>
+ <p>When placed into an <code>.htaccess</code> file or a
+ <a href="#directory" class="directive"><code class="directive"><Directory></code></a> or
+ <a href="#location" class="directive"><code class="directive"><Location></code></a>
section, this directive forces all matching files to be parsed
through the <a href="../handler.html">handler</a> given by
<em>handler-name</em>. For example, if you had a directory you
wanted to be parsed entirely as imagemap rule files, regardless
of extension, you might put the following into an
<code>.htaccess</code> file in that directory:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
SetHandler imap-file
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>Another example: if you wanted to have the server display a
+ <p>Another example: if you wanted to have the server display a
status report whenever a URL of
<code>http://servername/status</code> was called, you might put
the following into httpd.conf:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Location /status><br>
SetHandler server-status<br>
</Location>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="SetInputFilter">SetInputFilter</a> <a name="setinputfilter">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the filters that will process client requests and POST
-input</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>SetInputFilter <em>filter</em>[<em>;filter</em>...]</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">SetInputFilter</code> directive sets the
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="SetInputFilter">SetInputFilter</a> <a name="setinputfilter">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the filters that will process client requests and POST
+input</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SetInputFilter <em>filter</em>[<em>;filter</em>...]</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">SetInputFilter</code> directive sets the
filter or filters which will process client requests and POST
input when they are received by the server. This is in addition to
any filters defined elsewhere, including the
- <code class="directive"><a href="mod_mime.html#addinputfilter" class="directive">AddInputFilter</a></code>
+ <a href="mod_mime.html#addinputfilter" class="directive"><code class="directive">AddInputFilter</code></a>
directive.</p>
-
-<p>If more than one filter is specified, they must be separated
+ <p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
content.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../filter.html">Filters</a> documentation</li>
-</ul>
-<hr>
-<h2>
-<a name="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the filters that will process responses from the
-server</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>SetOutputFilter <em>filter</em> [<em>filter</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">SetOutputFilter</code> directive sets the filters
+</usage><p><strong>See also </strong></p><ul><li><a href="../filter.html">Filters</a> documentation</li></ul><hr/><h2><a name="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the filters that will process responses from the
+server</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SetOutputFilter <em>filter</em> [<em>filter</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">SetOutputFilter</code> directive sets the filters
which will process responses from the server before they are
sent to the client. This is in addition to any filters defined
elsewhere, including the
- <code class="directive"><a href="mod_mime.html#addoutputfilter" class="directive">AddOutputFilter</a></code>
+ <a href="mod_mime.html#addoutputfilter" class="directive"><code class="directive">AddOutputFilter</code></a>
directive.</p>
-
-<p>For example, the following configuration will process all files
+ <p>For example, the following configuration will process all files
in the <code>/www/data/</code> directory for server-side
includes.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory /www/data/><br>
SetOutputFilter INCLUDES<br>
</Directory>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>If more than one filter is specified, they must be separated
+ <p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
content.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../filter.html">Filters</a> documentation</li>
-</ul>
-<hr>
-<h2>
-<a name="TimeOut">TimeOut</a> <a name="timeout">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Defines the amount of time the server will wait for
-certain events before failing a request</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>TimeOut <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>TimeOut 300</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">TimeOut</code> directive currently defines
+</usage><p><strong>See also </strong></p><ul><li><a href="../filter.html">Filters</a> documentation</li></ul><hr/><h2><a name="TimeOut">TimeOut</a> <a name="timeout">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Defines the amount of time the server will wait for
+certain events before failing a request</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>TimeOut <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>TimeOut 300</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">TimeOut</code> directive currently defines
the amount of time Apache will wait for three things:</p>
-
-<ol>
-
-<li>The total amount of time it takes to receive a GET
+ <ol>
+ <li>The total amount of time it takes to receive a GET
request.</li>
-
-<li>The amount of time between receipt of TCP packets on a
+ <li>The amount of time between receipt of TCP packets on a
POST or PUT request.</li>
-
-<li>The amount of time between ACKs on transmissions of TCP
+ <li>The amount of time between ACKs on transmissions of TCP
packets in responses.</li>
+ </ol>
-</ol>
-
-
-<p>We plan on making these separately configurable at some point
+ <p>We plan on making these separately configurable at some point
down the road. The timer used to default to 1200 before 1.2,
but has been lowered to 300 which is still far more than
necessary in most situations. It is not set any lower by
default because there may still be odd places in the code where
the timer is not reset when a packet is sent. </p>
-
-</usage>
-<hr>
-<h2>
-<a name="UseCanonicalName">UseCanonicalName</a> <a name="usecanonicalname">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Configures how the server determines its own name and
-port</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>UseCanonicalName on|off|dns</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>UseCanonicalName on</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>In many situations Apache has to construct a
+</usage><hr/><h2><a name="UseCanonicalName">UseCanonicalName</a> <a name="usecanonicalname">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures how the server determines its own name and
+port</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>UseCanonicalName on|off|dns</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>UseCanonicalName on</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p>In many situations Apache has to construct a
<em>self-referential</em> URL. That is, a URL which refers back to
the same server. With <code>UseCanonicalName on</code> Apache will
- use the hostname and port specified in the <code class="directive"><a href="#servername" class="directive">ServerName</a></code> directive to construct a canonical
+ use the hostname and port specified in the <a href="#servername" class="directive"><code class="directive">ServerName</code></a> directive to construct a canonical
name for the server. This name is used in all self-referential
URLs, and for the values of <code>SERVER_NAME</code> and
<code>SERVER_PORT</code> in CGIs.</p>
-
-<p>With <code>UseCanonicalName off</code> Apache will form
+ <p>With <code>UseCanonicalName off</code> Apache will form
self-referential URLs using the hostname and port supplied by
the client if any are supplied (otherwise it will use the
canonical name). These values are the same that are used to
@@ -4622,8 +1617,7 @@
<code>SERVER_PORT</code> will be constructed from the client
supplied values as well.</p>
-
-<p>An example where this may be useful is on an intranet server
+ <p>An example where this may be useful is on an intranet server
where you have users connecting to the machine using short
names such as <code>www</code>. You'll notice that if the users
type a shortname, and a URL which is a directory, such as
@@ -4636,71 +1630,24 @@
<code class="directive">UseCanonicalName</code> is set off, then Apache will
redirect to <code>http://www/splat/</code>.</p>
-
-<p>There is a third option, <code>UseCanonicalName DNS</code>,
+ <p>There is a third option, <code>UseCanonicalName DNS</code>,
which is intended for use with mass IP-based virtual hosting to
support ancient clients that do not provide a
<code>Host:</code> header. With this option Apache does a
reverse DNS lookup on the server IP address that the client
connected to in order to work out self-referential URLs.</p>
-
-<p>
-<strong>Warning:</strong> if CGIs make assumptions about the
+ <p><strong>Warning:</strong> if CGIs make assumptions about the
values of <code>SERVER_NAME</code> they may be broken by this
option. The client is essentially free to give whatever value
they want as a hostname. But if the CGI is only using
<code>SERVER_NAME</code> to construct self-referential URLs
then it should be just fine.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#servername" class="directive">ServerName</a></code>
-</li>
-<li>
-<code class="directive"><a href="mpm_common.html#listen" class="directive">Listen</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="VirtualHost"><VirtualHost></a> <a name="virtualhost">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Contains directives that apply only to a specific
-hostname or IP address</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax><VirtualHost
+</usage><p><strong>See also </strong></p><ul><li><a href="#servername" class="directive"><code class="directive">ServerName</code></a></li><li><a href="mpm_common.html#listen" class="directive"><code class="directive">Listen</code></a></li></ul><hr/><h2><a name="VirtualHost"><VirtualHost></a> <a name="virtualhost">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Contains directives that apply only to a specific
+hostname or IP address</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax><VirtualHost
<em>addr</em>[:<em>port</em>] [<em>addr</em>[:<em>port</em>]]
- ...> ... </VirtualHost></syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<code class="directive"><VirtualHost></code> and
+ ...> ... </VirtualHost></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ <p><code class="directive"><VirtualHost></code> and
<code></VirtualHost></code> are used to enclose a group of
directives which will apply only to a particular virtual host. Any
directive which is allowed in a virtual host context may be
@@ -4709,44 +1656,29 @@
enclosed in the <code class="directive"><VirtualHost></code>
section. <em>Addr</em> can be</p>
+ <ul>
+ <li>The IP address of the virtual host</li>
-<ul>
-
-<li>The IP address of the virtual host</li>
-
-
-<li>A fully qualified domain name for the IP address of the
+ <li>A fully qualified domain name for the IP address of the
virtual host.</li>
-
-</ul>
+ </ul>
Example:
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code><VirtualHost 10.1.2.3><br>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code><VirtualHost 10.1.2.3><br>
ServerAdmin webmaster@host.foo.com<br>
DocumentRoot /www/docs/host.foo.com<br>
ServerName host.foo.com<br>
ErrorLog logs/host.foo.com-error_log<br>
TransferLog logs/host.foo.com-access_log<br>
</VirtualHost>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>IPv6 addresses must be specified in square brackets because
+ <p>IPv6 addresses must be specified in square brackets because
the optional port number could not be determined otherwise. An
IPv6 example is shown below:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<VirtualHost [fe80::a00:20ff:fea7:ccea]><br>
ServerAdmin webmaster@host.foo.com<br>
DocumentRoot /www/docs/host.foo.com<br>
@@ -4754,13 +1686,9 @@
ErrorLog logs/host.foo.com-error_log<br>
TransferLog logs/host.foo.com-access_log<br>
</VirtualHost>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>Each Virtual Host must correspond to a different IP address,
+ <p>Each Virtual Host must correspond to a different IP address,
different port number or a different host name for the server,
in the former case the server machine must be configured to
accept IP packets for multiple addresses. (If the machine does
@@ -4768,60 +1696,31 @@
accomplished with the <code>ifconfig alias</code> command (if
your OS supports it), or with kernel patches like <a href="../misc/vif-info.html">VIF</a> (for SunOS(TM) 4.1.x)).</p>
-
-<p>The special name <code>_default_</code> can be specified in
+ <p>The special name <code>_default_</code> can be specified in
which case this virtual host will match any IP address that is
not explicitly listed in another virtual host. In the absence
of any _default_ virtual host the "main" server config,
consisting of all those definitions outside any VirtualHost
section, is used when no match occurs.</p>
-
-<p>You can specify a <code>:port</code> to change the port that is
+ <p>You can specify a <code>:port</code> to change the port that is
matched. If unspecified then it defaults to the same port as the
- most recent <code class="directive"><a href="mpm_common.html#listen" class="directive">Listen</a></code>
+ most recent <a href="mpm_common.html#listen" class="directive"><code class="directive">Listen</code></a>
statement of the main server. You may also specify <code>:*</code>
to match all ports on that address. (This is recommended when used
with <code>_default_</code>.)</p>
-
-<p>
-<strong>SECURITY</strong>: See the <a href="../misc/security_tips.html">security tips</a> document
+ <p><strong>SECURITY</strong>: See the <a href="../misc/security_tips.html">security tips</a> document
for details on why your security could be compromised if the
directory where logfiles are stored is writable by anyone other
than the user that starts the server.</p>
-
-<p>
-<strong>NOTE</strong>: The use of <code class="directive"><VirtualHost></code> does <strong>not</strong>
+ <p><strong>NOTE</strong>: The use of <code class="directive"><VirtualHost></code> does <strong>not</strong>
affect what addresses Apache listens on. You may need to ensure
- that Apache is listening on the correct addresses using <code class="directive"><a href="mpm_common.html#listen" class="directive">Listen</a></code>.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../vhosts/">Apache Virtual Host documentation</a>
-</li>
-<li>
-<a href="../dns-caveats.html">Warnings about DNS and
- Apache</a>
-</li>
-<li>
-<a href="../bind.html">Setting
- which addresses and ports Apache uses</a>
-</li>
-<li>
-<a href="../sections.html">How
+ that Apache is listening on the correct addresses using <a href="mpm_common.html#listen" class="directive"><code class="directive">Listen</code></a>.</p>
+</usage><p><strong>See also </strong></p><ul><li><a href="../vhosts/">Apache Virtual Host documentation</a></li><li><a href="../dns-caveats.html">Warnings about DNS and
+ Apache</a></li><li><a href="../bind.html">Setting
+ which addresses and ports Apache uses</a></li><li><a href="../sections.html">How
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</li>
-</ul>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+ request is received</li></ul><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.31 +86 -339 httpd-2.0/docs/manual/mod/mod_access.html
Index: mod_access.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_access.html,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -d -b -u -r1.30 -r1.31
--- mod_access.html 19 Feb 2002 18:37:19 -0000 1.30
+++ mod_access.html 6 Mar 2002 17:08:19 -0000 1.31
@@ -1,222 +1,100 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_access - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_access</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Provides access control based on client hostname, IP
-address, or other characteristics of the client request.</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>access_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>The directives provided by mod_access are used in <code class="directive"><a href="core.html#<directory>" class="directive"><Directory></a></code>, <code class="directive"><a href="core.html#<files>" class="directive"><Files></a></code>, and <code class="directive"><a href="core.html#<location>" class="directive"><Location></a></code> sections as well as
+--><title>mod_access - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_access</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Provides access control based on client hostname, IP
+address, or other characteristics of the client request.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>access_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>The directives provided by mod_access are used in <a href="core.html#directory" class="directive"><code class="directive"><Directory></code></a>, <a href="core.html#files" class="directive"><code class="directive"><Files></code></a>, and <a href="core.html#location" class="directive"><code class="directive"><Location></code></a> sections as well as
<code><a href="core.html#accessfilename">.htaccess</a></code>
files to control access to particular parts of the server. Access
can be controlled based on the client hostname, IP address, or
- other characteristics of the client request, as captured in <a href="../env.html">environment variables</a>. The <code class="directive"><a href="#allow" class="directive">Allow</a></code> and <code class="directive"><a href="#deny" class="directive">Deny</a></code> directives are used to
+ other characteristics of the client request, as captured in <a href="../env.html">environment variables</a>. The <a href="#allow" class="directive"><code class="directive">Allow</code></a> and <a href="#deny" class="directive"><code class="directive">Deny</code></a> directives are used to
specify which clients are or are not allowed access to the server,
- while the <code class="directive"><a href="#order" class="directive">Order</a></code>
+ while the <a href="#order" class="directive"><code class="directive">Order</code></a>
directive sets the default access state, and configures how the
- <code class="directive"><a href="#allow" class="directive">Allow</a></code> and <code class="directive"><a href="#deny" class="directive">Deny</a></code> directives interact with each
+ <a href="#allow" class="directive"><code class="directive">Allow</code></a> and <a href="#deny" class="directive"><code class="directive">Deny</code></a> directives interact with each
other.</p>
-
-<p>Both host-based access restrictions and password-based
+ <p>Both host-based access restrictions and password-based
authentication may be implemented simultaneously. In that case,
- the <code class="directive"><a href="core.html#satisfy" class="directive">Satisfy</a></code> directive is used
+ the <a href="core.html#satisfy" class="directive"><code class="directive">Satisfy</code></a> directive is used
to determine how the two sets of restrictions interact.</p>
-
-<p>In general, access restriction directives apply to all
+ <p>In general, access restriction directives apply to all
access methods (<code>GET</code>, <code>PUT</code>,
<code>POST</code>, etc). This is the desired behavior in most
cases. However, it is possible to restrict some methods, while
leaving other methods unrestricted, by enclosing the directives
- in a <code class="directive"><a href="core.html#<limit>" class="directive"><Limit></a></code> section.</p>
-
-</summary>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="core.html#satisfy" class="directive">Satisfy</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#require" class="directive">Require</a></code>
-</li>
-</ul>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#allow">Allow</a>
-</li>
-<li>
-<a href="#deny">Deny</a>
-</li>
-<li>
-<a href="#order">Order</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="Allow">Allow</a> <a name="allow">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Controls which hosts can access an area of the
-server</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax> Allow from
+ in a <a href="core.html#limit" class="directive"><code class="directive"><Limit></code></a> section.</p>
+</summary><p><strong>See also </strong></p><ul><li><a href="core.html#satisfy" class="directive"><code class="directive">Satisfy</code></a></li><li><a href="core.html#require" class="directive"><code class="directive">Require</code></a></li></ul><h2>Directives</h2><ul><li><a href="#allow">Allow</a></li><li><a href="#deny">Deny</a></li><li><a href="#order">Order</a></li></ul><hr/><h2><a name="Allow">Allow</a> <a name="allow">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Controls which hosts can access an area of the
+server</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax> Allow from
all|<em>host</em>|env=<em>env-variable</em>
- [<em>host</em>|env=<em>env-variable</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Limit</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_access</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
+ [<em>host</em>|env=<em>env-variable</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Limit</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_access</td></tr></table></td></tr></table><usage>
-<p>The <code class="directive">Allow</code> directive affects which hosts can
+ <p>The <code class="directive">Allow</code> directive affects which hosts can
access an area of the server. Access can be controlled by
hostname, IP Address, IP Address range, or by other
characteristics of the client request captured in environment
variables.</p>
-
-<p>The first argument to this directive is always
+ <p>The first argument to this directive is always
<code>from</code>. The subsequent arguments can take three
different forms. If <code>Allow from all</code> is specified, then
all hosts are allowed access, subject to the configuration of the
- <code class="directive"><a href="#deny" class="directive">Deny</a></code> and <code class="directive"><a href="#order" class="directive">Order</a></code> directives as discussed
+ <a href="#deny" class="directive"><code class="directive">Deny</code></a> and <a href="#order" class="directive"><code class="directive">Order</code></a> directives as discussed
below. To allow only particular hosts or groups of hosts to access
the server, the <em>host</em> can be specified in any of the
following formats:</p>
+ <dl>
+ <dt>A (partial) domain-name</dt>
-<dl>
-
-<dt>A (partial) domain-name</dt>
-
-
-<dd>Example: <code>Allow from apache.org</code>
-<br>
+ <dd>Example: <code>Allow from apache.org</code><br>
Hosts whose names match, or end in, this string are allowed
access. Only complete components are matched, so the above
example will match <code>foo.apache.org</code> but it will
not match <code>fooapache.org</code>. This configuration will
cause the server to perform a reverse DNS lookup on the
- client IP address, regardless of the setting of the <code class="directive"><a href="core.html#hostnamelookups" class="directive">HostnameLookups</a></code>
+ client IP address, regardless of the setting of the <a href="core.html#hostnamelookups" class="directive"><code class="directive">HostnameLookups</code></a>
directive.</dd>
+ <dt>A full IP address</dt>
-<dt>A full IP address</dt>
-
-
-<dd>Example: <code>Allow from 10.1.2.3</code>
-<br>
+ <dd>Example: <code>Allow from 10.1.2.3</code><br>
An IP address of a host allowed access</dd>
+ <dt>A partial IP address</dt>
-<dt>A partial IP address</dt>
-
-
-<dd>Example: <code>Allow from 10.1</code>
-<br>
+ <dd>Example: <code>Allow from 10.1</code><br>
The first 1 to 3 bytes of an IP address, for subnet
restriction.</dd>
+ <dt>A network/netmask pair</dt>
-<dt>A network/netmask pair</dt>
-
-
-<dd>Example: <code>Allow from
- 10.1.0.0/255.255.0.0</code>
-<br>
+ <dd>Example: <code>Allow from
+ 10.1.0.0/255.255.0.0</code><br>
A network a.b.c.d, and a netmask w.x.y.z. For more
fine-grained subnet restriction.</dd>
+ <dt>A network/nnn CIDR specification</dt>
-<dt>A network/nnn CIDR specification</dt>
-
-
-<dd>Example: <code>Allow from 10.1.0.0/16</code>
-<br>
+ <dd>Example: <code>Allow from 10.1.0.0/16</code><br>
Similar to the previous case, except the netmask consists of
nnn high-order 1 bits.</dd>
+ </dl>
-</dl>
-
-
-<p>Note that the last three examples above match exactly the
+ <p>Note that the last three examples above match exactly the
same set of hosts.</p>
-
-<p>IPv6 addresses and IPv6 subnets can be specified as shown
+ <p>IPv6 addresses and IPv6 subnets can be specified as shown
below:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Allow from fe80::a00:20ff:fea7:ccea<br>
Allow from fe80::a00:20ff:fea7:ccea/10
- </code></td>
-</tr>
-</table>
-</blockquote>
-
+ </code></td></tr></table></blockquote>
-<p>The third format of the arguments to the
+ <p>The third format of the arguments to the
<code class="directive">Allow</code> directive allows access to the server
to be controlled based on the existence of an <a href="../env.html">environment variable</a>. When <code>Allow from
env=</code><em>env-variable</em> is specified, then the request is
@@ -229,15 +107,7 @@
<code>User-Agent</code> (browser type), <code>Referer</code>, or
other HTTP request header fields.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee">
-<p align="center">
-<strong>Example:</strong>
-</p>
-<code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example:</strong></p><code>
SetEnvIf User-Agent ^KnockKnock/2.0 let_me_in<br>
<Directory /docroot><br>
@@ -245,185 +115,79 @@
Deny from all<br>
Allow from env=let_me_in<br>
</Directory>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>In this case, browsers with a user-agent string beginning
+ <p>In this case, browsers with a user-agent string beginning
with <code>KnockKnock/2.0</code> will be allowed access, and all
others will be denied.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Deny">Deny</a> <a name="deny">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Controls which hosts are denied access to the
-server</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax> Deny from
+</usage><hr/><h2><a name="Deny">Deny</a> <a name="deny">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Controls which hosts are denied access to the
+server</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax> Deny from
all|<em>host</em>|env=<em>env-variable</em>
- [<em>host</em>|env=<em>env-variable</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Limit</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_access</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive allows access to the server to be restricted
+ [<em>host</em>|env=<em>env-variable</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Limit</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_access</td></tr></table></td></tr></table><usage>
+ <p>This directive allows access to the server to be restricted
based on hostname, IP address, or environment variables. The
arguments for the <code class="directive">Deny</code> directive are
- identical to the arguments for the <code class="directive"><a href="#allow" class="directive">Allow</a></code> directive.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Order">Order</a> <a name="order">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Controls the default access state and the order in which
+ identical to the arguments for the <a href="#allow" class="directive"><code class="directive">Allow</code></a> directive.</p>
+</usage><hr/><h2><a name="Order">Order</a> <a name="order">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Controls the default access state and the order in which
Allow and Deny are
-evaluated.</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax> Order <em>ordering</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Order Deny,Allow</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Limit</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_access</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
+evaluated.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax> Order <em>ordering</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Order Deny,Allow</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Limit</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_access</td></tr></table></td></tr></table><usage>
-<p>The <code class="directive">Order</code> directive controls the default
- access state and the order in which <code class="directive"><a href="#allow" class="directive">Allow</a></code> and <code class="directive"><a href="#deny" class="directive">Deny</a></code> directives are evaluated.
+ <p>The <code class="directive">Order</code> directive controls the default
+ access state and the order in which <a href="#allow" class="directive"><code class="directive">Allow</code></a> and <a href="#deny" class="directive"><code class="directive">Deny</code></a> directives are evaluated.
<em>Ordering</em> is one of</p>
+ <dl>
+ <dt>Deny,Allow</dt>
-<dl>
-
-<dt>Deny,Allow</dt>
-
-
-<dd>The <code class="directive"><a href="#deny" class="directive">Deny</a></code> directives
- are evaluated before the <code class="directive"><a href="#allow" class="directive">Allow</a></code> directives. Access is
+ <dd>The <a href="#deny" class="directive"><code class="directive">Deny</code></a> directives
+ are evaluated before the <a href="#allow" class="directive"><code class="directive">Allow</code></a> directives. Access is
allowed by default. Any client which does not match a
- <code class="directive"><a href="#deny" class="directive">Deny</a></code> directive or does
- match an <code class="directive"><a href="#allow" class="directive">Allow</a></code>
+ <a href="#deny" class="directive"><code class="directive">Deny</code></a> directive or does
+ match an <a href="#allow" class="directive"><code class="directive">Allow</code></a>
directive will be allowed access to the server.</dd>
+ <dt>Allow,Deny</dt>
-<dt>Allow,Deny</dt>
-
-
-<dd>The <code class="directive"><a href="#allow" class="directive">Allow</a></code>
- directives are evaluated before the <code class="directive"><a href="#deny" class="directive">Deny</a></code> directives. Access is denied
- by default. Any client which does not match an <code class="directive"><a href="#allow" class="directive">Allow</a></code> directive or does match a
- <code class="directive"><a href="#deny" class="directive">Deny</a></code> directive will be
+ <dd>The <a href="#allow" class="directive"><code class="directive">Allow</code></a>
+ directives are evaluated before the <a href="#deny" class="directive"><code class="directive">Deny</code></a> directives. Access is denied
+ by default. Any client which does not match an <a href="#allow" class="directive"><code class="directive">Allow</code></a> directive or does match a
+ <a href="#deny" class="directive"><code class="directive">Deny</code></a> directive will be
denied access to the server.</dd>
+ <dt>Mutual-failure</dt>
-<dt>Mutual-failure</dt>
-
-
-<dd>Only those hosts which appear on the <code class="directive"><a href="#allow" class="directive">Allow</a></code> list and do not appear on
- the <code class="directive"><a href="#deny" class="directive">Deny</a></code> list are
+ <dd>Only those hosts which appear on the <a href="#allow" class="directive"><code class="directive">Allow</code></a> list and do not appear on
+ the <a href="#deny" class="directive"><code class="directive">Deny</code></a> list are
granted access. This ordering has the same effect as <code>Order
Allow,Deny</code> and is deprecated in favor of that
configuration.</dd>
+ </dl>
-</dl>
-
-
-<p>Keywords may only be separated by a comma; no whitespace is
- allowed between them. Note that in all cases every <code class="directive"><a href="#allow" class="directive">Allow</a></code> and <code class="directive"><a href="#deny" class="directive">Deny</a></code> statement is evaluated.</p>
-
+ <p>Keywords may only be separated by a comma; no whitespace is
+ allowed between them. Note that in all cases every <a href="#allow" class="directive"><code class="directive">Allow</code></a> and <a href="#deny" class="directive"><code class="directive">Deny</code></a> statement is evaluated.</p>
-<p>In the following example, all hosts in the apache.org domain
+ <p>In the following example, all hosts in the apache.org domain
are allowed access; all other hosts are denied access.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Order Deny,Allow<br>
Deny from all<br>
Allow from apache.org<br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>In the next example, all hosts in the apache.org domain are
+ <p>In the next example, all hosts in the apache.org domain are
allowed access, except for the hosts which are in the
foo.apache.org subdomain, who are denied access. All hosts not
in the apache.org domain are denied access because the default
state is to deny access to the server.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Order Allow,Deny<br>
Allow from apache.org<br>
Deny from foo.apache.org<br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>On the other hand, if the <code>Order</code> in the last
+ <p>On the other hand, if the <code>Order</code> in the last
example is changed to <code>Deny,Allow</code>, all hosts will
be allowed access. This happens because, regardless of the
actual ordering of the directives in the configuration file,
@@ -433,47 +197,30 @@
be allowed access because the default state will change to
<em>allow</em>.</p>
-
-<p>The presence of an <code>Order</code> directive can affect
+ <p>The presence of an <code>Order</code> directive can affect
access to a part of the server even in the absence of accompanying
- <code class="directive"><a href="#allow" class="directive">Allow</a></code> and <code class="directive"><a href="#deny" class="directive">Deny</a></code> directives because of its effect
+ <a href="#allow" class="directive"><code class="directive">Allow</code></a> and <a href="#deny" class="directive"><code class="directive">Deny</code></a> directives because of its effect
on the default access state. For example,</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory /www><br>
Order Allow,Deny<br>
</Directory>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>will deny all access to the <code>/www</code> directory
+ <p>will deny all access to the <code>/www</code> directory
because the default access state will be set to
<em>deny</em>.</p>
-
-<p>The <code class="directive">Order</code> directive controls the order of access
+ <p>The <code class="directive">Order</code> directive controls the order of access
directive processing only within each phase of the server's
configuration processing. This implies, for example, that an
- <code class="directive"><a href="#allow" class="directive">Allow</a></code> or <code class="directive"><a href="#deny" class="directive">Deny</a></code> directive occurring in a
- <code class="directive"><a href="core.html#<location>" class="directive"><Location></a></code> section will
- always be evaluated after an <code class="directive"><a href="#allow" class="directive">Allow</a></code> or <code class="directive"><a href="#deny" class="directive">Deny</a></code> directive occurring in a
- <code class="directive"><a href="core.html#<directory>" class="directive"><Directory></a></code> section or
+ <a href="#allow" class="directive"><code class="directive">Allow</code></a> or <a href="#deny" class="directive"><code class="directive">Deny</code></a> directive occurring in a
+ <a href="core.html#location" class="directive"><code class="directive"><Location></code></a> section will
+ always be evaluated after an <a href="#allow" class="directive"><code class="directive">Allow</code></a> or <a href="#deny" class="directive"><code class="directive">Deny</code></a> directive occurring in a
+ <a href="core.html#directory" class="directive"><code class="directive"><Directory></code></a> section or
<code>.htaccess</code> file, regardless of the setting of the
<code class="directive">Order</code> directive. For details on the merging
of configuration sections, see the documentation on <a href="../sections.html">How Directory, Location and Files sections
work</a>.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.19 +21 -183 httpd-2.0/docs/manual/mod/mod_actions.html
Index: mod_actions.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_actions.html,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -b -u -r1.18 -r1.19
--- mod_actions.html 19 Feb 2002 18:37:19 -0000 1.18
+++ mod_actions.html 6 Mar 2002 17:08:19 -0000 1.19
@@ -1,201 +1,58 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_actions - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_actions</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>This module provides for executing CGI scripts based on
-media type or request method.</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>actions_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>This module has two directives. The <code class="directive"><a href="#action" class="directive">Action</a></code> directive lets you run CGI
+--><title>mod_actions - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_actions</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides for executing CGI scripts based on
+media type or request method.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>actions_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This module has two directives. The <a href="#action" class="directive"><code class="directive">Action</code></a> directive lets you run CGI
scripts whenever a file of a certain type is requested. The
- <code class="directive"><a href="#script" class="directive">Script</a></code> directive lets
+ <a href="#script" class="directive"><code class="directive">Script</code></a> directive lets
you run CGI scripts whenever a particular method is used in a
request. This makes it much easier to execute scripts that process
files.</p>
-
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#action">Action</a>
-</li>
-<li>
-<a href="#script">Script</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="Action">Action</a> <a name="action">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Activates a CGI script for a particular handler or
-content-type</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Action <em>action-type cgi-script</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_actions</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive adds an action, which will activate
+</summary><h2>Directives</h2><ul><li><a href="#action">Action</a></li><li><a href="#script">Script</a></li></ul><hr/><h2><a name="Action">Action</a> <a name="action">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Activates a CGI script for a particular handler or
+content-type</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Action <em>action-type cgi-script</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_actions</td></tr></table></td></tr></table><usage>
+ <p>This directive adds an action, which will activate
<em>cgi-script</em> when <em>action-type</em> is triggered by
the request. The <em>action-type</em> can be either a <a href="../handler.html">handler</a> or a MIME content type. It
sends the URL and file path of the requested document using the
standard CGI PATH_INFO and PATH_TRANSLATED environment
variables.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee">
-<p align="center">
-<strong>Examples</strong>
-</p>
-<code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Examples</strong></p><code>
# Requests for files of a particular type:<br>
Action image/gif /cgi-bin/images.cgi<br>
-
<br>
# Files of a particular file extension<br>
AddHandler my-file-type .xyz<br>
Action my-file-type /cgi-bin/program.cgi<br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>In the first example, requests for files with a MIME content
+ <p>In the first example, requests for files with a MIME content
type of <code>image/gif</code> will instead be handled by the
specified cgi script <code>/cgi-bin/images.cgi</code>.</p>
-
-<p>In the second example, requests for files with a file extension of
+ <p>In the second example, requests for files with a file extension of
<code>.xyz</code> are handled instead by the specified cgi script
<code>/cgi-bin/program.cgi</code>.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="mod_mime.html#addhandler" class="directive">AddHandler</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="Script">Script</a> <a name="script">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Activates a CGI script for a particular request
-method.</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax> Script <em>method cgi-script</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_actions</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive adds an action, which will activate
+</usage><p><strong>See also </strong></p><ul><li><a href="mod_mime.html#addhandler" class="directive"><code class="directive">AddHandler</code></a></li></ul><hr/><h2><a name="Script">Script</a> <a name="script">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Activates a CGI script for a particular request
+method.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax> Script <em>method cgi-script</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_actions</td></tr></table></td></tr></table><usage>
+ <p>This directive adds an action, which will activate
<em>cgi-script</em> when a file is requested using the method of
<em>method</em>. It sends the URL and file path of the requested
document using the standard CGI PATH_INFO and PATH_TRANSLATED
environment variables.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
+<blockquote><table><tr><td bgcolor="#e0e5f5">
Any arbitrary method name may be used. <strong>Method names are
case-sensitive</strong>, so <code>Script PUT</code> and
<code>Script put</code> have two entirely different
effects.
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<p>Note that the Script command defines default actions only.
+ <p>Note that the Script command defines default actions only.
If a CGI script is called, or some other resource that is
capable of handling the requested method internally, it will do
so. Also note that Script with a method of <code>GET</code>
@@ -203,30 +60,11 @@
(<em>e.g.</em>, foo.html?hi). Otherwise, the request will
proceed normally.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee">
-<p align="center">
-<strong>Examples</strong>
-</p>
-<code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Examples</strong></p><code>
# For <ISINDEX>-style searching<br>
Script GET /cgi-bin/search<br>
# A CGI PUT handler<br>
Script PUT /~bob/put.cgi<br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</code></td></tr></table></blockquote>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.34 +73 -493 httpd-2.0/docs/manual/mod/mod_alias.html
Index: mod_alias.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_alias.html,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -d -b -u -r1.33 -r1.34
--- mod_alias.html 19 Feb 2002 18:37:19 -0000 1.33
+++ mod_alias.html 6 Mar 2002 17:08:19 -0000 1.34
@@ -1,598 +1,178 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_alias - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_alias</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Provides for mapping different parts of the host
- filesystem in the document tree and for URL redirection</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>alias_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>The directives contained in this module allow for manipulation
+--><title>mod_alias - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_alias</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Provides for mapping different parts of the host
+ filesystem in the document tree and for URL redirection</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>alias_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>The directives contained in this module allow for manipulation
and control of URLs as requests arrive at the server. The
- <code class="directive"><a href="#alias" class="directive">Alias</a></code> and <code class="directive"><a href="#scriptalias" class="directive">ScriptAlias</a></code> directives are used to
+ <a href="#alias" class="directive"><code class="directive">Alias</code></a> and <a href="#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a> directives are used to
map between URLs and filesystem paths. This allows for content
- which is not directly under the <code class="directive"><a href="core.html#documentroot" class="directive">DocumentRoot</a></code> served as part of the web
- document tree. The <code class="directive"><a href="#scriptalias" class="directive">ScriptAlias</a></code> directive has the
+ which is not directly under the <a href="core.html#documentroot" class="directive"><code class="directive">DocumentRoot</code></a> served as part of the web
+ document tree. The <a href="#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a> directive has the
additional effect of marking the target directory as containing
only CGI scripts.</p>
-
-<p>The <code class="directive"><a href="#redirect" class="directive">Redirect</a></code>
+ <p>The <a href="#redirect" class="directive"><code class="directive">Redirect</code></a>
directives are used to instruct clients to make a new request with
a different URL. They are often used when a resource has moved to
a new location.</p>
-
-<p>A more powerful and flexible set of directives for
+ <p>A more powerful and flexible set of directives for
manipulating URLs is contained in the <code><a href="mod_rewrite.html">mod_rewrite</a></code>
module.</p>
+</summary><h2>Directives</h2><ul><li><a href="#alias">Alias</a></li><li><a href="#aliasmatch">AliasMatch</a></li><li><a href="#redirect">Redirect</a></li><li><a href="#redirectmatch">RedirectMatch</a></li><li><a href="#redirectpermanent">RedirectPermanent</a></li><li><a href="#redirecttemp">RedirectTemp</a></li><li><a href="#scriptalias">ScriptAlias</a></li><li><a href="#scriptaliasmatch">ScriptAliasMatch</a></li></ul><hr/><h2><a name="Alias">Alias</a> <a name="alias">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps URLs to filesystem locations</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax> Alias <em>URL-path
+ file-path</em>|<em>directory-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table><usage>
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#alias">Alias</a>
-</li>
-<li>
-<a href="#aliasmatch">AliasMatch</a>
-</li>
-<li>
-<a href="#redirect">Redirect</a>
-</li>
-<li>
-<a href="#redirectmatch">RedirectMatch</a>
-</li>
-<li>
-<a href="#redirecttemp">RedirectTemp</a>
-</li>
-<li>
-<a href="#redirectpermanent">RedirectPermanent</a>
-</li>
-<li>
-<a href="#scriptalias">ScriptAlias</a>
-</li>
-<li>
-<a href="#scriptaliasmatch">ScriptAliasMatch</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="Alias">Alias</a> <a name="alias">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maps URLs to filesystem locations</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax> Alias <em>URL-path
- file-path</em>|<em>directory-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-
-<p>The <code class="directive">Alias</code> directive allows documents to
+ <p>The <code class="directive">Alias</code> directive allows documents to
be stored in the local filesystem other than under the
- <code class="directive"><a href="core.html#documentroot" class="directive">DocumentRoot</a></code>. URLs with a
+ <a href="core.html#documentroot" class="directive"><code class="directive">DocumentRoot</code></a>. URLs with a
(%-decoded) path beginning with <em>url-path</em> will be mapped
to local files beginning with <em>directory-filename</em>.</p>
+ <p>Example:</p>
-<p>Example:</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>Alias /image /ftp/pub/image</code></td>
-</tr>
-</table>
-</blockquote>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Alias /image /ftp/pub/image</code></td></tr></table></blockquote>
-<p>A request for http://myserver/image/foo.gif would cause the
+ <p>A request for http://myserver/image/foo.gif would cause the
server to return the file /ftp/pub/image/foo.gif.</p>
-
-<p>Note that if you include a trailing / on the
+ <p>Note that if you include a trailing / on the
<em>url-path</em> then the server will require a trailing / in
order to expand the alias. That is, if you use <code>Alias
/icons/ /usr/local/apache/icons/</code> then the url
<code>/icons</code> will not be aliased.</p>
-
-<p>Note that you may need to specify additional <code class="directive"><a href="core.html#<directory>" class="directive"><Directory></a></code> sections which cover
+ <p>Note that you may need to specify additional <a href="core.html#<directory>" class="directive"><code class="directive"><Directory></code></a> sections which cover
the <em>destination</em> of aliases. Aliasing occurs before
- <code class="directive"><a href="core.html#<directory>" class="directive"><Directory></a></code> sections
+ <a href="core.html#<directory>" class="directive"><code class="directive"><Directory></code></a> sections
are checked, so only the destination of aliases are affected.
- (Note however <code class="directive"><a href="core.html#<location>" class="directive"><Location></a></code>
+ (Note however <a href="core.html#<location>" class="directive"><code class="directive"><Location></code></a>
sections are run through once before aliases are performed, so
they will apply.)</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AliasMatch">AliasMatch</a> <a name="aliasmatch">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maps URLs to filesystem locations using regular
-expressions</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AliasMatch <em>regex
- file-path</em>|<em>directory-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive is equivalent to <code class="directive"><a href="#alias" class="directive">Alias</a></code>, but makes use of standard
+</usage><hr/><h2><a name="AliasMatch">AliasMatch</a> <a name="aliasmatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps URLs to filesystem locations using regular
+expressions</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AliasMatch <em>regex
+ file-path</em>|<em>directory-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table><usage>
+ <p>This directive is equivalent to <a href="#alias" class="directive"><code class="directive">Alias</code></a>, but makes use of standard
regular expressions, instead of simple prefix matching. The
supplied regular expression is matched against the URL-path, and
if it matches, the server will substitute any parenthesized
matches into the given string and use it as a filename. For
example, to activate the <code>/icons</code> directory, one might
use:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AliasMatch ^/icons(.*) /usr/local/apache/icons$1
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="Redirect">Redirect</a> <a name="redirect">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sends an external redirect asking the client to fetch
-a different URL</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Redirect [<em>status</em>] <em>URL-path URL</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The Redirect directive maps an old URL into a new one. The
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="Redirect">Redirect</a> <a name="redirect">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external redirect asking the client to fetch
+a different URL</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Redirect [<em>status</em>] <em>URL-path URL</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table><usage>
+ <p>The Redirect directive maps an old URL into a new one. The
new URL is returned to the client which attempts to fetch it
again with the new address. <em>URL-path</em> a (%-decoded)
path; any requests for documents beginning with this path will
be returned a redirect error to a new (%-encoded) URL beginning
with <em>URL</em>.</p>
+ <p>Example:</p>
-<p>Example:</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>Redirect /service http://foo2.bar.com/service</code></td>
-</tr>
-</table>
-</blockquote>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Redirect /service http://foo2.bar.com/service</code></td></tr></table></blockquote>
-<p>If the client requests http://myserver/service/foo.txt, it
+ <p>If the client requests http://myserver/service/foo.txt, it
will be told to access http://foo2.bar.com/service/foo.txt
instead.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Note</strong>
-</p>
-<p>Redirect directives take precedence over
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p> <p>Redirect directives take precedence over
Alias and ScriptAlias directives, irrespective of their ordering in
the configuration file. Also, <em>URL-path</em> must be an absolute
path, not a relative path, even when used with .htaccess files or
-inside of <code class="directive"><a href="core.html#<directory>" class="directive"><Directory></a></code>
-sections.</p>
-</td>
-</tr>
-</table>
-</blockquote>
-
+inside of <a href="core.html#<directory>" class="directive"><code class="directive"><Directory></code></a>
+sections.</p></td></tr></table></blockquote>
-<p>If no <em>status</em> argument is given, the redirect will
+ <p>If no <em>status</em> argument is given, the redirect will
be "temporary" (HTTP status 302). This indicates to the client
that the resource has moved temporarily. The <em>status</em>
argument can be used to return other HTTP status codes:</p>
+ <dl>
+ <dt>permanent</dt>
-<dl>
-
-<dt>permanent</dt>
-
-
-<dd>Returns a permanent redirect status (301) indicating that
+ <dd>Returns a permanent redirect status (301) indicating that
the resource has moved permanently.</dd>
+ <dt>temp</dt>
-<dt>temp</dt>
-
-
-<dd>Returns a temporary redirect status (302). This is the
+ <dd>Returns a temporary redirect status (302). This is the
default.</dd>
+ <dt>seeother</dt>
-<dt>seeother</dt>
-
-
-<dd>Returns a "See Other" status (303) indicating that the
+ <dd>Returns a "See Other" status (303) indicating that the
resource has been replaced.</dd>
+ <dt>gone</dt>
-<dt>gone</dt>
-
-
-<dd>Returns a "Gone" status (410) indicating that the
+ <dd>Returns a "Gone" status (410) indicating that the
resource has been permanently removed. When this status is
used the <em>url</em> argument should be omitted.</dd>
+ </dl>
-</dl>
-
-
-<p>Other status codes can be returned by giving the numeric
+ <p>Other status codes can be returned by giving the numeric
status code as the value of <em>status</em>. If the status is
between 300 and 399, the <em>url</em> argument must be present,
otherwise it must be omitted. Note that the status must be
known to the Apache code (see the function
<code>send_error_response</code> in http_protocol.c).</p>
-
-</usage>
-<hr>
-<h2>
-<a name="RedirectMatch">RedirectMatch</a> <a name="redirectmatch">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sends an external redirect asking the client to fetch
+</usage><hr/><h2><a name="RedirectMatch">RedirectMatch</a> <a name="redirectmatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external redirect asking the client to fetch
a different URL based on a regular expression match of the
-current URL</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RedirectMatch [<em>status</em>] <em>regex URL</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive is equivalent to <code class="directive"><a href="#redirect" class="directive">Redirect</a></code>, but makes use of standard
+current URL</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RedirectMatch [<em>status</em>] <em>regex URL</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table><usage>
+ <p>This directive is equivalent to <a href="#redirect" class="directive"><code class="directive">Redirect</code></a>, but makes use of standard
regular expressions, instead of simple prefix matching. The
supplied regular expression is matched against the URL-path, and
if it matches, the server will substitute any parenthesized
matches into the given string and use it as a filename. For
example, to redirect all GIF files to like-named JPEG files on
another server, one might use:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
RedirectMatch (.*)\.gif$ http://www.anotherserver.com$1.jpg
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="RedirectPermanent">RedirectPermanent</a> <a name="redirectpermanent">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sends an external permanent redirect asking the client to fetch
-a different URL</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RedirectPermanent <em>URL-path URL</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive makes the client know that the Redirect is
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="RedirectPermanent">RedirectPermanent</a> <a name="redirectpermanent">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external permanent redirect asking the client to fetch
+a different URL</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RedirectPermanent <em>URL-path URL</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table><usage>
+ <p>This directive makes the client know that the Redirect is
permanent (status 301). Exactly equivalent to <code>Redirect
permanent</code>.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="RedirectTemp">RedirectTemp</a> <a name="redirecttemp">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sends an external temporary redirect asking the client to fetch
-a different URL</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RedirectTemp <em>URL-path URL</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive makes the client know that the Redirect is
+</usage><hr/><h2><a name="RedirectTemp">RedirectTemp</a> <a name="redirecttemp">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external temporary redirect asking the client to fetch
+a different URL</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RedirectTemp <em>URL-path URL</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table><usage>
+ <p>This directive makes the client know that the Redirect is
only temporary (status 302). Exactly equivalent to
<code>Redirect temp</code>.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ScriptAlias">ScriptAlias</a> <a name="scriptalias">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maps a URL to a filesystem location and designates the
-target as a CGI script</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ScriptAlias
-<em>URL-path file-path</em>|<em>directory-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ScriptAlias</code> directive has the same
- behavior as the <code class="directive"><a href="#alias" class="directive">Alias</a></code>
+</usage><hr/><h2><a name="ScriptAlias">ScriptAlias</a> <a name="scriptalias">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps a URL to a filesystem location and designates the
+target as a CGI script</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ScriptAlias
+<em>URL-path file-path</em>|<em>directory-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ScriptAlias</code> directive has the same
+ behavior as the <a href="#alias" class="directive"><code class="directive">Alias</code></a>
directive, except that in addition it marks the target directory
as containing CGI scripts that will be processed by <code><a href="mod_cgi.html">mod_cgi</a></code>'s cgi-script handler. URLs with a
(%-decoded) path beginning with <em>URL-path</em> will be mapped
to scripts beginning with the second argument which is a full
pathname in the local filesystem.</p>
+ <p>Example:</p>
-<p>Example:</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>ScriptAlias /cgi-bin/ /web/cgi-bin/</code></td>
-</tr>
-</table>
-</blockquote>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>ScriptAlias /cgi-bin/ /web/cgi-bin/</code></td></tr></table></blockquote>
-<p>A request for <code>http://myserver/cgi-bin/foo</code> would cause the
+ <p>A request for <code>http://myserver/cgi-bin/foo</code> would cause the
server to run the script <code>/web/cgi-bin/foo</code>.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ScriptAliasMatch">ScriptAliasMatch</a> <a name="scriptaliasmatch">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maps a URL to a filesystem location using a regular expression
-and designates the target as a CGI script</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ScriptAliasMatch
-<em>regex file-path</em>|<em>directory-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive is equivalent to <code class="directive"><a href="#scriptalias" class="directive">ScriptAlias</a></code>, but makes use of standard
+</usage><hr/><h2><a name="ScriptAliasMatch">ScriptAliasMatch</a> <a name="scriptaliasmatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps a URL to a filesystem location using a regular expression
+and designates the target as a CGI script</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ScriptAliasMatch
+<em>regex file-path</em>|<em>directory-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table><usage>
+ <p>This directive is equivalent to <a href="#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a>, but makes use of standard
regular expressions, instead of simple prefix matching. The
supplied regular expression is matched against the URL-path,
and if it matches, the server will substitute any parenthesized
matches into the given string and use it as a filename. For
example, to activate the standard <code>/cgi-bin</code>, one
might use:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
ScriptAliasMatch ^/cgi-bin(.*) /usr/local/apache/cgi-bin$1
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</code></td></tr></table></blockquote>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.14 +18 -84 httpd-2.0/docs/manual/mod/mod_asis.html
Index: mod_asis.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_asis.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -b -u -r1.13 -r1.14
--- mod_asis.html 19 Feb 2002 18:37:19 -0000 1.13
+++ mod_asis.html 6 Mar 2002 17:08:19 -0000 1.14
@@ -1,98 +1,42 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_asis - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_asis</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Sends files that contain their own
-HTTP headers</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>asis_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>This module provides the handler <code>send-as-is</code>
+--><title>mod_asis - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_asis</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Sends files that contain their own
+HTTP headers</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>asis_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This module provides the handler <code>send-as-is</code>
which causes Apache to send the document without adding most of
the usual HTTP headers.</p>
-
-<p>This can be used to send any kind of data from the server,
+ <p>This can be used to send any kind of data from the server,
including redirects and other special HTTP responses, without
requiring a cgi-script or an nph script.</p>
-
-<p>For historical reasons, this module will also process any
+ <p>For historical reasons, this module will also process any
file with the mime type <code>httpd/send-as-is</code>.</p>
+</summary><h2>Directives</h2><p>This module provides no directives.</p><h2>Usage</h2>
-</summary>
-<h2>Directives</h2>
-<p>This module provides no directives.</p>
-<h2>Usage</h2>
-
-
-<p>In the server configuration file, associate files with the
- <code>send-as-is</code> handler <em>e.g.</em>
-</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>AddHandler send-as-is asis</code></td>
-</tr>
-</table>
-</blockquote>
+ <p>In the server configuration file, associate files with the
+ <code>send-as-is</code> handler <em>e.g.</em></p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddHandler send-as-is asis</code></td></tr></table></blockquote>
-<p>The contents of any file with a <code>.asis</code> extension
+ <p>The contents of any file with a <code>.asis</code> extension
will then be sent by Apache to the client with almost no
changes. Clients will need HTTP headers to be attached, so do
not forget them. A Status: header is also required; the data
should be the 3-digit HTTP response code, followed by a textual
message.</p>
-
-<p>Here's an example of a file whose contents are sent <em>as
+ <p>Here's an example of a file whose contents are sent <em>as
is</em> so as to tell the client that a file has
redirected.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>Status: 301 Now where did I leave that URL<br>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Status: 301 Now where did I leave that URL<br>
Location: http://xyz.abc.com/foo/bar.html<br>
Content-type: text/html<br>
-
-<br>
+ <br>
<HTML><br>
<HEAD><br>
<TITLE>Lame excuses'R'us</TITLE><br>
@@ -106,20 +50,10 @@
</H1><br>
</BODY><br>
</HTML>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>Notes: the server always adds a Date: and Server: header to
+ <p>Notes: the server always adds a Date: and Server: header to
the data returned to the client, so these should not be
included in the file. The server does <em>not</em> add a
Last-Modified header; it probably should. </p>
-
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+<hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.26 +42 -294 httpd-2.0/docs/manual/mod/mod_auth.html
Index: mod_auth.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_auth.html,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -d -b -u -r1.25 -r1.26
--- mod_auth.html 19 Feb 2002 18:37:19 -0000 1.25
+++ mod_auth.html 6 Mar 2002 17:08:19 -0000 1.26
@@ -1,131 +1,23 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_auth - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_auth</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>User authentication using text files</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>auth_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
+--><title>mod_auth - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_auth</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>User authentication using text files</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>auth_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
-<p>This module allows the use of HTTP Basic Authentication to
+ <p>This module allows the use of HTTP Basic Authentication to
restrict access by looking up users in plain text password and
group files. Similar functionality and greater scalability is
provided by <code><a href="mod_auth_dbm.html">mod_auth_dbm</a></code>. HTTP Digest
Authentication is provided by
<code><a href="mod_auth_digest.html">mod_auth_digest</a></code>.</p>
+</summary><p><strong>See also </strong></p><ul><li><a href="core.html#require" class="directive"><code class="directive">Require</code></a></li><li><a href="core.html#satisfy" class="directive"><code class="directive">Satisfy</code></a></li><li><a href="core.html#authname" class="directive"><code class="directive">AuthName</code></a></li><li><a href="core.html#authtype" class="directive"><code class="directive">AuthType</code></a></li></ul><h2>Directives</h2><ul><li><a href="#authauthoritative">AuthAuthoritative</a></li><li><a href="#authgroupfile">AuthGroupFile</a></li><li><a href="#authuserfile">AuthUserFile</a></li></ul><hr/><h2><a name="AuthAuthoritative">AuthAuthoritative</a> <a name="authauthoritative">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets whether authorization and authentication are
+passed to lower level modules</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthAuthoritative on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthAuthoritative on</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth</td></tr></table></td></tr></table><usage>
-</summary>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="core.html#require" class="directive">Require</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#satisfy" class="directive">Satisfy</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#authname" class="directive">AuthName</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#authtype" class="directive">AuthType</a></code>
-</li>
-</ul>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#authgroupfile">AuthGroupFile</a>
-</li>
-<li>
-<a href="#authuserfile">AuthUserFile</a>
-</li>
-<li>
-<a href="#authauthoritative">AuthAuthoritative</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="AuthAuthoritative">AuthAuthoritative</a> <a name="authauthoritative">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets whether authorization and authentication are
-passed to lower level modules</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthAuthoritative on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthAuthoritative on</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">This information has not been updated for Apache 2.0, which
-uses a different system for module ordering.</td>
-</tr>
-</table>
-</blockquote>
-
+<blockquote><table><tr><td bgcolor="#e0e5f5">This information has not been updated for Apache 2.0, which
+uses a different system for module ordering.</td></tr></table></blockquote>
-<p>Setting the <code class="directive">AuthAuthoritative</code> directive
+ <p>Setting the <code class="directive">AuthAuthoritative</code> directive
explicitly to <strong>'off'</strong> allows for both
authentication and authorization to be passed on to lower level
modules (as defined in the <code>Configuration</code> and
@@ -135,234 +27,90 @@
password and access checks will be applied and a failure will give
an Authorization Required reply.</p>
-
-<p>So if a userID appears in the database of more than one module;
- or if a valid <code class="directive"><a href="core.html#require" class="directive">Require</a></code>
+ <p>So if a userID appears in the database of more than one module;
+ or if a valid <a href="core.html#require" class="directive"><code class="directive">Require</code></a>
directive applies to more than one module; then the first module
will verify the credentials; and no access is passed on;
regardless of the AuthAuthoritative setting.</p>
-
-<p>A common use for this is in conjunction with one of the
+ <p>A common use for this is in conjunction with one of the
database modules; such as <code><a href="auth_dbm.html">auth_dbm</a></code>,
<code>mod_auth_msql</code>, and <code><a href="mod_auth_anon.html">mod_auth_anon</a></code>.
These modules supply the bulk of the user credential checking; but
a few (administrator) related accesses fall through to a lower
- level with a well protected <code class="directive"><a href="#authuserfile" class="directive">AuthUserFile</a></code>.</p>
-
+ level with a well protected <a href="#authuserfile" class="directive"><code class="directive">AuthUserFile</code></a>.</p>
-<p>By default; control is not passed on; and an unknown userID or
+ <p>By default; control is not passed on; and an unknown userID or
rule will result in an Authorization Required reply. Not setting
it thus keeps the system secure; and forces an NCSA compliant
behaviour.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Security</strong>
-</p> Do consider the implications of
+ <blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Security</strong></p> Do consider the implications of
allowing a user to allow fall-through in his .htaccess file; and
verify that this is really what you want; Generally it is easier
to just secure a single .htpasswd file, than it is to secure a
- database such as mSQL. Make sure that the <code class="directive"><a href="#authuserfile" class="directive">AuthUserFile</a></code> is stored outside the
+ database such as mSQL. Make sure that the <a href="#authuserfile" class="directive"><code class="directive">AuthUserFile</code></a> is stored outside the
document tree of the web-server; do <em>not</em> put it in the
directory that it protects. Otherwise, clients will be able to
- download the <code class="directive"><a href="#authuserfile" class="directive">AuthUserFile</a></code>.
- </td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthGroupFile">AuthGroupFile</a> <a name="authgroupfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the name of a text file containing the list
-of user groups for authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthGroupFile <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthGroupFile</code> directive sets the
+ download the <a href="#authuserfile" class="directive"><code class="directive">AuthUserFile</code></a>.
+ </td></tr></table></blockquote>
+</usage><hr/><h2><a name="AuthGroupFile">AuthGroupFile</a> <a name="authgroupfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the name of a text file containing the list
+of user groups for authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthGroupFile <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthGroupFile</code> directive sets the
name of a textual file containing the list of user groups for user
authentication. <em>File-path</em> is the path to the group
file. If it is not absolute (<em>i.e.</em>, if it doesn't begin
- with a slash), it is treated as relative to the <code class="directive"><a href="core.html#serverroot" class="directive">ServerRoot</a></code>.</p>
-
+ with a slash), it is treated as relative to the <a href="core.html#serverroot" class="directive"><code class="directive">ServerRoot</code></a>.</p>
-<p>Each line of the group file contains a groupname followed by a
+ <p>Each line of the group file contains a groupname followed by a
colon, followed by the member usernames separated by spaces.
Example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>mygroup: bob joe anne</code></td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>mygroup: bob joe anne</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>Note that searching large text files is <em>very</em>
- inefficient; <code class="directive"><a href="mod_auth_dbm.html#authdbmgroupfile" class="directive">AuthDBMGroupFile</a></code> should be used
+ <p>Note that searching large text files is <em>very</em>
+ inefficient; <a href="mod_auth_dbm.html#authdbmgroupfile" class="directive"><code class="directive">AuthDBMGroupFile</code></a> should be used
instead.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Security</strong>
-</p>
-
-<p>Make sure that the AuthGroupFile is stored outside
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Security</strong></p>
+ <p>Make sure that the AuthGroupFile is stored outside
the document tree of the web-server; do <em>not</em> put it in
the directory that it protects. Otherwise, clients will be able
to download the AuthGroupFile.</p>
-
-</td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthUserFile">AuthUserFile</a> <a name="authuserfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the name of a text file containing the list of users and
-passwords for authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthUserFile <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthUserFile</code> directive sets the name
+</td></tr></table></blockquote>
+</usage><hr/><h2><a name="AuthUserFile">AuthUserFile</a> <a name="authuserfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the name of a text file containing the list of users and
+passwords for authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthUserFile <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthUserFile</code> directive sets the name
of a textual file containing the list of users and passwords for
user authentication. <em>File-path</em> is the path to the user
file. If it is not absolute (<em>i.e.</em>, if it doesn't begin
- with a slash), it is treated as relative to the <code class="directive"><a href="core.html#serverroot" class="directive">ServerRoot</a></code>.</p>
-
+ with a slash), it is treated as relative to the <a href="core.html#serverroot" class="directive"><code class="directive">ServerRoot</code></a>.</p>
-<p>Each line of the user file file contains a username followed by
+ <p>Each line of the user file file contains a username followed by
a colon, followed by the <code>crypt()</code> encrypted
password. The behavior of multiple occurrences of the same user is
undefined.</p>
-
-<p>The utility <a href="../programs/htpasswd.html">htpasswd</a>
+ <p>The utility <a href="../programs/htpasswd.html">htpasswd</a>
which is installed as part of the binary distribution, or which
can be found in <code>src/support</code>, is used to maintain
this password file. See the <code>man</code> page for more
details. In short:</p>
-
-<p>Create a password file 'Filename' with 'username' as the
+ <p>Create a password file 'Filename' with 'username' as the
initial ID. It will prompt for the password:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>htpasswd -c Filename username</code></td>
-</tr>
-</table>
-</blockquote>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>htpasswd -c Filename username</code></td></tr></table></blockquote>
<p>Adds or modifies in password file 'Filename' the 'username':</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>htpasswd Filename username2</code></td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>htpasswd Filename username2</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>Note that searching large text files is <em>very</em>
- inefficient; <code class="directive"><a href="mod_auth_dbm.html#authdbmuserfile" class="directive">AuthDBMUserFile</a></code> should be used
+ <p>Note that searching large text files is <em>very</em>
+ inefficient; <a href="mod_auth_dbm.html#authdbmuserfile" class="directive"><code class="directive">AuthDBMUserFile</code></a> should be used
instead.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Security</strong>
-</p>
-<p>Make sure that the AuthUserFile is
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Security</strong></p><p>Make sure that the AuthUserFile is
stored outside the document tree of the web-server; do <em>not</em>
put it in the directory that it protects. Otherwise, clients will be
-able to download the AuthUserFile.</p>
-</td>
-</tr>
-</table>
-</blockquote>
-
+able to download the AuthUserFile.</p></td></tr></table></blockquote>
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.30 +41 -361 httpd-2.0/docs/manual/mod/mod_auth_anon.html
Index: mod_auth_anon.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_auth_anon.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -d -b -u -r1.29 -r1.30
--- mod_auth_anon.html 20 Feb 2002 15:58:40 -0000 1.29
+++ mod_auth_anon.html 6 Mar 2002 17:08:19 -0000 1.30
@@ -1,133 +1,60 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_auth_anon - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_auth_anon</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Allows "anonymous" user access to authenticated
- areas</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>auth_anon_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>This module does access control in a manner similar to
+--><title>mod_auth_anon - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_auth_anon</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Allows "anonymous" user access to authenticated
+ areas</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>auth_anon_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This module does access control in a manner similar to
anonymous-ftp sites; <em>i.e.</em> have a 'magic' user id
'anonymous' and the email address as a password. These email
addresses can be logged.</p>
-
-<p>Combined with other (database) access control methods, this
+ <p>Combined with other (database) access control methods, this
allows for effective user tracking and customization according
to a user profile while still keeping the site open for
'unregistered' users. One advantage of using Auth-based user
tracking is that, unlike magic-cookies and funny URL
pre/postfixes, it is completely browser independent and it
allows users to share URLs.</p>
+</summary><h2>Directives</h2><ul><li><a href="#anonymous">Anonymous</a></li><li><a href="#anonymous_authoritative">Anonymous_Authoritative</a></li><li><a href="#anonymous_logemail">Anonymous_LogEmail</a></li><li><a href="#anonymous_mustgiveemail">Anonymous_MustGiveEmail</a></li><li><a href="#anonymous_nouserid">Anonymous_NoUserID</a></li><li><a href="#anonymous_verifyemail">Anonymous_VerifyEmail</a></li></ul><h2>Example</h2>
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#anonymous">Anonymous</a>
-</li>
-<li>
-<a href="#anonymous_authoritative">Anonymous_Authoritative</a>
-</li>
-<li>
-<a href="#anonymous_logemail">Anonymous_LogEmail</a>
-</li>
-<li>
-<a href="#anonymous_mustgiveemail">Anonymous_MustGiveEmail</a>
-</li>
-<li>
-<a href="#anonymous_nouserid">Anonymous_NoUserID</a>
-</li>
-<li>
-<a href="#anonymousverifyemail">AnonymousVerifyEmail</a>
-</li>
-</ul>
-<h2>Example</h2>
-
-
-<p>The example below (when combined with the Auth directives of a
+ <p>The example below (when combined with the Auth directives of a
htpasswd-file based (or GDM, mSQL <em>etc.</em>) base access
control system allows users in as 'guests' with the following
properties:</p>
-
-<ul>
-
-<li>It insists that the user enters a userId.
+ <ul>
+ <li>It insists that the user enters a userId.
(<code>Anonymous_NoUserId</code>)</li>
-
-<li>It insists that the user enters a password.
+ <li>It insists that the user enters a password.
(<code>Anonymous_MustGiveEmail</code>)</li>
-
-<li>The password entered must be a valid email address, ie.
+ <li>The password entered must be a valid email address, ie.
contain at least one '@' and a '.'.
(<code>Anonymous_VerifyEmail</code>)</li>
-
-<li>The userID must be one of <code>anonymous guest www test
+ <li>The userID must be one of <code>anonymous guest www test
welcome</code> and comparison is <strong>not</strong> case
sensitive.</li>
-
-<li>And the Email addresses entered in the passwd field are
+ <li>And the Email addresses entered in the passwd field are
logged to the error log file
(<code>Anonymous_LogEmail</code>)</li>
+ </ul>
-</ul>
-
-
-<p>Excerpt of httpd.conf:</p>
-
+ <p>Excerpt of httpd.conf:</p>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Anonymous_NoUserId off<br>
Anonymous_MustGiveEmail on<br>
Anonymous_VerifyEmail on<br>
Anonymous_LogEmail on<br>
Anonymous anonymous guest www test welcome<br>
-
<br>
AuthName "Use 'anonymous' & Email address for
guest entry"<br>
AuthType basic<br>
-
<br>
# An
AuthUserFile/AuthDBUserFile/AuthDBMUserFile<br>
@@ -137,303 +64,56 @@
<Files *><br>
Order Deny,Allow<br>
Allow from all<br>
-
<br>
Require valid-user<br>
</Files><br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<hr>
-<h2>
-<a name="Anonymous">Anonymous</a> <a name="anonymous">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Specifies userIDs that areallowed access without
-password verification</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Anonymous <em>user</em> [<em>user</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>A list of one or more 'magic' userIDs which are allowed
+</code></td></tr></table></blockquote>
+<hr/><h2><a name="Anonymous">Anonymous</a> <a name="anonymous">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Specifies userIDs that areallowed access without
+password verification</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous <em>user</em> [<em>user</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
+ <p>A list of one or more 'magic' userIDs which are allowed
access without password verification. The userIDs are space
separated. It is possible to use the ' and " quotes to allow a
space in a userID as well as the \ escape character.</p>
-
-<p>Please note that the comparison is
+ <p>Please note that the comparison is
<strong>case-IN-sensitive</strong>.<br>
I strongly suggest that the magic username
'<code>anonymous</code>' is always one of the allowed
userIDs.</p>
+ <p>Example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Anonymous anonymous "Not Registered" 'I don\'t know'</code></td></tr></table></blockquote>
-<p>Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>Anonymous anonymous "Not Registered" 'I don\'t know'</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>This would allow the user to enter without password
+ <p>This would allow the user to enter without password
verification by using the userId's 'anonymous',
'AnonyMous','Not Registered' and 'I Don't Know'.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Anonymous_Authoritative">Anonymous_Authoritative</a> <a name="anonymous_authoritative">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Configures if authorization will fall-through
-to other methods</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Anonymous_Authoritative on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_Authoritative off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>When set 'on', there is no fall-through to other authorization
+</usage><hr/><h2><a name="Anonymous_Authoritative">Anonymous_Authoritative</a> <a name="anonymous_authoritative">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures if authorization will fall-through
+to other methods</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_Authoritative on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_Authoritative off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
+ <p>When set 'on', there is no fall-through to other authorization
methods. So if a userID does not match the values specified in the
- <code class="directive"><a href="#anonymous" class="directive">Anonymous</a></code> directive,
+ <a href="#anonymous" class="directive"><code class="directive">Anonymous</code></a> directive,
access is denied.</p>
-
-<p>Be sure you know what you are doing when you decide to
+ <p>Be sure you know what you are doing when you decide to
switch it on. And remember that it is the linking order of the
modules (in the Configuration / Make file) which details the
order in which the Authorization modules are queried.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Anonymous_LogEmail">Anonymous_LogEmail</a> <a name="anonymous_logemail">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets whether the password entered will be logged in the
-error log</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Anonymous_LogEmail on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_LogEmail on</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>When set <code>on</code>, the default, the 'password' entered
+</usage><hr/><h2><a name="Anonymous_LogEmail">Anonymous_LogEmail</a> <a name="anonymous_logemail">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets whether the password entered will be logged in the
+error log</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_LogEmail on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_LogEmail on</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
+ <p>When set <code>on</code>, the default, the 'password' entered
(which hopefully contains a sensible email address) is logged in
the error log.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Anonymous_MustGiveEmail">Anonymous_MustGiveEmail</a> <a name="anonymous_mustgiveemail">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Specifies whether blank passwords are allowed</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Anonymous_MustGiveEmail on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_MustGiveEmail on</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Specifies whether the user must specify an email address as
+</usage><hr/><h2><a name="Anonymous_MustGiveEmail">Anonymous_MustGiveEmail</a> <a name="anonymous_mustgiveemail">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Specifies whether blank passwords are allowed</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_MustGiveEmail on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_MustGiveEmail on</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
+ <p>Specifies whether the user must specify an email address as
the password. This prohibits blank passwords.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Anonymous_NoUserID">Anonymous_NoUserID</a> <a name="anonymous_nouserid">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets whether the userID field may be empty</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Anonymous_NoUserID on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_NoUserID off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>When set <code>on</code>, users can leave the userID (and
+</usage><hr/><h2><a name="Anonymous_NoUserID">Anonymous_NoUserID</a> <a name="anonymous_nouserid">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets whether the userID field may be empty</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_NoUserID on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_NoUserID off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
+ <p>When set <code>on</code>, users can leave the userID (and
perhaps the password field) empty. This can be very convenient for
MS-Explorer users who can just hit return or click directly on the
OK button; which seems a natural reaction.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AnonymousVerifyEmail">AnonymousVerifyEmail</a> <a name="anonymousverifyemail">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets whether to check the password field for a correctly
-formatted email address</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Anonymous_VerifyEmail on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_VerifyEmail off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>When set <code>on</code> the 'password' entered is checked for
+</usage><hr/><h2><a name="Anonymous_VerifyEmail">Anonymous_VerifyEmail</a> <a name="anonymous_verifyemail">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets whether to check the password field for a correctly
+formatted email address</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_VerifyEmail on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_VerifyEmail off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
+ <p>When set <code>on</code> the 'password' entered is checked for
at least one '@' and a '.' to encourage users to enter valid email
- addresses (see the above <code class="directive"><a href="#auth_logemail" class="directive">Auth_LogEmail</a></code>).</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+ addresses (see the above <a href="#auth_logemail" class="directive"><code class="directive">Auth_LogEmail</code></a>).</p>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.30 +36 -295 httpd-2.0/docs/manual/mod/mod_auth_dbm.html
Index: mod_auth_dbm.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_auth_dbm.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -d -b -u -r1.29 -r1.30
--- mod_auth_dbm.html 20 Feb 2002 16:17:40 -0000 1.29
+++ mod_auth_dbm.html 6 Mar 2002 17:08:19 -0000 1.30
@@ -1,131 +1,20 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_auth_dbm - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_auth_dbm</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Provides for user authentication using DBM
- files</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>auth_dbm_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>This module provides for HTTP Basic Authentication, where
+--><title>mod_auth_dbm - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_auth_dbm</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Provides for user authentication using DBM
+ files</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>auth_dbm_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This module provides for HTTP Basic Authentication, where
the usernames and passwords are stored in DBM type database
files. It is an alternative to the plain text password files
provided by <code><a href="mod_auth.html">mod_auth</a></code>.</p>
+</summary><p><strong>See also </strong></p><ul><li><a href="core.html#authname" class="directive"><code class="directive">AuthName</code></a></li><li><a href="core.html#authtype" class="directive"><code class="directive">AuthType</code></a></li><li><a href="core.html#require" class="directive"><code class="directive">Require</code></a></li><li><a href="core.html#satisfy" class="directive"><code class="directive">Satisfy</code></a></li></ul><h2>Directives</h2><ul><li><a href="#authdbmauthoritative">AuthDBMAuthoritative</a></li><li><a href="#authdbmgroupfile">AuthDBMGroupFile</a></li><li><a href="#authdbmtype">AuthDBMType</a></li><li><a href="#authdbmuserfile">AuthDBMUserFile</a></li></ul><hr/><h2><a name="AuthDBMAuthoritative">AuthDBMAuthoritative</a> <a name="authdbmauthoritative">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets whether authentication and authorization will be
+passwed on to lower level modules</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDBMAuthoritative on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDBMAuthoritative on</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_dbm</td></tr></table></td></tr></table><usage>
-</summary>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="core.html#authname" class="directive">AuthName</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#authtype" class="directive">AuthType</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#require" class="directive">Require</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#satisfy" class="directive">Satisfy</a></code>
-</li>
-</ul>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#authdbmgroupfile">AuthDBMGroupFile</a>
-</li>
-<li>
-<a href="#authdbmuserfile">AuthDBMUserFile</a>
-</li>
-<li>
-<a href="#authdbmtype">AuthDBMType</a>
-</li>
-<li>
-<a href="#authdbmauthoritative">AuthDBMAuthoritative</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="AuthDBMAuthoritative">AuthDBMAuthoritative</a> <a name="authdbmauthoritative">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets whether authentication and authorization will be
-passwed on to lower level modules</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDBMAuthoritative on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDBMAuthoritative on</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_dbm</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">This information has not been updated to take into account the
-new module ordering techniques in Apache 2.0</td>
-</tr>
-</table>
-</blockquote>
-
+<blockquote><table><tr><td bgcolor="#e0e5f5">This information has not been updated to take into account the
+new module ordering techniques in Apache 2.0</td></tr></table></blockquote>
-<p>Setting the <code class="directive">AuthDBMAuthoritative</code>
+ <p>Setting the <code class="directive">AuthDBMAuthoritative</code>
directive explicitly to <strong>'off'</strong> allows for both
authentication and authorization to be passed on to lower level
modules (as defined in the <code>Configuration</code> and
@@ -135,91 +24,48 @@
checks will be applied and a failure will give an Authorization
Required reply.</p>
-
-<p>So if a userID appears in the database of more than one module;
- or if a valid <code class="directive"><a href="core.html#require" class="directive">Require</a></code>
+ <p>So if a userID appears in the database of more than one module;
+ or if a valid <a href="core.html#require" class="directive"><code class="directive">Require</code></a>
directive applies to more than one module; then the first module
will verify the credentials; and no access is passed on;
regardless of the <code class="directive">AuthAuthoritative</code> setting.</p>
-
-<p>A common use for this is in conjunction with one of the
+ <p>A common use for this is in conjunction with one of the
basic auth modules; such as <code><a href="mod_auth.html">mod_auth</a></code>. Whereas this
DBM module supplies the bulk of the user credential checking; a
few (administrator) related accesses fall through to a lower
level with a well protected .htpasswd file.</p>
-
-<p>By default, control is not passed on and an unknown userID
+ <p>By default, control is not passed on and an unknown userID
or rule will result in an Authorization Required reply. Not
setting it thus keeps the system secure and forces an NCSA
compliant behaviour.</p>
-
-<p>Security: Do consider the implications of allowing a user to
+ <p>Security: Do consider the implications of allowing a user to
allow fall-through in his .htaccess file; and verify that this
is really what you want; Generally it is easier to just secure
a single .htpasswd file, than it is to secure a database which
might have more access interfaces.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the name of the database file containing the list
-of user groups for authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDBMGroupFile <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_dbm</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthDBMGroupFile</code> directive sets the
+</usage><hr/><h2><a name="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the name of the database file containing the list
+of user groups for authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDBMGroupFile <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_dbm</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthDBMGroupFile</code> directive sets the
name of a DBM file containing the list of user groups for user
authentication. <em>File-path</em> is the absolute path to the
group file.</p>
-
-<p>The group file is keyed on the username. The value for a
+ <p>The group file is keyed on the username. The value for a
user is a comma-separated list of the groups to which the users
belongs. There must be no whitespace within the value, and it
must never contain any colons.</p>
-
-<p>Security: make sure that the
+ <p>Security: make sure that the
<code class="directive">AuthDBMGroupFile</code> is stored outside the
document tree of the web-server; do <em>not</em> put it in the
directory that it protects. Otherwise, clients will be able to
download the <code class="directive">AuthDBMGroupFile</code> unless
otherwise protected.</p>
-
-<p>Combining Group and Password DBM files: In some cases it is
+ <p>Combining Group and Password DBM files: In some cases it is
easier to manage a single database which contains both the
password and group details for each user. This simplifies any
support programs that need to be written: they now only have to
@@ -227,149 +73,52 @@
accomplished by first setting the group and password files to
point to the same DBM:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AuthDBMGroupFile /www/userbase<br>
AuthDBMUserFile /www/userbase
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>The key for the single DBM is the username. The value consists
+ <p>The key for the single DBM is the username. The value consists
of</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Unix Crypt-ed Password : List of Groups [ : (ignored)
+ ]</code></td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>Unix Crypt-ed Password : List of Groups [ : (ignored)
- ]</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>The password section contains the Unix <code>crypt()</code>
+ <p>The password section contains the Unix <code>crypt()</code>
password as before. This is followed by a colon and the comma
separated list of groups. Other data may optionally be left in the
DBM file after another colon; it is ignored by the authentication
module. This is what www.telescope.org uses for its combined
password and group database.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDBMType">AuthDBMType</a> <a name="authdbmtype">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the type of database file that is used to
-store passwords</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDBMType default|SDBM|GDBM|DB</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDBMType default</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_dbm</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in version 2.0.30 and later.</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
+</usage><hr/><h2><a name="AuthDBMType">AuthDBMType</a> <a name="authdbmtype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the type of database file that is used to
+store passwords</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDBMType default|SDBM|GDBM|DB</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDBMType default</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_dbm</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in version 2.0.30 and later.</td></tr></table></td></tr></table><usage>
<p>Sets the type of database file that is used to store the passwords.
The default database type is determined at compile time. The
availability of other types of database files also depends on
compile-time settings.</p>
-
<p>It is crucial that whatever program you use to create your password
files is configured to use the same type of database.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDBMUserFile">AuthDBMUserFile</a> <a name="authdbmuserfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets thename of a database file containing the list of users and
-passwords for authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDBMUserFile <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_dbm</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthDBMUserFile</code> directive sets the
+</usage><hr/><h2><a name="AuthDBMUserFile">AuthDBMUserFile</a> <a name="authdbmuserfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets thename of a database file containing the list of users and
+passwords for authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDBMUserFile <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_dbm</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthDBMUserFile</code> directive sets the
name of a DBM file containing the list of users and passwords for
user authentication. <em>File-path</em> is the absolute path to
the user file.</p>
-
-<p>The user file is keyed on the username. The value for a user is
+ <p>The user file is keyed on the username. The value for a user is
the <code>crypt()</code> encrypted password, optionally followed
by a colon and arbitrary data. The colon and the data following it
will be ignored by the server.</p>
-
-<p>Security: make sure that the
+ <p>Security: make sure that the
<code class="directive">AuthDBMUserFile</code> is stored outside the
document tree of the web-server; do <em>not</em> put it in the
directory that it protects. Otherwise, clients will be able to
download the <code class="directive">AuthDBMUserFile</code>.</p>
-
-<p>Important compatibility note: The implementation of
+ <p>Important compatibility note: The implementation of
"dbmopen" in the apache modules reads the string length of the
hashed values from the DBM data structures, rather than relying
upon the string being NULL-appended. Some applications, such as
@@ -378,16 +127,8 @@
interchangeably between applications this may be a part of the
problem.</p>
-
-<p>A perl script called
+ <p>A perl script called
<a href="../programs/dbmmanage.html">dbmmanage</a> is included with
Apache. This program can be used to create and update DBM
format password files for use with this module.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.12 +45 -467 httpd-2.0/docs/manual/mod/mod_auth_digest.html
Index: mod_auth_digest.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_auth_digest.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -d -b -u -r1.11 -r1.12
--- mod_auth_digest.html 28 Feb 2002 19:20:22 -0000 1.11
+++ mod_auth_digest.html 6 Mar 2002 17:08:19 -0000 1.12
@@ -1,107 +1,22 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_auth_digest - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_auth_digest</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>User authentication using MD5
- Digest Authentication.</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>auth_digest_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>This module implements HTTP Digest Authentication. However, it
+--><title>mod_auth_digest - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_auth_digest</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>User authentication using MD5
+ Digest Authentication.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>auth_digest_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This module implements HTTP Digest Authentication. However, it
has not been extensively tested and is therefore marked
experimental.</p>
+</summary><p><strong>See also </strong></p><ul><li><a href="core.html#authname" class="directive"><code class="directive">AuthName</code></a></li><li><a href="core.html#authtype" class="directive"><code class="directive">AuthType</code></a></li><li><a href="core.html#require" class="directive"><code class="directive">Require</code></a></li><li><a href="core.html#satisfy" class="directive"><code class="directive">Satisfy</code></a></li></ul><h2>Directives</h2><ul><li><a href="#authdigestalgorithm">AuthDigestAlgorithm</a></li><li><a href="#authdigestdomain">AuthDigestDomain</a></li><li><a href="#authdigestfile">AuthDigestFile</a></li><li><a href="#authdigestgroupfile">AuthDigestGroupFile</a></li><li><a href="#authdigestnccheck">AuthDigestNcCheck</a></li><li><a href="#authdigestnonceformat">AuthDigestNonceFormat</a></li><li><a href="#authdigestnoncelifetime">AuthDigestNonceLifetime</a></li><li><a href="#authdigestqop">AuthDigestQop</a></li></ul><h2>Using Digest Authentication</h2>
-</summary>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="core.html#authname" class="directive">AuthName</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#authtype" class="directive">AuthType</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#require" class="directive">Require</a></code>
-</li>
-<li>
-<code class="directive"><a href="core.html#satisfy" class="directive">Satisfy</a></code>
-</li>
-</ul>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#authdigestalgorithm">AuthDigestAlgorithm</a>
-</li>
-<li>
-<a href="#authdigestdomain">AuthDigestDomain</a>
-</li>
-<li>
-<a href="#authdigestfile">AuthDigestFile</a>
-</li>
-<li>
-<a href="#authdigestgroupfile">AuthDigestGroupFile</a>
-</li>
-<li>
-<a href="#authdigestnccheck">AuthDigestNcCheck</a>
-</li>
-<li>
-<a href="#authdigestnonceformat">AuthDigestNonceFormat</a>
-</li>
-<li>
-<a href="#authdigestnoncelifetime">AuthDigestNonceLifetime</a>
-</li>
-<li>
-<a href="#authdigestqop">AuthDigestQop</a>
-</li>
-</ul>
-<h2>Using Digest Authentication</h2>
-
-
-<p>Using MD5 Digest authentication is very simple. Simply set
+ <p>Using MD5 Digest authentication is very simple. Simply set
up authentication normally, using "AuthType Digest" and
"AuthDigestFile" instead of the normal "AuthType Basic" and
"AuthUserFile"; also, replace any "AuthGroupFile" with
"AuthDigestGroupFile". Then add a "AuthDigestDomain" directive
containing at least the root URI(s) for this protection space.
Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Location /private/><br>
AuthType Digest<br>
AuthName "private area"<br>
@@ -109,21 +24,10 @@
AuthDigestFile /web/auth/.digest_pw<br>
Require valid-user<br>
</Location>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Note</strong>
-</p>
+</code></td></tr></table></blockquote>
-<p>MD5 authentication provides a more
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p>
+ <p>MD5 authentication provides a more
secure password system than Basic authentication, but only
works with supporting browsers. As of this writing (October 2001),
the only major browsers which support digest authentication are
@@ -133,97 +37,19 @@
Therefore, we do not yet recommend using this feature on a large
Internet site. However, for personal and intra-net use, where
browser users can be controlled, it is ideal.</p>
-
-</td>
-</tr>
-</table>
-</blockquote>
-
-<hr>
-<h2>
-<a name="AuthDigestAlgorithm">AuthDigestAlgorithm</a> <a name="authdigestalgorithm">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Selects the algorithm used to calculate the challenge and
-response hases in digest authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDigestAlgorithm MD5|MD5-sess</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDigestAlgorithm MD5</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthDigestAlgorithm</code> directive
+</td></tr></table></blockquote>
+<hr/><h2><a name="AuthDigestAlgorithm">AuthDigestAlgorithm</a> <a name="authdigestalgorithm">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Selects the algorithm used to calculate the challenge and
+response hases in digest authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDigestAlgorithm MD5|MD5-sess</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDigestAlgorithm MD5</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthDigestAlgorithm</code> directive
selects the algorithm used to calculate the challenge and response
hashes.</p>
-
-<p>
-<strong><em>MD5-sess</em> is not correctly implemented
+ <p><strong><em>MD5-sess</em> is not correctly implemented
yet</strong>.
</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDigestDomain">AuthDigestDomain</a> <a name="authdigestdomain">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>URIs that are in the same protection space for digest
-authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDigestDomain <em>URI</em> [<em>URI</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthDigestDomain</code> directive allows
+</usage><hr/><h2><a name="AuthDigestDomain">AuthDigestDomain</a> <a name="authdigestdomain">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>URIs that are in the same protection space for digest
+authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDigestDomain <em>URI</em> [<em>URI</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthDigestDomain</code> directive allows
you to specify one or more URIs which are in the same protection
space (i.e. use the same realm and username/password info). The
specified URIs are prefixes, i.e. the client will assume that all
@@ -231,8 +57,7 @@
username/password. The URIs may be either absolute URIs
(i.e. inluding a scheme, host, port, etc) or relative URIs.</p>
-
-<p>This directive <em>should</em> always be specified and
+ <p>This directive <em>should</em> always be specified and
contain at least the (set of) root URI(s) for this space.
Omitting to do so will cause the client to send the
Authorization header for <em>every request</em> sent to this
@@ -240,249 +65,49 @@
also have a detrimental effect on performance if
"AuthDigestNcCheck" is on.</p>
-
-<p>The URIs specified can also point to different servers, in
+ <p>The URIs specified can also point to different servers, in
which case clients (which understand this) will then share
username/password info across multiple servers without
prompting the user each time. </p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDigestFile">AuthDigestFile</a> <a name="authdigestfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Location of the text file containing the list
-of users and encoded passwords for digest authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDigestFile <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthDigestFile</code> directive sets the
+</usage><hr/><h2><a name="AuthDigestFile">AuthDigestFile</a> <a name="authdigestfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Location of the text file containing the list
+of users and encoded passwords for digest authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDigestFile <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthDigestFile</code> directive sets the
name of a textual file containing the list of users and encoded
passwords for digest authentication. <em>File-path</em> is the
absolute path to the user file.</p>
-
-<p>The digest file uses a special format. Files in this format
+ <p>The digest file uses a special format. Files in this format
can be created using the <a href="../programs/htdigest.html">htdigest</a> utility found in
the support/ subdirectory of the Apache distribution.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDigestGroupFile">AuthDigestGroupFile</a> <a name="authdigestgroupfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Name of the text file containing the list of groups
-for digest authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDigestGroupFile <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthDigestGroupFile</code> directive sets
+</usage><hr/><h2><a name="AuthDigestGroupFile">AuthDigestGroupFile</a> <a name="authdigestgroupfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Name of the text file containing the list of groups
+for digest authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDigestGroupFile <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthDigestGroupFile</code> directive sets
the name of a textual file containing the list of groups and their
members (user names). <em>File-path</em> is the absolute path to
the group file.</p>
-
-<p>Each line of the group file contains a groupname followed by
+ <p>Each line of the group file contains a groupname followed by
a colon, followed by the member usernames separated by spaces.
Example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>mygroup: bob joe anne</code></td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>mygroup: bob joe anne</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>Note that searching large text files is <em>very</em>
+ <p>Note that searching large text files is <em>very</em>
inefficient.</p>
-
-<p>Security: make sure that the AuthGroupFile is stored outside
+ <p>Security: make sure that the AuthGroupFile is stored outside
the document tree of the web-server; do <em>not</em> put it in
the directory that it protects. Otherwise, clients will be able
to download the AuthGroupFile.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDigestNcCheck">AuthDigestNcCheck</a> <a name="authdigestnccheck">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Enables or disables checking of the nonce-count sent by the
-server</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDigestNcCheck On|Off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDigestNcCheck Off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<strong>Not implemented yet.</strong>
-
-</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDigestNonceFormat">AuthDigestNonceFormat</a> <a name="authdigestnonceformat">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Determines how the nonce is generated</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>???</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>???</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<strong>Not implemented yet.</strong>
-
-</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDigestNonceLifetime">AuthDigestNonceLifetime</a> <a name="authdigestnoncelifetime">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>How long the server nonce is valid</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDigestNonceLifetime <em>seconds</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDigestNonceLifetime 300</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthDigestNonceLifetime</code> directive
+</usage><hr/><h2><a name="AuthDigestNcCheck">AuthDigestNcCheck</a> <a name="authdigestnccheck">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enables or disables checking of the nonce-count sent by the
+server</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDigestNcCheck On|Off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDigestNcCheck Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td></tr></table></td></tr></table><usage>
+ <p><strong>Not implemented yet.</strong>
+ </p>
+</usage><hr/><h2><a name="AuthDigestNonceFormat">AuthDigestNonceFormat</a> <a name="authdigestnonceformat">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Determines how the nonce is generated</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>???</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>???</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td></tr></table></td></tr></table><usage>
+ <p><strong>Not implemented yet.</strong>
+ </p>
+</usage><hr/><h2><a name="AuthDigestNonceLifetime">AuthDigestNonceLifetime</a> <a name="authdigestnoncelifetime">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>How long the server nonce is valid</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDigestNonceLifetime <em>seconds</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDigestNonceLifetime 300</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthDigestNonceLifetime</code> directive
controls how long the server nonce is valid. When the client
contacts the server using an expired nonce the server will send
back a 401 with <code>stale=true</code>. If <em>seconds</em> is
@@ -491,47 +116,9 @@
seconds. If <em>seconds</em> is less than 0 then the nonce never
expires.
</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AuthDigestQop">AuthDigestQop</a> <a name="authdigestqop">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Determines the quality-of-protection to use in digest
-authentication</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AuthDigestQop none|auth|auth-int [auth|auth-int]</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDigestQop auth</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AuthDigestQop</code> directive determines
+</usage><hr/><h2><a name="AuthDigestQop">AuthDigestQop</a> <a name="authdigestqop">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Determines the quality-of-protection to use in digest
+authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthDigestQop none|auth|auth-int [auth|auth-int]</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AuthDigestQop auth</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_digest</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AuthDigestQop</code> directive determines
the quality-of-protection to use. <em>auth</em> will only do
authentication (username/password); <em>auth-int</em> is
authentication plus integrity checking (an MD5 hash of the entity
@@ -542,15 +129,6 @@
these to use. <em>none</em> should only be used if the browser for
some reason does not like the challenge it receives otherwise.</p>
-
-<p>
-<strong><em>auth-int</em> is not implemented
+ <p><strong><em>auth-int</em> is not implemented
yet</strong>.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.52 +202 -1026 httpd-2.0/docs/manual/mod/mod_autoindex.html
Index: mod_autoindex.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_autoindex.html,v
retrieving revision 1.51
retrieving revision 1.52
diff -u -d -b -u -r1.51 -r1.52
--- mod_autoindex.html 1 Mar 2002 18:38:04 -0000 1.51
+++ mod_autoindex.html 6 Mar 2002 17:08:19 -0000 1.52
@@ -1,220 +1,104 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_autoindex - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_autoindex</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Generates directory indexes,
+--><title>mod_autoindex - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_autoindex</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Generates directory indexes,
automatically, similar to the Unix <em>ls</em> command or the
- Win32 <em>dir</em> shell command</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>autoindex_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>The index of a directory can come from one of two
+ Win32 <em>dir</em> shell command</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>autoindex_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>The index of a directory can come from one of two
sources:</p>
-
-<ul>
-
-<li>A file written by the user, typically called
- <code>index.html</code>. The <code class="directive"><a href="mod_dir.html#directoryindex" class="directive">DirectoryIndex</a></code> directive sets the
+ <ul>
+ <li>A file written by the user, typically called
+ <code>index.html</code>. The <a href="mod_dir.html#directoryindex" class="directive"><code class="directive">DirectoryIndex</code></a> directive sets the
name of this file. This is controlled by
<code><a href="mod_dir.html">mod_dir</a></code>.</li>
-
-<li>Otherwise, a listing generated by the server. The other
- directives control the format of this listing. The <code class="directive"><a href="#addicon" class="directive">AddIcon</a></code>, <code class="directive"><a href="#addiconbyencoding" class="directive">AddIconByEncoding</a></code> and
- <code class="directive"><a href="#addiconbytype" class="directive">AddIconByType</a></code> are
+ <li>Otherwise, a listing generated by the server. The other
+ directives control the format of this listing. The <a href="#addicon" class="directive"><code class="directive">AddIcon</code></a>, <a href="#addiconbyencoding" class="directive"><code class="directive">AddIconByEncoding</code></a> and
+ <a href="#addiconbytype" class="directive"><code class="directive">AddIconByType</code></a> are
used to set a list of icons to display for various file types;
for each file listed, the first icon listed that matches the
file is displayed. These are controlled by
<code><a href="mod_autoindex.html">mod_autoindex</a></code>.</li>
-
-</ul>
-
-<p>The two functions are separated so that you can completely
+ </ul>
+ <p>The two functions are separated so that you can completely
remove (or replace) automatic index generation should you want
to.</p>
-
-<p>Automatic index generation is enabled with using
+ <p>Automatic index generation is enabled with using
<code>Options +Indexes</code>. See the
- <code class="directive"><a href="core.html#options" class="directive">Options</a></code> directive for
+ <a href="core.html#options" class="directive"><code class="directive">Options</code></a> directive for
more details.</p>
-
-<p>If the <code class="directive"><a href="autoindex.html#fancyindexing" class="directive">FancyIndexing</a></code>
- option is given with the <code class="directive"><a href="autoindex.html#indexoptions" class="directive">IndexOptions</a></code> directive,
+ <p>If the <a href="autoindex.html#fancyindexing" class="directive"><code class="directive">FancyIndexing</code></a>
+ option is given with the <a href="autoindex.html#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> directive,
the column headers are links that control the order of the
display. If you select a header link, the listing will be
regenerated, sorted by the values in that column. Selecting the
same header repeatedly toggles between ascending and descending
order. These column header links are suppressed with
- <code class="directive"><a href="autoindex.html#indexoptions" class="directive">IndexOptions</a></code> directive's
+ <a href="autoindex.html#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> directive's
<samp>SuppressColumnSorting</samp> option.</p>
-
-<p>Note that when the display is sorted by "Size", it's the
+ <p>Note that when the display is sorted by "Size", it's the
<em>actual</em> size of the files that's used, not the
displayed value - so a 1010-byte file will always be displayed
before a 1011-byte file (if in ascending order) even though
they both are shown as "1K".</p>
+</summary><h2>Directives</h2><ul><li><a href="#addalt">AddAlt</a></li><li><a href="#addaltbyencoding">AddAltByEncoding</a></li><li><a href="#addaltbytype">AddAltByType</a></li><li><a href="#adddescription">AddDescription</a></li><li><a href="#addicon">AddIcon</a></li><li><a href="#addiconbyencoding">AddIconByEncoding</a></li><li><a href="#addiconbytype">AddIconByType</a></li><li><a href="#defaulticon">DefaultIcon</a></li><li><a href="#headername">HeaderName</a></li><li><a href="#indexignore">IndexIgnore</a></li><li><a href="#indexoptions">IndexOptions</a></li><li><a href="#indexorderdefault">IndexOrderDefault</a></li><li><a href="#readmename">ReadmeName</a></li></ul><h2>Autoindex Request Query Arguments</h2>
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#addalt">AddAlt</a>
-</li>
-<li>
-<a href="#addaltbyencoding">AddAltByEncoding</a>
-</li>
-<li>
-<a href="#addaltbytype">AddAltByType</a>
-</li>
-<li>
-<a href="#adddescription">AddDescription</a>
-</li>
-<li>
-<a href="#addicon">AddIcon</a>
-</li>
-<li>
-<a href="#addiconbyencoding">AddIconByEncoding</a>
-</li>
-<li>
-<a href="#addiconbytype">AddIconByType</a>
-</li>
-<li>
-<a href="#defaulticon">DefaultIcon</a>
-</li>
-<li>
-<a href="#headername">HeaderName</a>
-</li>
-<li>
-<a href="#indexignore">IndexIgnore</a>
-</li>
-<li>
-<a href="#indexoptions">IndexOptions</a>
-</li>
-<li>
-<a href="#indexorderdefault">IndexOrderDefault</a>
-</li>
-<li>
-<a href="#readmename">ReadmeName</a>
-</li>
-</ul>
-<h2>Autoindex Request Query Arguments</h2>
-
-
-<p>Apache 2.0.23 reorganized the Query Arguments for Column
+ <p>Apache 2.0.23 reorganized the Query Arguments for Column
Sorting, and introduced an entire group of new query options.
To effectively eliminate all client control over the output,
the <code><a href="#indexoptions:ignoreclient">IndexOptions
IgnoreClient</a></code> option was introduced.</p>
-
-<p>The column sorting headers themselves are self-referencing
+ <p>The column sorting headers themselves are self-referencing
hyperlinks that add the sort query options shown below. Any
option below may be added to any request for the directory
resource.</p>
+ <ul>
+ <li><samp>C=N</samp> sorts the directory by file name</li>
-<ul>
-
-<li>
-<samp>C=N</samp> sorts the directory by file name</li>
-
-
-<li>
-<samp>C=M</samp> sorts the directory by last-modified
+ <li><samp>C=M</samp> sorts the directory by last-modified
date, then file name</li>
-
-<li>
-<samp>C=S</samp> sorts the directory by size, then file
+ <li><samp>C=S</samp> sorts the directory by size, then file
name</li>
-
-<li>
-<samp>C=D</samp> sorts the directory by description, then
+ <li><samp>C=D</samp> sorts the directory by description, then
file name<br>
</li>
-
-<li>
-<samp>O=A</samp> sorts the listing in Ascending
+ <li><samp>O=A</samp> sorts the listing in Ascending
Order</li>
-
-<li>
-<samp>O=D</samp> sorts the listing in Descending
+ <li><samp>O=D</samp> sorts the listing in Descending
Order<br>
</li>
-
-<li>
-<samp>F=0</samp> formats the listing as a simple list
+ <li><samp>F=0</samp> formats the listing as a simple list
(not FancyIndexed)</li>
-
-<li>
-<samp>F=1</samp> formats the listing as a FancyIndexed
+ <li><samp>F=1</samp> formats the listing as a FancyIndexed
list</li>
-
-<li>
-<samp>F=2</samp> formats the listing as an HTMLTable
+ <li><samp>F=2</samp> formats the listing as an HTMLTable
FancyIndexed list<br>
</li>
+ <li><samp>V=0</samp> disables version sorting</li>
-<li>
-<samp>V=0</samp> disables version sorting</li>
-
-
-<li>
-<samp>V=1</samp> enables version sorting<br>
+ <li><samp>V=1</samp> enables version sorting<br>
</li>
+ <li><samp>P=<em>pattern</em></samp> lists only files matching
+ the given <em>pattern</em></li>
+ </ul>
-<li>
-<samp>P=<em>pattern</em></samp> lists only files matching
- the given <em>pattern</em>
-</li>
-
-</ul>
-
-
-<p>Note that the 'P'attern query argument is tested
+ <p>Note that the 'P'attern query argument is tested
<em>after</em> the usual IndexIgnore directives are processed,
and all file names are still subjected to the same criteria as
any other autoindex listing. The Query Arguments parser in
@@ -222,18 +106,13 @@
encountered. The Query Arguments must be well formed, according
to the table above.</p>
-
-<p>The simple example below, which can be clipped and saved in
+ <p>The simple example below, which can be clipped and saved in
a header.html file, illustrates these query options. Note that
the unknown "X" argument, for the submit button, is listed last
to assure the arguments are all parsed before mod_autoindex
encounters the X=Go input.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<FORM METHOD="GET"><br>
Show me a <SELECT NAME="F"><br>
<OPTION VALUE="0"> Plain list <br>
@@ -257,49 +136,11 @@
Matching <INPUT TYPE="text" NAME="P" VALUE="*"><br>
<INPUT TYPE="submit" NAME="X" VALUE="Go"><br>
</FORM>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<hr>
-<h2>
-<a name="AddAlt">AddAlt</a> <a name="addalt">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Alternate text to display for a file, instead of an
-icon selected by filename</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddAlt <em>string file</em> [<em>file</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
+</code></td></tr></table></blockquote>
-<p>
-<code class="directive">AddAlt</code> provides the alternate text to
+<hr/><h2><a name="AddAlt">AddAlt</a> <a name="addalt">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Alternate text to display for a file, instead of an
+icon selected by filename</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddAlt <em>string file</em> [<em>file</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p><code class="directive">AddAlt</code> provides the alternate text to
display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>File</em> is a file extension, partial filename, wild-card
expression or full filename for files to describe.
@@ -307,59 +148,15 @@
This alternate text is displayed if the client is image-incapable,
has image loading disabled, or fails to retrieve the icon.</p>
-
-<p>Examples:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+ <p>Examples:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddAlt "PDF" *.pdf<br>
AddAlt "Compressed" *.gz *.zip *.Z
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AddAltByEncoding">AddAltByEncoding</a> <a name="addaltbyencoding">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Alternate text to display for a file instead of an icon
-selected by MIME-encoding</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddAltByEncoding <em>string MIME-encoding</em>
-[<em>MIME-encoding</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<code class="directive">AddAltByEncoding</code> provides the alternate
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="AddAltByEncoding">AddAltByEncoding</a> <a name="addaltbyencoding">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Alternate text to display for a file instead of an icon
+selected by MIME-encoding</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddAltByEncoding <em>string MIME-encoding</em>
+[<em>MIME-encoding</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p><code class="directive">AddAltByEncoding</code> provides the alternate
text to display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>MIME-encoding</em> is a valid content-encoding, such as
<code>x-compress</code>. <em>String</em> is enclosed in double
@@ -367,58 +164,14 @@
client is image-incapable, has image loading disabled, or fails to
retrieve the icon.</p>
-
-<p>Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+ <p>Example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddAltByEncoding "gzip" x-gzip
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AddAltByType">AddAltByType</a> <a name="addaltbytype">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Alternate text to display for a file, instead of an
-icon selected by MIME content-type</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddAltByType <em>string
- MIME-type</em> [<em>MIME-type</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<code class="directive">AddAltByType</code> sets the alternate text to
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="AddAltByType">AddAltByType</a> <a name="addaltbytype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Alternate text to display for a file, instead of an
+icon selected by MIME content-type</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddAltByType <em>string
+ MIME-type</em> [<em>MIME-type</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p><code class="directive">AddAltByType</code> sets the alternate text to
display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>MIME-type</em> is a valid content-type, such as
<code>text/html</code>. <em>String</em> is enclosed in double
@@ -426,74 +179,23 @@
client is image-incapable, has image loading disabled, or fails to
retrieve the icon.</p>
-
-<p>Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+ <p>Example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddAltByType "TXT" text/plain
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AddDescription">AddDescription</a> <a name="adddescription">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddDescription
- <em>string file</em> [<em>file</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This sets the description to display for a file, for
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="AddDescription">AddDescription</a> <a name="adddescription">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddDescription
+ <em>string file</em> [<em>file</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>This sets the description to display for a file, for
<code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>File</em> is a file extension, partial filename, wild-card
expression or full filename for files to describe.
<em>String</em> is enclosed in double quotes (<code>"</code>).
Example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddDescription "The planet Mars"
+ /web/pics/mars.gif</code></td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>AddDescription "The planet Mars"
- /web/pics/mars.gif</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>The typical, default description field is 23 bytes wide. 6
+ <p>The typical, default description field is 23 bytes wide. 6
more bytes are added by the
<code>IndexOptions SuppressIcon</code> option, 7 bytes are
added by the <code>IndexOptions SuppressSize</code>
@@ -502,314 +204,83 @@
Therefore, the widest default the description column is ever
assigned is 55 bytes.</p>
-
-<p>See the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a>
- <code class="directive"><a href="#indexoptions" class="directive">IndexOptions</a></code> keyword
+ <p>See the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a>
+ <a href="#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> keyword
for details on overriding the size of this column, or allowing
descriptions of unlimited length.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Caution</strong>
-</p>
-<p>Descriptive text defined with
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Caution</strong></p> <p>Descriptive text defined with
<code class="directive">AddDescription</code> may contain HTML markup, such as
tags and character entities. If the width of the description
column should happen to truncate a tagged element (such as
cutting off the end of a bolded phrase), the results may
affect the rest of the directory listing.</p>
-
-</td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AddIcon">AddIcon</a> <a name="addicon">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Icon to display for a file selected by name</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddIcon <em>icon
- name</em> [<em>name</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This sets the icon to display next to a file ending in
+</td></tr></table></blockquote>
+</usage><hr/><h2><a name="AddIcon">AddIcon</a> <a name="addicon">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Icon to display for a file selected by name</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddIcon <em>icon
+ name</em> [<em>name</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>This sets the icon to display next to a file ending in
<em>name</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>Icon</em> is either a (%-escaped) relative URL to the icon,
or of the format (<em>alttext</em>,<em>url</em>) where
<em>alttext</em> is the text tag given for an icon for
non-graphical browsers.</p>
-
-<p>
-<em>Name</em> is either ^^DIRECTORY^^ for directories,
+ <p><em>Name</em> is either ^^DIRECTORY^^ for directories,
^^BLANKICON^^ for blank lines (to format the list correctly), a
file extension, a wildcard expression, a partial filename or a
complete filename. Examples:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br>
AddIcon /icons/dir.xbm ^^DIRECTORY^^<br>
AddIcon /icons/backup.xbm *~
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>
-<code class="directive"><a href="#addiconbytype" class="directive">AddIconByType</a></code>
+ <p><a href="#addiconbytype" class="directive"><code class="directive">AddIconByType</code></a>
should be used in preference to <code class="directive">AddIcon</code>,
when possible.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="AddIconByEncoding">AddIconByEncoding</a> <a name="addiconbyencoding">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Icon to display next to files selected by MIME
-content-encoding</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddIconByEncoding
- <em>icon MIME-encoding</em> [<em>MIME-encoding</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This sets the icon to display next to files with <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+</usage><hr/><h2><a name="AddIconByEncoding">AddIconByEncoding</a> <a name="addiconbyencoding">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Icon to display next to files selected by MIME
+content-encoding</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddIconByEncoding
+ <em>icon MIME-encoding</em> [<em>MIME-encoding</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>This sets the icon to display next to files with <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>Icon</em> is either a (%-escaped) relative URL to the icon,
or of the format (<em>alttext</em>,<em>url</em>) where
<em>alttext</em> is the text tag given for an icon for
non-graphical browsers.</p>
-
-<p>
-<em>Mime-encoding</em> is a wildcard expression matching
+ <p><em>Mime-encoding</em> is a wildcard expression matching
required the content-encoding. Examples:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>AddIconByEncoding /icons/compress.xbm x-compress</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="AddIconByType">AddIconByType</a> <a name="addiconbytype">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Icon to display next to files selected by MIME
-content-type</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddIconByType
- <em>icon MIME-type</em> [<em>MIME-type</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This sets the icon to display next to files of type
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddIconByEncoding /icons/compress.xbm x-compress</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="AddIconByType">AddIconByType</a> <a name="addiconbytype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Icon to display next to files selected by MIME
+content-type</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddIconByType
+ <em>icon MIME-type</em> [<em>MIME-type</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>This sets the icon to display next to files of type
<em>MIME-type</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>Icon</em> is either a (%-escaped) relative URL to the icon,
or of the format (<em>alttext</em>,<em>url</em>) where
<em>alttext</em> is the text tag given for an icon for
non-graphical browsers.</p>
-
-<p>
-<em>Mime-type</em> is a wildcard expression matching
+ <p><em>Mime-type</em> is a wildcard expression matching
required the mime types. Examples:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>AddIconByType (IMG,/icons/image.xbm) image/*</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="DefaultIcon">DefaultIcon</a> <a name="defaulticon">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Icon to display for files when no specific icon is
-configured</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>DefaultIcon <em>url-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">DefaultIcon</code> directive sets the icon
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddIconByType (IMG,/icons/image.xbm) image/*</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="DefaultIcon">DefaultIcon</a> <a name="defaulticon">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Icon to display for files when no specific icon is
+configured</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DefaultIcon <em>url-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">DefaultIcon</code> directive sets the icon
to display for files when no specific icon is known, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>Url</em> is a (%-escaped) relative URL to the icon.
Examples:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>DefaultIcon /icon/unknown.xbm</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="HeaderName">HeaderName</a> <a name="headername">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Name of the file that will be inserted at the top
-of the index listing</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>HeaderName <em>filename</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">HeaderName</code> directive sets the name
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>DefaultIcon /icon/unknown.xbm</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="HeaderName">HeaderName</a> <a name="headername">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Name of the file that will be inserted at the top
+of the index listing</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>HeaderName <em>filename</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">HeaderName</code> directive sets the name
of the file that will be inserted at the top of the index
listing. <em>Filename</em> is the name of the file to include.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-
-<p>Both HeaderName and <code class="directive"><a href="#readmename" class="directive">ReadmeName</a></code> now treat
+<blockquote><table><tr><td bgcolor="#e0e5f5">
+ <p>Both HeaderName and <a href="#readmename" class="directive"><code class="directive">ReadmeName</code></a> now treat
<em>Filename</em> as a URI path relative to the one used to
access the directory being indexed. <em>Filename</em> must
resolve to a document with a major content type of
@@ -818,75 +289,26 @@
<em>filename</em> may refer to a CGI script if the script's
actual file type (as opposed to its output) is marked as
<code>text/html</code> such as with a directive like:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddType text/html .cgi
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>
-<a href="../content-negotiation.html">Content negotiation</a>
- will be performed if the <code>MultiViews</code> <code class="directive"><a href="core.html#option" class="directive">Option</a></code> is enabled. If
+</code></td></tr></table></blockquote>
+ <p><a href="../content-negotiation.html">Content negotiation</a>
+ will be performed if the <code>MultiViews</code> <a href="core.html#option" class="directive"><code class="directive">Option</code></a> is enabled. If
<em>filename</em> resolves to a static <code>text/html</code>
document (not a CGI script) and the <code>Includes</code>
- <code class="directive"><a href="core.html#option" class="directive">option</a></code> is enabled, the file
+ <a href="core.html#option" class="directive"><code class="directive">option</code></a> is enabled, the file
will be processed for server-side includes (see the
<code><a href="mod_include.html">mod_include</a></code> documentation).</p>
+</td></tr></table></blockquote>
-</td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>If the file specified by <code class="directive">HeaderName</code> contains
+ <p>If the file specified by <code class="directive">HeaderName</code> contains
the beginnings of an HTML document (<HTML>, <HEAD>,
etc) then you will probably want to set <a href="#indexoptions:suppresshtmlpreamble"><code>IndexOptions
+SuppressHTMLPreamble</code></a>, so that these tags are not
repeated.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="IndexIgnore">IndexIgnore</a> <a name="indexignore">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Adds to the list of files to hide when listing
-a directory</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>IndexIgnore <em>file</em> [<em>file</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">IndexIgnore</code> directive adds to the
+</usage><hr/><h2><a name="IndexIgnore">IndexIgnore</a> <a name="indexignore">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Adds to the list of files to hide when listing
+a directory</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>IndexIgnore <em>file</em> [<em>file</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">IndexIgnore</code> directive adds to the
list of files to hide when listing a directory. <em>File</em> is a
file extension, partial filename, wildcard expression or full
filename for files to ignore. Multiple IndexIgnore directives add
@@ -894,107 +316,43 @@
files. By default, the list contains
`<code>.</code>'. Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>IndexIgnore README .htaccess *~</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="IndexOptions">IndexOptions</a> <a name="indexoptions">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Various configuration settings for directory
-indexing</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>IndexOptions [+|-]<em>option</em> [[+|-]<em>option</em>] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">IndexOptions</code> directive specifies the
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>IndexIgnore README .htaccess *~</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="IndexOptions">IndexOptions</a> <a name="indexoptions">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Various configuration settings for directory
+indexing</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>IndexOptions [+|-]<em>option</em> [[+|-]<em>option</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">IndexOptions</code> directive specifies the
behavior of the directory indexing. <em>Option</em> can be one
of</p>
+ <dl>
+ <dt><a id="indexoptions:descriptionwidth" name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
+ | *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
-<dl>
-
-<dt>
-<a id="indexoptions:descriptionwidth" name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
- | *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a>
-</dt>
-
-
-<dd>The <code>DescriptionWidth</code> keyword allows you to
+ <dd>The <code>DescriptionWidth</code> keyword allows you to
specify the width of the description column in
characters.</dd>
-
-<dd>
-<code>-DescriptionWidth</code> (or unset) allows
+ <dd><code>-DescriptionWidth</code> (or unset) allows
mod_autoindex to calculate the best width.</dd>
-
-<dd>
-<code>DescriptionWidth=n</code> fixes the column width to
+ <dd><code>DescriptionWidth=n</code> fixes the column width to
n bytes wide.</dd>
-
-<dd>
-<code>DescriptionWidth=*</code> grows the column to the
+ <dd><code>DescriptionWidth=*</code> grows the column to the
width necessary to accommodate the longest description
string.</dd>
+ <dd><b>See the section on <a href="#adddescription" class="directive"><code class="directive">AddDescription</code></a> for dangers
+ inherent in truncating descriptions.</b></dd>
-<dd>
-<b>See the section on <code class="directive"><a href="#adddescription" class="directive">AddDescription</a></code> for dangers
- inherent in truncating descriptions.</b>
-</dd>
-
-
-<dt>
-<a id="indexoptions:fancyindexing" name="indexoptions:fancyindexing">FancyIndexing</a>
-</dt>
-
+ <dt><a id="indexoptions:fancyindexing" name="indexoptions:fancyindexing">FancyIndexing</a></dt>
-<dd>
+ <dd>
This turns on fancy indexing of directories.</dd>
+ <dt><a id="indexoptions:foldersfirst" name="indexoptions:foldersfirst">FoldersFirst (<i>Apache
+ 1.3.10 or 2.0.23 and later</i>)</a></dt>
-<dt>
-<a id="indexoptions:foldersfirst" name="indexoptions:foldersfirst">FoldersFirst (<i>Apache
- 1.3.10 or 2.0.23 and later</i>)</a>
-</dt>
-
-
-<dd>If this option is enabled, subdirectory listings will
+ <dd>If this option is enabled, subdirectory listings will
<i>always</i> appear first, followed by normal files in the
directory. The listing is basically broken into two
components, the files and the subdirectories, and each is
@@ -1005,17 +363,12 @@
<code>Beta</code>, which will be listed before normal files
<code>Gamma</code> and <code>Alpha</code>. <b>This option
only has an effect if <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
- is also enabled.</b>
-</dd>
-
-
-<dt>
-<a id="indexoptions:htmltable" name="indexoptions:htmltable">HTMLTable</a> <i>(Experimental,
- Apache 2.0.23 and later)</i>
-</dt>
+ is also enabled.</b></dd>
+ <dt><a id="indexoptions:htmltable" name="indexoptions:htmltable">HTMLTable</a> <i>(Experimental,
+ Apache 2.0.23 and later)</i></dt>
-<dd>
+ <dd>
This experimental option with FancyIndexing constructs a
simple table for the fancy directory listing. Note this will
confuse older browsers. It is particularly necessary if file
@@ -1023,24 +376,16 @@
left-to-right and right-to-left reading order, as can happen
on WinNT or other utf-8 enabled platforms.</dd>
+ <dt><a id="indexoptions:iconsarelinks" name="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
-<dt>
-<a id="indexoptions:iconsarelinks" name="indexoptions:iconsarelinks">IconsAreLinks</a>
-</dt>
-
-
-<dd>
+ <dd>
This makes the icons part of the anchor for the filename, for
fancy indexing.</dd>
+ <dt><a id="indexoptions:iconheight" name="indexoptions:iconheight">IconHeight[=pixels]
+ (<em>Apache 1.3 and later</em>)</a></dt>
-<dt>
-<a id="indexoptions:iconheight" name="indexoptions:iconheight">IconHeight[=pixels]
- (<em>Apache 1.3 and later</em>)</a>
-</dt>
-
-
-<dd>
+ <dd>
Presence of this option, when used with IconWidth, will cause
the server to include <code>HEIGHT</code> and
<code>WIDTH</code> attributes in the <code>IMG</code> tag for
@@ -1050,14 +395,10 @@
the standard height of the icons supplied with the Apache
software.</dd>
+ <dt><a id="indexoptions:iconwidth" name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
+ 1.3 and later</em>)</a></dt>
-<dt>
-<a id="indexoptions:iconwidth" name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
- 1.3 and later</em>)</a>
-</dt>
-
-
-<dd>
+ <dd>
Presence of this option, when used with IconHeight, will
cause the server to include <code>HEIGHT</code> and
<code>WIDTH</code> attributes in the <code>IMG</code> tag for
@@ -1067,62 +408,41 @@
the standard width of the icons supplied with the Apache
software.</dd>
+ <dt><a id="indexoptions:ignoreclient" name="indexoptions:ignoreclient">IgnoreClient</a></dt>
-<dt>
-<a id="indexoptions:ignoreclient" name="indexoptions:ignoreclient">IgnoreClient</a>
-</dt>
-
-
-<dd>
+ <dd>
This option causes mod_autoindex to ignore all query
variables from the client, including sort order (implies
<code><a href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code>.)</dd>
+ <dt><a id="indexoptions:namewidth" name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
+ (<em>Apache 1.3.2 and later</em>)</a></dt>
-<dt>
-<a id="indexoptions:namewidth" name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
- (<em>Apache 1.3.2 and later</em>)</a>
-</dt>
-
-
-<dd>The NameWidth keyword allows you to specify the width of
+ <dd>The NameWidth keyword allows you to specify the width of
the filename column in bytes.</dd>
-
-<dd>
-<code>-NameWidth</code> (or unset) allows mod_autoindex
+ <dd><code>-NameWidth</code> (or unset) allows mod_autoindex
to calculate the best width.</dd>
-
-<dd>
-<code>NameWidth=n</code> fixes the column width to n
+ <dd><code>NameWidth=n</code> fixes the column width to n
bytes wide.</dd>
-
-<dd>
-<code>NameWidth=*</code> grows the column to the
+ <dd><code>NameWidth=*</code> grows the column to the
necessary width.</dd>
+ <dt><a id="indexoptions:scanhtmltitles" name="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
-<dt>
-<a id="indexoptions:scanhtmltitles" name="indexoptions:scanhtmltitles">ScanHTMLTitles</a>
-</dt>
-
-
-<dd>
+ <dd>
This enables the extraction of the title from HTML documents
for fancy indexing. If the file does not have a description
given by <a href="#adddescription">AddDescription</a> then
httpd will read the document for the value of the TITLE tag.
This is CPU and disk intensive.</dd>
-
-<dt>
-<a id="indexoptions:suppresscolumnsorting" name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
+ <dt><a id="indexoptions:suppresscolumnsorting" name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
(<em>Apache 1.3 and later</em>)</dt>
-
-<dd>
+ <dd>
If specified, Apache will not make the column headings in a
FancyIndexed directory listing into links for sorting. The
default behavior is for them to be links; selecting the
@@ -1132,13 +452,9 @@
string.</strong> That behavior is now controlled by <a href="#indexoptions:ignoreclient">IndexOptions
IgnoreClient</a> in Apache 2.0.23.</dd>
+ <dt><a id="indexoptions:suppressdescription" name="indexoptions:suppressdescription">SuppressDescription</a></dt>
-<dt>
-<a id="indexoptions:suppressdescription" name="indexoptions:suppressdescription">SuppressDescription</a>
-</dt>
-
-
-<dd>
+ <dd>
This will suppress the file description in fancy indexing
listings. By default, no file descriptions are defined, and
so the use of this option will regain 23 characters of screen
@@ -1148,15 +464,12 @@
index option to limit the size of the description
column.</dd>
-
-<dt>
-<a id="indexoptions:suppresshtmlpreamble" name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
+ <dt><a id="indexoptions:suppresshtmlpreamble" name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
(<em>Apache 1.3 and later</em>)</dt>
-
-<dd>
+ <dd>
If the directory actually contains a file specified by the
- <code class="directive"><a href="#headername" class="directive">HeaderName</a></code>
+ <a href="#headername" class="directive"><code class="directive">HeaderName</code></a>
directive, the module usually includes the contents of the file
after a standard HTML preamble (<HTML>, <HEAD>,
<em>et cetera</em>). The SuppressHTMLPreamble option disables
@@ -1165,60 +478,42 @@
HTML instructions in this case. If there is no header file, the
preamble is generated as usual.</dd>
-
-<dt>
-<a id="indexoptions:suppressicon" name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
+ <dt><a id="indexoptions:suppressicon" name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
2.0.23 and later</em>)</dt>
-
-<dd>
+ <dd>
This will suppress the icon in fancy indexing listings.
Combining both <em>SuppressIcon</em> and
<em>SuppressRules</em> yields proper HTML 3.2 output, which
by the final specification prohibits IMG and HR tags from the
PRE block (used to format FancyIndexed listings.)</dd>
+ <dt><a id="indexoptions:suppresslastmodified" name="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
-<dt>
-<a id="indexoptions:suppresslastmodified" name="indexoptions:suppresslastmodified">SuppressLastModified</a>
-</dt>
-
-
-<dd>
+ <dd>
This will suppress the display of the last modification date,
in fancy indexing listings.</dd>
-
-<dt>
-<a id="indexoptions:suppressrules" name="indexoptions:suppressrules">SuppressRules</a>
+ <dt><a id="indexoptions:suppressrules" name="indexoptions:suppressrules">SuppressRules</a>
(<em>Apache 2.0.23 and later</em>)</dt>
-
-<dd>
+ <dd>
This will suppress the horizontal rule lines (HR tags) in
directory listings. Combining both <em>SuppressIcon</em> and
<em>SuppressRules</em> yeilds proper HTML 3.2 output, which
by the final specification prohibits IMG and HR tags from the
PRE block (used to format FancyIndexed listings.)</dd>
+ <dt><a id="indexoptions:suppresssize" name="indexoptions:suppresssize">SuppressSize</a></dt>
-<dt>
-<a id="indexoptions:suppresssize" name="indexoptions:suppresssize">SuppressSize</a>
-</dt>
-
-
-<dd>
+ <dd>
This will suppress the file size in fancy indexing
listings.</dd>
+ <dt><a id="indexoptions:trackmodified" name="indexoptions:trackmodified">TrackModified (<em>Apache
+ 1.3.15 or 2.0.23 and later</em>)</a></dt>
-<dt>
-<a id="indexoptions:trackmodified" name="indexoptions:trackmodified">TrackModified (<em>Apache
- 1.3.15 or 2.0.23 and later</em>)</a>
-</dt>
-
-
-<dd>
+ <dd>
This returns the Last-Modified and ETag values for the listed
directory in the HTTP header. It is only valid if the
operating system and file system return appropriate stat()
@@ -1233,84 +528,56 @@
Last-Modified header on all Unix platforms.</strong> If this
is a concern, leave this option disabled.</dd>
+ <dt><a id="indexoptions:versionsort" name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
+ and later</em>)</a></dt>
-<dt>
-<a id="indexoptions:versionsort" name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
- and later</em>)</a>
-</dt>
-
-
-<dd>
+ <dd>
The VersionSort keyword causes files containing version
numbers to sort in a natural way. Strings are sorted as
usual, except that substrings of digits in the name and
description are compared according to their numeric value.
For example:
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
foo-1.7<br>
foo-1.7.2<br>
foo-1.7.12<br>
foo-1.8.2<br>
foo-1.8.2a<br>
foo-1.12<br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
If the number starts with a zero, then it is considered to
be a fraction:
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
foo-1.001<br>
foo-1.002<br>
foo-1.030<br>
foo-1.04
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</dd>
-
-
-<dd>
-
-<h3>Incremental IndexOptions</h3>
-
-</dd>
+</code></td></tr></table></blockquote>
+ </dd>
+ <dd>
+ <h3>Incremental IndexOptions</h3>
+ </dd>
-<dd>
+ <dd>
Apache 1.3.3 introduced some significant changes in the
handling of <code class="directive">IndexOptions</code> directives. In
particular,<br>
-
-<br>
-
+ <br>
-<ul>
-
-<li>Multiple <code class="directive">IndexOptions</code> directives for a
+ <ul>
+ <li>Multiple <code class="directive">IndexOptions</code> directives for a
single directory are now merged together. The result of
the example above will now be the equivalent of
<code>IndexOptions FancyIndexing ScanHTMLTitles</code>.</li>
-
-<li>The addition of the incremental syntax
+ <li>The addition of the incremental syntax
(<em>i.e.</em>, prefixing keywords with '+' or '-').</li>
-
-</ul>
-
-<br>
+ </ul>
+ <br>
Whenever a '+' or '-' prefixed keyword is encountered, it
is applied to the current <code class="directive">IndexOptions</code>
settings (which may have been inherited from an upper-level
@@ -1319,77 +586,31 @@
incremental settings encountered so far. Consider the
following example:
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>IndexOptions +ScanHTMLTitles -IconsAreLinks
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>IndexOptions +ScanHTMLTitles -IconsAreLinks
FancyIndexing<br>
IndexOptions +SuppressSize<br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
The net effect is equivalent to
<code>IndexOptions FancyIndexing +SuppressSize</code>,
because the unprefixed <code>FancyIndexing</code> discarded
the incremental keywords before it, but allowed them to
start accumulating again afterward.<br>
-
-<br>
+ <br>
To unconditionally set the <code class="directive">IndexOptions</code> for a
particular directory, clearing the inherited settings,
specify keywords without any '+' or '-' prefixes.
</dd>
-
-</dl>
-
-</usage>
-<hr>
-<h2>
-<a name="IndexOrderDefault">IndexOrderDefault</a> <a name="indexorderdefault">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the default ordering of the directory index</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>IndexOrderDefault
-Ascending|Descending Name|Date|Size|Description</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">IndexOrderDefault</code> directive is used
+ </dl>
+</usage><hr/><h2><a name="IndexOrderDefault">IndexOrderDefault</a> <a name="indexorderdefault">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the default ordering of the directory index</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>IndexOrderDefault
+Ascending|Descending Name|Date|Size|Description</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">IndexOrderDefault</code> directive is used
in combination with the <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
index option. By default, fancyindexed directory listings are
displayed in ascending order by filename; the
<code class="directive">IndexOrderDefault</code> allows you to change this initial
display order.</p>
-
-<p>
-<code class="directive">IndexOrderDefault</code> takes two
+ <p><code class="directive">IndexOrderDefault</code> takes two
arguments. The first must be either <code>Ascending</code> or
<code>Descending</code>, indicating the direction of the sort.
The second argument must be one of the keywords <code>Name</code>,
@@ -1397,61 +618,16 @@
and identifies the primary key. The secondary key is
<em>always</em> the ascending filename.</p>
-
-<p>You can force a directory listing to only be displayed in a
+ <p>You can force a directory listing to only be displayed in a
particular order by combining this directive with the <a href="#indexoptions:suppresscolumnsorting"><code>SuppressColumnSorting</code></a>
index option; this will prevent the client from requesting the
directory listing in a different order.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ReadmeName">ReadmeName</a> <a name="readmename">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ReadmeName <em>filename</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ReadmeName</code> directive sets the name
+</usage><hr/><h2><a name="ReadmeName">ReadmeName</a> <a name="readmename">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ReadmeName <em>filename</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ReadmeName</code> directive sets the name
of the file that will be appended to the end of the index
listing. <em>Filename</em> is the name of the file to include, and
is taken to be relative to the location being indexed.</p>
-
-<p>See also <code class="directive"><a href="#headername" class="directive">HeaderName</a></code>, where this behavior
+ <p>See also <a href="#headername" class="directive"><code class="directive">HeaderName</code></a>, where this behavior
is described in greater detail.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.18 +13 -174 httpd-2.0/docs/manual/mod/mod_cern_meta.html
Index: mod_cern_meta.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_cern_meta.html,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -b -u -r1.17 -r1.18
--- mod_cern_meta.html 1 Mar 2002 19:46:20 -0000 1.17
+++ mod_cern_meta.html 6 Mar 2002 17:08:19 -0000 1.18
@@ -1,44 +1,10 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_cern_meta - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_cern_meta</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>CERN httpd metafile semantics</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>cern_meta_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
+--><title>mod_cern_meta - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_cern_meta</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>CERN httpd metafile semantics</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>cern_meta_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
-<p>Emulate the CERN HTTPD Meta file semantics. Meta files are HTTP
+ <p>Emulate the CERN HTTPD Meta file semantics. Meta files are HTTP
headers that can be output in addition to the normal range of
headers for each file accessed. They appear rather like the
Apache .asis files, and are able to provide a crude way of
@@ -47,151 +13,24 @@
this one was chosen because there is already a large number of
CERN users who can exploit this module.</p>
-
-<p>More information on the <a href="http://www.w3.org/pub/WWW/Daemon/User/Config/General.html#MetaDir">
+ <p>More information on the <a href="http://www.w3.org/pub/WWW/Daemon/User/Config/General.html#MetaDir">
CERN metafile semantics</a> is available.</p>
-
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#metadir">MetaDir</a>
-</li>
-<li>
-<a href="#metafiles">MetaFiles</a>
-</li>
-<li>
-<a href="#metasuffix">MetaSuffix</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="MetaDir">MetaDir</a> <a name="metadir">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Name of the directory to find CERN-style meta information
-files</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MetaDir <em>directory</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MetaDir .web</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_cern_meta</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Specifies the name of the directory in which Apache can find
+</summary><h2>Directives</h2><ul><li><a href="#metadir">MetaDir</a></li><li><a href="#metafiles">MetaFiles</a></li><li><a href="#metasuffix">MetaSuffix</a></li></ul><hr/><h2><a name="MetaDir">MetaDir</a> <a name="metadir">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Name of the directory to find CERN-style meta information
+files</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MetaDir <em>directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MetaDir .web</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_cern_meta</td></tr></table></td></tr></table><usage>
+ <p>Specifies the name of the directory in which Apache can find
meta information files. The directory is usually a 'hidden'
subdirectory of the directory that contains the file being
accessed. Set to "<code>.</code>" to look in the same directory
as the file.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="MetaFiles">MetaFiles</a> <a name="metafiles">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Activates CERN meta-file processing</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MetaFiles on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MetaFiles off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_cern_meta</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Turns on/off Meta file processing on a per-directory basis.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="MetaSuffix">MetaSuffix</a> <a name="metasuffix">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>File name suffix for the file containg CERN-style
-meta information</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MetaSuffix <em>suffix</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MetaSuffix .meta</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_cern_meta</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Specifies the file name suffix for the file containing the
+</usage><hr/><h2><a name="MetaFiles">MetaFiles</a> <a name="metafiles">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Activates CERN meta-file processing</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MetaFiles on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MetaFiles off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_cern_meta</td></tr></table></td></tr></table><usage>
+ <p>Turns on/off Meta file processing on a per-directory basis.</p>
+</usage><hr/><h2><a name="MetaSuffix">MetaSuffix</a> <a name="metasuffix">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>File name suffix for the file containg CERN-style
+meta information</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MetaSuffix <em>suffix</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MetaSuffix .meta</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_cern_meta</td></tr></table></td></tr></table><usage>
+ <p>Specifies the file name suffix for the file containing the
meta information. For example, the default values for the two
directives will cause a request to
<code>DOCUMENT_ROOT/somedir/index.html</code> to look in
<code>DOCUMENT_ROOT/somedir/.web/index.html.meta</code> and
will use its contents to generate additional MIME header
information.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.27 +51 -284 httpd-2.0/docs/manual/mod/mod_cgi.html
Index: mod_cgi.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_cgi.html,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -d -b -u -r1.26 -r1.27
--- mod_cgi.html 1 Mar 2002 22:16:23 -0000 1.26
+++ mod_cgi.html 6 Mar 2002 17:08:19 -0000 1.27
@@ -1,114 +1,45 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_cgi - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_cgi</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Execution of CGI scripts</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>cgi_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
+--><title>mod_cgi - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_cgi</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Execution of CGI scripts</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>cgi_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
-<p>Any file that has the mime type
+ <p>Any file that has the mime type
<code>application/x-httpd-cgi</code> or handler
<code>cgi-script</code> (Apache 1.1 or later) will be treated
as a CGI script, and run by the server, with its output being
returned to the client. Files acquire this type either by
having a name containing an extension defined by the
- <code class="directive"><a href="mod_mime.html#addtype" class="directive">AddType</a></code> directive, or by being
- in a <code class="directive"><a href="mod_alias.html#scriptalias" class="directive">ScriptAlias</a></code>
+ <a href="mod_mime.html#addtype" class="directive"><code class="directive">AddType</code></a> directive, or by being
+ in a <a href="mod_alias.html#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a>
directory.</p>
-
-<p>When the server invokes a CGI script, it will add a variable
+ <p>When the server invokes a CGI script, it will add a variable
called <code>DOCUMENT_ROOT</code> to the environment. This
variable will contain the value of the
- <code class="directive"><a href="core.html.html#documentroot" class="directive">DocumentRoot</a></code> configuration
+ <a href="core.html.html#documentroot" class="directive"><code class="directive">DocumentRoot</code></a> configuration
variable.</p>
-
-<p>For an introduction to using CGI scripts with Apache, see
+ <p>For an introduction to using CGI scripts with Apache, see
our tutorial on <a href="../howto/cgi.html">Dynamic Content
With CGI</a>.</p>
-
-<p>When using a multi-threaded MPM under unix, the module
+ <p>When using a multi-threaded MPM under unix, the module
<code><a href="mod_cgid.html">mod_cgid</a></code> should be used in place of
this module. At the user level, the two modules are essentially
identical.</p>
-
-</summary>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="core.html#options" class="directive">Options</a></code>
-</li>
-<li>
-<code class="directive"><a href="mod_alias.html#scriptalias" class="directive">ScriptAlias</a></code>
-</li>
-<li>
-<code class="directive"><a href="mod_mime.html#addhandler" class="directive">AddHandler</a></code>
-</li>
-</ul>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#scriptlog">ScriptLog</a>
-</li>
-<li>
-<a href="#scriptlogbuffer">ScriptLogBuffer</a>
-</li>
-<li>
-<a href="#scriptloglength">ScriptLogLength</a>
-</li>
-</ul>
-<h2>CGI Environment variables</h2>
-
-<p>The server will set the CGI environment variables as described
+</summary><p><strong>See also </strong></p><ul><li><a href="core.html#options" class="directive"><code class="directive">Options</code></a></li><li><a href="mod_alias.html#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a></li><li><a href="mod_mime.html#addhandler" class="directive"><code class="directive">AddHandler</code></a></li></ul><h2>Directives</h2><ul><li><a href="#scriptlog">ScriptLog</a></li><li><a href="#scriptlogbuffer">ScriptLogBuffer</a></li><li><a href="#scriptloglength">ScriptLogLength</a></li></ul><h2>CGI Environment variables</h2>
+ <p>The server will set the CGI environment variables as described
in the <a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI
specification</a>, with the following provisions:</p>
+ <dl>
+ <dt>PATH_INFO</dt>
-<dl>
-
-<dt>PATH_INFO</dt>
-
-
-<dd>This will not be available if the <code class="directive"><a href="core.html#acceptpathinfo" class="directive">AcceptPathInfo</a></code> directive is explicitly set to
+ <dd>This will not be available if the <a href="core.html#acceptpathinfo" class="directive"><code class="directive">AcceptPathInfo</code></a> directive is explicitly set to
<code>off</code>. The default behavior, if AcceptPathInfo is
not given, is that mod_cgi will accept path info (trailing
/more/path/info following the script filename in the URI), while
@@ -117,157 +48,74 @@
directive has the same effect as setting it <code>on</code> for
mod_cgi requests.</dd>
+ <dt>REMOTE_HOST</dt>
-<dt>REMOTE_HOST</dt>
-
-
-<dd>This will only be set if <code class="directive"><a href="core.html#hostnamelookups" class="directive">HostnameLookups</a></code> is set to <code>on</code> (it
+ <dd>This will only be set if <a href="core.html#hostnamelookups" class="directive"><code class="directive">HostnameLookups</code></a> is set to <code>on</code> (it
is off by default), and if a reverse DNS lookup of the accessing
host's address indeed finds a host name.</dd>
+ <dt>REMOTE_IDENT</dt>
-<dt>REMOTE_IDENT</dt>
-
-
-<dd>This will only be set if <code class="directive"><a href="core.html#identitycheck" class="directive">IdentityCheck</a></code> is set to
+ <dd>This will only be set if <a href="core.html#identitycheck" class="directive"><code class="directive">IdentityCheck</code></a> is set to
<code>on</code> and the accessing host supports the ident
protocol. Note that the contents of this variable cannot be
relied upon because it can easily be faked, and if there is a
proxy between the client and the server, it is usually
totally useless.</dd>
+ <dt>REMOTE_USER</dt>
-<dt>REMOTE_USER</dt>
-
-
-<dd>This will only be set if the CGI script is subject to
+ <dd>This will only be set if the CGI script is subject to
authentication.</dd>
-
-</dl>
-
-<h2>
-<a name="cgi_debug">CGI Debugging</a>
-</h2>
-
-<p>Debugging CGI scripts has traditionally been difficult, mainly
+ </dl>
+<h2><a name="cgi_debug">CGI Debugging</a></h2>
+ <p>Debugging CGI scripts has traditionally been difficult, mainly
because it has not been possible to study the output (standard
output and error) for scripts which are failing to run
properly. These directives, included in Apache 1.2 and later,
provide more detailed logging of errors when they occur. </p>
-
<h3>CGI Logfile Format</h3>
-
-<p>When configured, the CGI error log logs any CGI which does not
+ <p>When configured, the CGI error log logs any CGI which does not
execute properly. Each CGI script which fails to operate causes
several lines of information to be logged. The first two lines
are always of the format:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
- %% [<em>time</em>] <em>request-line</em>
-<br>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ %% [<em>time</em>] <em>request-line</em><br>
%% <em>HTTP-status</em> <em>CGI-script-filename</em>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>If the error is that CGI script cannot be run, the log file
+</code></td></tr></table></blockquote>
+ <p>If the error is that CGI script cannot be run, the log file
will contain an extra two lines:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
%%error<br>
-
-<em>error-message</em>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>Alternatively, if the error is the result of the script
+ <em>error-message</em>
+</code></td></tr></table></blockquote>
+ <p>Alternatively, if the error is the result of the script
returning incorrect header information (often due to a bug in
the script), the following information is logged: </p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
%request<br>
-
-<em>All HTTP request headers received</em>
-<br>
-
-<em>POST or PUT entity (if any)</em>
-<br>
+ <em>All HTTP request headers received</em><br>
+ <em>POST or PUT entity (if any)</em><br>
%response<br>
-
-<em>All headers output by the CGI script</em>
-<br>
+ <em>All headers output by the CGI script</em><br>
%stdout<br>
-
-<em>CGI standard output</em>
-<br>
+ <em>CGI standard output</em><br>
%stderr<br>
-
-<em>CGI standard error</em>
-<br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-<p>(The %stdout and %stderr parts may be missing if the script did
+ <em>CGI standard error</em><br>
+</code></td></tr></table></blockquote>
+ <p>(The %stdout and %stderr parts may be missing if the script did
not output anything on standard output or standard error). </p>
-
-<hr>
-<h2>
-<a name="ScriptLog">ScriptLog</a> <a name="scriptlog">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Location of the CGI script error logfile</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ScriptLog <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="mod_cgi.html">mod_cgi</a></code>, <code><a href="mod_cgid.html">mod_cgid</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ScriptLog</code> directive sets the CGI
+<hr/><h2><a name="ScriptLog">ScriptLog</a> <a name="scriptlog">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Location of the CGI script error logfile</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ScriptLog <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="mod_cgi.html">mod_cgi</a></code>, <code><a href="mod_cgid.html">mod_cgid</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ScriptLog</code> directive sets the CGI
script error logfile. If no ScriptLog is given, no error log is
created. If given, any CGI errors are logged into the filename
given as argument. If this is a relative file or path it is taken
relative to the server root.</p>
-
-<p>This log will be opened as the user the child processes run
- as, ie. the user specified in the main <code class="directive"><a href="mpm_common.html#user" class="directive">User</a></code> directive. This means that
+ <p>This log will be opened as the user the child processes run
+ as, ie. the user specified in the main <a href="mpm_common.html#user" class="directive"><code class="directive">User</code></a> directive. This means that
either the directory the script log is in needs to be writable
by that user or the file needs to be manually created and set
to be writable by that user. If you place the script log in
@@ -275,105 +123,24 @@
directory permissions to make it writable by the user the child
processes run as.</p>
-
-<p>Note that script logging is meant to be a debugging feature
+ <p>Note that script logging is meant to be a debugging feature
when writing CGI scripts, and is not meant to be activated
continuously on running servers. It is not optimized for speed
or efficiency, and may have security problems if used in a
manner other than that for which it was designed.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ScriptLogBuffer">ScriptLogBuffer</a> <a name="scriptlogbuffer">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maximum amount of PUT or POST requests that will be recorded
-in the scriptlog</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ScriptLogBuffer <em>bytes</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptLogBuffer 1024</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="mod_cgi.html">mod_cgi</a></code>, <code><a href="mod_cgid.html">mod_cgid</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The size of any PUT or POST entity body that is logged to
+</usage><hr/><h2><a name="ScriptLogBuffer">ScriptLogBuffer</a> <a name="scriptlogbuffer">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maximum amount of PUT or POST requests that will be recorded
+in the scriptlog</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ScriptLogBuffer <em>bytes</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptLogBuffer 1024</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="mod_cgi.html">mod_cgi</a></code>, <code><a href="mod_cgid.html">mod_cgid</a></code></td></tr></table></td></tr></table><usage>
+ <p>The size of any PUT or POST entity body that is logged to
the file is limited, to prevent the log file growing too big
too quickly if large bodies are being received. By default, up
to 1024 bytes are logged, but this can be changed with this
directive.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ScriptLogLength">ScriptLogLength</a> <a name="scriptloglength">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Size limit of the CGI script logfile</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ScriptLogLength <em>bytes</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptLogLength 10385760</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="mod_cgi.html">mod_cgi</a></code>, <code><a href="mod_cgid.html">mod_cgid</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>
-<code class="directive">ScriptLogLength</code> can be used to limit the
+</usage><hr/><h2><a name="ScriptLogLength">ScriptLogLength</a> <a name="scriptloglength">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Size limit of the CGI script logfile</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ScriptLogLength <em>bytes</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptLogLength 10385760</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="mod_cgi.html">mod_cgi</a></code>, <code><a href="mod_cgid.html">mod_cgid</a></code></td></tr></table></td></tr></table><usage>
+ <p><code class="directive">ScriptLogLength</code> can be used to limit the
size of the CGI script logfile. Since the logfile logs a lot of
information per CGI error (all request headers, all script output)
it can grow to be a big file. To prevent problems due to unbounded
growth, this directive can be used to set an maximum file-size for
the CGI logfile. If the file exceeds this size, no more
information will be written to it.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.5 +10 -110 httpd-2.0/docs/manual/mod/mod_cgid.html
Index: mod_cgid.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_cgid.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -b -u -r1.4 -r1.5
--- mod_cgid.html 1 Mar 2002 22:16:23 -0000 1.4
+++ mod_cgid.html 6 Mar 2002 17:08:19 -0000 1.5
@@ -1,56 +1,15 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_cgid - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_cgid</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Execution of CGI scripts using an
- external CGI daemon</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>cgid_module</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
-<compatibility>Unix threaded MPMs only</compatibility>
-</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>Except for the optimizations and the additional <code class="directive"><a href="#scriptsock" class="directive">ScriptSock</a></code> directive noted below,
+--><title>mod_cgid - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_cgid</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Execution of CGI scripts using an
+ external CGI daemon</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>cgid_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Unix threaded MPMs only</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>Except for the optimizations and the additional <a href="#scriptsock" class="directive"><code class="directive">ScriptSock</code></a> directive noted below,
mod_cgid behaves similarly to mod_cgi. <strong>See the
<code><a href="mod_cgi.html">mod_cgi</a></code> Summary for additional details about
- Apache and CGI.</strong>
-</p>
-
+ Apache and CGI.</strong></p>
-<p>On certain unix operating systems, forking a process from a
+ <p>On certain unix operating systems, forking a process from a
multi-threaded server is a very expensive operation because the
new process will replicate all the threads of the parent
process. In order to avoid incurring this expense on each CGI
@@ -59,77 +18,18 @@
main server communicates with this daemon using a unix domain
socket.</p>
-
-<p>This module is used by default whenever a multi-threaded MPM
+ <p>This module is used by default whenever a multi-threaded MPM
is selected during the compilation process. At the user level,
this module is identical in configuration and operation to
<code><a href="mod_cgi.html">mod_cgi</a></code>. The only exception is the
additional directive <code>ScriptSock</code> which gives the
name of the socket to use for communication with the cgi
daemon.</p>
-
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="mod_cgi.html#scriptlog">ScriptLog</a>
-</li>
-<li>
-<a href="mod_cgi.html#scriptlogbuffer">ScriptLogBuffer</a>
-</li>
-<li>
-<a href="mod_cgi.html#scriptloglength">ScriptLogLength</a>
-</li>
-<li>
-<a href="#scriptsock">ScriptSock</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="ScriptSock">ScriptSock</a> <a name="scriptsock">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ScriptSock <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptSock logs/cgisock</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_cgid</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive sets the name of the socket to use for
+</summary><h2>Directives</h2><ul><li><a href="mod_cgi.html#scriptlog">ScriptLog</a></li><li><a href="mod_cgi.html#scriptlogbuffer">ScriptLogBuffer</a></li><li><a href="mod_cgi.html#scriptloglength">ScriptLogLength</a></li><li><a href="#scriptsock">ScriptSock</a></li></ul><hr/><h2><a name="ScriptSock">ScriptSock</a> <a name="scriptsock">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ScriptSock <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptSock logs/cgisock</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_cgid</td></tr></table></td></tr></table><usage>
+ <p>This directive sets the name of the socket to use for
communication with the CGI daemon. The socket will be opened
using the permissions of the user who starts Apache (usually
root). To maintain the security of communications with CGI
scripts, it is important that no other user has permission to
write in the directory where the socket is located.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.9 +65 -172 httpd-2.0/docs/manual/mod/mod_charset_lite.html
Index: mod_charset_lite.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_charset_lite.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -b -u -r1.8 -r1.9
--- mod_charset_lite.html 10 Dec 2001 19:07:32 -0000 1.8
+++ mod_charset_lite.html 6 Mar 2002 17:08:19 -0000 1.9
@@ -1,86 +1,48 @@
-<!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 module mod_charset_lite</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">Module mod_charset_lite</h1>
-
- <p>This module provides the ability to specify character set
- translation or recoding.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_charset_lite.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- charset_lite_module</p>
-
- <h2>Summary</h2>
-
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_charset_lite - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_charset_lite</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Specify character set translation or recoding</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>charset_lite_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This is an <strong>experimental</strong> module and should
be used with care. Experiment with your
<code>mod_charset_lite</code> configuration to ensure that it
performs the desired function.</p>
- <p><code>mod_charset_lite</code> allows the administrator to
+ <p><code><a href="mod_charset_lite.html">mod_charset_lite</a></code> allows the administrator to
specify the source character set of objects as well as the
- character set they should be translated into before sending to
- the client. <code>mod_charset_lite</code> does not translate
- the data itself but instead tells Apache what translation to
- perform. <code>mod_charset_lite</code> is applicable to EBCDIC
+ character set they should be translated into before sending to the
+ client. <code><a href="mod_charset_lite.html">mod_charset_lite</a></code> does not translate the
+ data itself but instead tells Apache what translation to
+ perform. <code><a href="mod_charset_lite.html">mod_charset_lite</a></code> is applicable to EBCDIC
and ASCII host environments. In an EBCDIC environment, Apache
- normally translates text content from the code page of the
- Apache process locale to ISO-8859-1.
- <code>mod_charset_lite</code> can be used to specify that a
- different translation is to be performed. In an ASCII
- environment, Apache normally performs no translation, so
- <code>mod_charset_lite</code> is needed in order for any
- translation to take place.</p>
+ normally translates text content from the code page of the Apache
+ process locale to ISO-8859-1. <code><a href="mod_charset_lite.html">mod_charset_lite</a></code>
+ can be used to specify that a different translation is to be
+ performed. In an ASCII environment, Apache normally performs no
+ translation, so <code><a href="mod_charset_lite.html">mod_charset_lite</a></code> is needed in
+ order for any translation to take place.</p>
<p>This module provides a small subset of configuration
mechanisms implemented by Russian Apache and its associated
<code>mod_charset</code>.</p>
+</summary><h2>Directives</h2><ul><li><a href="#charsetdefault">CharsetDefault</a></li><li><a href="#charsetoptions">CharsetOptions</a></li><li><a href="#charsetsourceenc">CharsetSourceEnc</a></li></ul><h2>Common Problems</h2>
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#charsetsourceenc">CharsetSourceEnc</a></li>
-
- <li><a href="#charsetdefault">CharsetDefault</a></li>
-
- <li><a href="#charsetoptions">CharsetOptions</a></li>
- </ul>
-
- <h2>Common Problems</h2>
-
- <h3>Invalid character set names</h3>
+<h3>Invalid character set names</h3>
- <p>The character set name parameters of CharsetSourceEnc and
- CharsetDefault must be acceptable to the translation mechanism
- used by APR on the system where mod_charset_lite is deployed.
- These character set names are not standardized and are usually
- not the same as the corresponding values used in http headers.
- Currently, APR can only use iconv(3), so you can easily test
- your character set names using the iconv(1) program, as
- follows:</p>
-<pre>
+ <p>The character set name parameters of <a href="#charsetsourceenc" class="directive"><code class="directive">CharsetSourceEnc</code></a> and
+ <a href="#charsetdefault" class="directive"><code class="directive">CharsetDefault</code></a>
+ must be acceptable to the translation mechanism used by APR on the
+ system where <code><a href="mod_charset_lite.html">mod_charset_lite</a></code> is deployed. These
+ character set names are not standardized and are usually not the
+ same as the corresponding values used in http headers. Currently,
+ APR can only use iconv(3), so you can easily test your character
+ set names using the iconv(1) program, as follows:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
iconv -f charsetsourceenc-value -t charsetdefault-value
+</code></td></tr></table></blockquote>
-</pre>
- <h3>Mismatch between character set of content and translation
+<h3>Mismatch between character set of content and translation
rules</h3>
<p>If the translation rules don't make sense for the content,
@@ -94,68 +56,9 @@
characters (e.g., question marks) in the output buffer when
it cannot translate the input buffer.</li>
</ul>
- <hr />
- <h2><a id="charsetsourceenc"
- name="charsetsourceenc">CharsetSourceEnc</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> CharsetSourceEnc
- <em>charset</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>None</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory, virtual
- host<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a>
- <em>FileInfo</em><br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_charset_lite<br />
- </p>
-
- <p>The <code>CharsetSourceEnc</code> directive specifies the
- source charset of files in the associated container.</p>
-
- <p>The value of the <em>charset</em> argument must be accepted
- as a valid character set name by the character set support in
- APR. Generally, this means that it must be supported by
- iconv.</p>
- Example:
-<pre>
- <Directory "/export/home/trawick/apacheinst/htdocs/convert">
- CharsetSourceEnc UTF-16BE
- CharsetDefault ISO8859-1
- </Directory>
-
-</pre>
- The character set names in this example work with the iconv
- translation support in Solaris 8.
- <hr />
-
- <h2><a id="charsetdefault"
- name="charsetdefault">CharsetDefault</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> CharsetDefault
- <em>charset</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>None</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory, virtual
- host<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a>
- <em>FileInfo</em><br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_charset_lite<br />
- </p>
-
- <p>The <code>CharsetDefault</code> directive specifies the
+<hr/><h2><a name="CharsetDefault">CharsetDefault</a> <a name="charsetdefault">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Charset to translate into</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CharsetDefault <em>charset</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_charset_lite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">CharsetDefault</code> directive specifies the
charset that content in the associated container should be
translated to.</p>
@@ -164,47 +67,25 @@
APR. Generally, this means that it must be supported by
iconv.</p>
Example:
-<pre>
- <Directory "/export/home/trawick/apacheinst/htdocs/convert">
- CharsetSourceEnc UTF-16BE
- CharsetDefault ISO8859-1
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <Directory "/export/home/trawick/apacheinst/htdocs/convert"><br>
+ CharsetSourceEnc UTF-16BE<br>
+ CharsetDefault ISO8859-1<br>
</Directory>
-
-</pre>
- <hr />
-
- <h2><a id="charsetoptions"
- name="charsetoptions">CharsetOptions</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> CharsetOptions
- <em>option</em> [<em>option</em>] ...<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>DebugLevel=0</em>
- <em>NoImplicitAdd</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory, virtual
- host<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a>
- <em>FileInfo</em><br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_charset_lite<br />
- </p>
-
- <p>The <code>CharsetOptions</code> directive configures certain
- behaviors of <code>mod_charset_lite</code>. <em>Option</em> can
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="CharsetOptions">CharsetOptions</a> <a name="charsetoptions">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures charset tranlation behavior</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CharsetOptions <em>option</em> [<em>option</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>CharsetOptions DebugLevel=0
+NoImplicitAdd</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_charset_lite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">CharsetOptions</code> directive configures certain
+ behaviors of <code><a href="mod_charset_lite.html">mod_charset_lite</a></code>. <em>Option</em> can
be one of</p>
<dl>
<dt>DebugLevel=<em>n</em></dt>
- <dd>The <samp>DebugLevel</samp> keyword allows you to specify
+ <dd>The <code>DebugLevel</code> keyword allows you to specify
the level of debug messages generated by
- <code>mod_charset_lite</code>. By default, no messages are
- generated. This is equivalent to <samp>DebugLevel=0</samp>.
+ <code><a href="mod_charset_lite.html">mod_charset_lite</a></code>. By default, no messages are
+ generated. This is equivalent to <code>DebugLevel=0</code>.
With higher numbers, more debug messages are generated, and
server performance will be degraded. The actual meanings of
the numeric values are described with the definitions of the
@@ -213,17 +94,29 @@
<dt>ImplicitAdd | NoImplicitAdd</dt>
- <dd>The <samp>ImplicitAdd</samp> keyword specifies that
- <code>mod_charset_lite</code> should implicitly insert its
+ <dd>The <code>ImplicitAdd</code> keyword specifies that
+ <code><a href="mod_charset_lite.html">mod_charset_lite</a></code> should implicitly insert its
filter when the configuration specifies that the character
set of content should be translated. If the filter chain is
explicitly configured using the AddOutputFilter directive,
- <samp>NoImplicitAdd</samp> should be specified so that
- <code>mod_charset_lite</code> doesn't add its filter.</dd>
+ <code>NoImplicitAdd</code> should be specified so that
+ <code><a href="mod_charset_lite.html">mod_charset_lite</a></code> doesn't add its filter.</dd>
</dl>
- <br />
- <br />
- <!--#include virtual="footer.html" -->
- </body>
-</html>
+</usage><hr/><h2><a name="CharsetSourceEnc">CharsetSourceEnc</a> <a name="charsetsourceenc">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Source charset of files</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CharsetSourceEnc <em>charset</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_charset_lite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">CharsetSourceEnc</code> directive specifies the
+ source charset of files in the associated container.</p>
+ <p>The value of the <em>charset</em> argument must be accepted
+ as a valid character set name by the character set support in
+ APR. Generally, this means that it must be supported by
+ iconv.</p>
+ Example:
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <Directory "/export/home/trawick/apacheinst/htdocs/convert"><br>
+ CharsetSourceEnc UTF-16BE<br>
+ CharsetDefault ISO8859-1<br>
+ </Directory>
+</code></td></tr></table></blockquote>
+ <p>The character set names in this example work with the iconv
+ translation support in Solaris 8.</p>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.6 +58 -189 httpd-2.0/docs/manual/mod/mod_dav.html
Index: mod_dav.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_dav.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -b -u -r1.5 -r1.6
--- mod_dav.html 22 Sep 2001 19:36:01 -0000 1.5
+++ mod_dav.html 6 Mar 2002 17:08:19 -0000 1.6
@@ -1,34 +1,10 @@
-<!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 module mod_dav</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">Module mod_dav</h1>
-
- <p>This module provides Distributed Authoring and Versioning
- (<a href="http://www.webdav.org/">WebDAV</a>)
- functionality.</p>
- <a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension <br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a> mod_dav.c <br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a> dav_module
-
- <h2>Summary</h2>
-
- <p>This module provides class 1 and class 2 <a
- href="http://www.webdav.org">WebDAV</a> ('Web-based Distributed
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_dav - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_dav</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Distributed Authoring and Versioning
+(<a href="http://www.webdav.org/">WebDAV</a>) functionality</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>dav_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This module provides class 1 and class 2 <a href="http://www.webdav.org">WebDAV</a> ('Web-based Distributed
Authoring and Versioning') functionality for Apache. This
extension to the HTTP protocol allows creating, moving,
copying, and deleting resources and collections on a remote web
@@ -37,178 +13,71 @@
<p>To enable mod_dav, add the following to a container in your
<code>httpd.conf</code> file:</p>
- <blockquote>
- <code>Dav On</code>
- </blockquote>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Dav On</code></td></tr></table></blockquote>
<p>Also, specify a valid filename for the DAV lock database by
adding the following to the global section in your
<code>httpd.conf</code> file:</p>
- <blockquote>
- <code>DavLockDB /tmp/DavLock </code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>DavLockDB /tmp/DavLock
<em>(Any web-server writable filename, without an
extension)</em>
- </blockquote>
-
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#DAV">Dav</a></li>
-
- <li><a href="#DAVLockDB">DavLockDB</a></li>
-
- <li><a href="#DAVMinTimeout">DavMinTimeout</a></li>
-
- <li><a href="#DAVDepthInfinity">DavDepthInfinity</a></li>
- </ul>
- <hr />
-
- <h2><a id="DAV" name="DAV">Dav</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Dav on|off<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>Dav
- off</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_dav<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.3.4 and
- above
-
- <p>Use the <code>Dav</code> directive to enable the WebDAV HTTP
- methods for the given container. You may wish to add a <a
- href="core.html#limit"><Limit></a> clause inside the <a
- href="core.html#location">location</a> directive to limit
- access to DAV-enabled locations.</p>
-
- <table width="70%" border="0" bgcolor="#E0E0F0" cellspacing="0"
- cellpadding="10">
- <tr>
- <td><strong>Example</strong>:<br />
- <br />
- <code>DavLockDB /tmp/DavLock<br />
- <br />
- <Location /foo><br />
- Dav On<br />
- <br />
- AuthType Basic<br />
- AuthName DAV<br />
- AuthUserFile user.passwd<br />
- <br />
- <LimitExcept GET HEAD OPTIONS><br />
- require user admin<br />
- </LimitExcept><br />
- </Location><br />
- </code> </td>
- </tr>
- </table>
- <br />
-
- <hr />
-
- <h2><a id="DavLockDB" name="DavLockDB">DavLockDB</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DavLockDB
- <em>filename</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>None</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_dav
-
- <p>Use the <code>DavLockDB</code> directive to specify the full
- path to the lock database, excluding an extension. The default
- (file system) implementation of mod_dav uses a SDBM database to
- track user locks. The utility
- <code>modules/dav/util/lockview</code> can be used from the
- server to display all locks in a lock database.</p>
-
- <table width="70%" border="0" bgcolor="#E0E0F0" cellspacing="0"
- cellpadding="10">
- <tr>
- <td><strong>Example</strong>:<br />
- <br />
- <code>DavLockDB /tmp/DavLock<br />
- <br />
- </code> </td>
- </tr>
- </table>
- <br />
-
- <hr />
+</code></td></tr></table></blockquote>
+</summary><h2>Directives</h2><ul><li><a href="#dav">Dav</a></li><li><a href="#davdepthinfinity">DavDepthInfinity</a></li><li><a href="#davlockdb">DavLockDB</a></li><li><a href="#davmintimeout">DavMinTimeout</a></li></ul><hr/><h2><a name="Dav">Dav</a> <a name="dav">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enable WebDAV HTTP methods</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Dav on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Dav off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dav</td></tr></table></td></tr></table><usage>
+ <p>Use the <code class="directive">Dav</code> directive to enable the
+ WebDAV HTTP methods for the given container. You may wish to add a
+ <a href="core.html#limit" class="directive"><code class="directive"><Limit></code></a> clause
+ inside the <a href="core.html#location" class="directive"><code class="directive"><location></code></a> directive to limit access to
+ DAV-enabled locations.</p>
- <h2><a id="DavMinTimeout"
- name="DavMinTimeout">DavMinTimeout</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DavMinTimeout
- <em>seconds</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>DavMinTimeout
- 0</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_dav
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
+ DavLockDB /tmp/DavLock<br>
+ <br>
+ <Location /foo><br>
+ Dav On<br>
+ <br>
+ AuthType Basic<br>
+ AuthName DAV<br>
+ AuthUserFile user.passwd<br>
+ <br>
+ <LimitExcept GET HEAD OPTIONS><br>
+ require user admin<br>
+ </LimitExcept><br>
+ </Location><br>
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="DavDepthInfinity">DavDepthInfinity</a> <a name="davdepthinfinity">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Allow PROPFIND, Depth: Infinity requests</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DavDepthInfinity on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DavDepthInfinity off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dav</td></tr></table></td></tr></table><usage>
+ <p>Use the <code class="directive">DavDepthInfinity</code> directive to
+ allow the processing of PROPFIND requests containing the header
+ 'Depth: Infinity'. Because this type of request could constitute a
+ denial-of-service attack, by default it is not allowed.</p>
+</usage><hr/><h2><a name="DavLockDB">DavLockDB</a> <a name="davlockdb">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Location of the DAV lock database</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DavLockDB <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dav</td></tr></table></td></tr></table><usage>
+ <p>Use the <code class="directive">DavLockDB</code> directive to specify
+ the full path to the lock database, excluding an extension. The
+ default (file system) implementation of mod_dav uses a SDBM
+ database to track user locks. The utility
+ <code>modules/dav/util/lockview</code> can be used from the server
+ to display all locks in a lock database.</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
+DavLockDB /tmp/DavLock
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="DavMinTimeout">DavMinTimeout</a> <a name="davmintimeout">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Minimum amount of time the server holds a lock on
+a DAV resource</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DavMinTimeout <em>seconds</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DavMinTimeout 0</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dav</td></tr></table></td></tr></table><usage>
<p>When a client requests a DAV resource lock, it can also
specify a time when the lock will be automatically removed by
the server. This value is only a request, and the server can
ignore it or inform the client of an arbitrary value.</p>
- <p>Use the <code>DavMinTimeout</code> directive to specify, in
+ <p>Use the <code class="directive">DavMinTimeout</code> directive to specify, in
seconds, the minimum lock timeout to return to a client.
Microsoft Web Folders defaults to a timeout of 120 seconds; the
- <code>DavMinTimeout</code> can override this to a higher value
+ <code class="directive">DavMinTimeout</code> can override this to a higher value
(like 600 seconds) to reduce the chance of the client losing
the lock due to network latency.</p>
- <table width="70%" border="0" bgcolor="#E0E0F0" cellspacing="0"
- cellpadding="10">
- <tr>
- <td><strong>Example</strong>:<br />
- <br />
- <code><Location /MSWord><br />
- DavMinTimeout 600<br />
- </Location><br />
- <br />
- </code> </td>
- </tr>
- </table>
- <br />
-
- <hr />
-
- <h2><a id="DavDepthInfinity"
- name="DavDepthInfinity">DavDepthInfinity</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DavDepthInfinity
- on|off<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>DavDepthInfinity
- off</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_dav
-
- <p>Use the <code>DavDepthInfinity</code> directive to allow the
- processing of PROPFIND requests containing the header 'Depth:
- Infinity'. Because this type of request could constitute a
- denial-of-service attack, by default it is not allowed.</p>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
+ <Location /MSWord><br>
+ DavMinTimeout 600<br>
+ </Location><br>
+</code></td></tr></table></blockquote>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.5 +33 -146 httpd-2.0/docs/manual/mod/mod_deflate.html
Index: mod_deflate.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_deflate.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -b -u -r1.4 -r1.5
--- mod_deflate.html 20 Feb 2002 16:50:40 -0000 1.4
+++ mod_deflate.html 6 Mar 2002 17:08:19 -0000 1.5
@@ -1,56 +1,14 @@
-<!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 module mod_deflate</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">Module mod_deflate</h1>
-
- <p>This module provides the ability to compress content before
- it is delivered to the client.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_deflate.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- deflate_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 2.0 and later.</p>
-
- <h2>Summary</h2>
-
- <p>The experimental <samp>mod_deflate</samp> module allows
- output from your server to be compressed before being sent
- to the client over the network.</p>
-
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#DeflateFilterNote">DeflateFilterNote</a></li>
-
- <li><a href="#DeflateWindowSize">DeflateWindowSize</a></li>
-
- <li><a href="#DeflateMemLevel">DeflateMemLevel</a></li>
- </ul>
-
- <p>See also: <a href="mod_mime.html#addoutputfilter">
- AddOutputFilter</a> and <a href="core.html#setoutputfilter">
- SetOutputFilter</a>
-
- <h2>Enabling Compression</h2>
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_deflate - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_deflate</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Compress content before
+ it is delivered to the client</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>experimental</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>deflate_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>The experimental <code><a href="mod_deflate.html">mod_deflate</a></code> module provides
+ the <code>DEFLATE</code> output filter that allows output from
+ your server to be compressed before being sent to the client over
+ the network.</p>
+</summary><p><strong>See also </strong></p><ul><li><a href="mod_mime.html#addoutputfilter" class="directive"><code class="directive">AddOutputFilter</code></a></li><li><a href="core.html#setoutputfilter" class="directive"><code class="directive">SetOutputFilter</code></a></li></ul><h2>Directives</h2><ul><li><a href="#deflatefilternote">DeflateFilterNote</a></li><li><a href="#deflatememlevel">DeflateMemLevel</a></li><li><a href="#deflatewindowsize">DeflateWindowSize</a></li></ul><h2>Enabling Compression</h2>
<p>Compression is implemented by the <code>DEFLATE</code>
<a href="../filter.html">filter</a>. The following directive
@@ -60,101 +18,30 @@
so you may want to enable the 'gzip-only-text/html' note (see below)
</strong></p>
- <blockquote>
- <code>SetEnv gzip-only-text/html 1</code><br />
- <code>SetOutputFilter DEFLATE</code>
- </blockquote>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>SetEnv gzip-only-text/html 1<br>
+SetOutputFilter DEFLATE
+</code></td></tr></table></blockquote>
<p>Here is an example of enabling compression for the Apache
documentation:</p>
- <blockquote>
- <code><Directory "/your-server-root/manual"><br />
- SetEnv gzip-only-text/html 1<br />
- SetOutputFilter DEFLATE</code><br />
- <em>leave the existing directives as-is</em><br />
- <code></Directory></code>
- </blockquote>
-
- <hr />
- <!-- the HR is part of the directive description -->
-
- <h2><a id="DeflateFilterNote" name="DeflateFilterNote">DeflateFilterNote
- directive</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DeflateFilterNote <em>notename
- </em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <i>none</i><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> none<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_deflate<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
- above</p>
-
- <p>The DeflateFilterNote directive specifies that a note about
- compression ratios should be attached to the request. The name
- of the note is the value specified for the directive.</p>
-
- <hr />
- <!-- the HR is part of the directive description -->
-
- <h2><a id="DeflateWindowSize"
- name="DeflateWindowSize">DeflateWindowSize directive</a></h2>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+<Directory "/your-server-root/manual"><br>
+ SetEnv gzip-only-text/html 1<br>
+ SetOutputFilter DEFLATE<br>
+</Directory>
+</code></td></tr></table></blockquote>
+<hr/><h2><a name="DeflateFilterNote">DeflateFilterNote</a> <a name="deflatefilternote">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Places the compression ratio in a note for logging</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DeflateFilterNote <em>notename</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_deflate</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">DeflateFilterNote</code> directive
+ specifies that a note about compression ratios should be attached
+ to the request. The name of the note is the value specified for
+ the directive.</p>
+</usage><hr/><h2><a name="DeflateMemLevel">DeflateMemLevel</a> <a name="deflatememlevel">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Amount of memory available to zlib for compression</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DeflateMemLevel <em>value</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_deflate</td></tr></table></td></tr></table><usage>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DeflateWindowSize
- <em>value</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>none</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> none<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_deflate<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
- above</p>
+ <p>The <code class="directive">DeflateMemLevel</code> directive specifies
+ the amount of memory available to zlib for compression.</p>
+</usage><hr/><h2><a name="DeflateWindowSize">DeflateWindowSize</a> <a name="deflatewindowsize">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Zlib compression window size</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DeflateWindowSize <em>value</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_deflate</td></tr></table></td></tr></table><usage>
- <p>The <samp>DeflateWindowSize</samp> directive specifies the
+ <p>The <code class="directive">DeflateWindowSize</code> directive specifies the
zlib compression window size.</p>
-
- <hr />
- <!-- the HR is part of the directive description -->
-
- <h2><a id="DeflateMemLevel" name="DeflateMemLevel">DeflateMemLevel
- directive</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DeflateMemLevel
- <em>value</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>none</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> none<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_deflate<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
- above</p>
-
- <p>The DeflateMemLevel directive specifies the amount of
- memory available to zlib for compression.</p>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
-
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.17 +36 -94 httpd-2.0/docs/manual/mod/mod_dir.html
Index: mod_dir.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_dir.html,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -d -b -u -r1.16 -r1.17
--- mod_dir.html 22 Sep 2001 19:36:01 -0000 1.16
+++ mod_dir.html 6 Mar 2002 17:08:19 -0000 1.17
@@ -1,115 +1,57 @@
-<!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 module mod_dir</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">Module mod_dir</h1>
-
- <p>This module provides for "trailing slash" redirects and
- serving directory index files.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a> mod_dir.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- dir_module</p>
-
- <h2>Summary</h2>
- The index of a directory can come from one of two sources:
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_dir - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_dir</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Provides for "trailing slash" redirects and
+ serving directory index files</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>dir_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>The index of a directory can come from one of two sources:</p>
<ul>
<li>A file written by the user, typically called
- <code>index.html</code>. The <a
- href="#directoryindex">DirectoryIndex</a> directive sets the
+ <code>index.html</code>. The <a href="#directoryindex" class="directive"><code class="directive">DirectoryIndex</code></a> directive sets the
name of this file. This is controlled by
- <code>mod_dir</code>.</li>
+ <code><a href="mod_dir.html">mod_dir</a></code>.</li>
<li>Otherwise, a listing generated by the server. This is
- provided by <a
- href="mod_autoindex.html"><code>mod_autoindex</code></a>.</li>
+ provided by <code><a href="mod_autoindex.html">mod_autoindex</a></code>.</li>
</ul>
- The two functions are separated so that you can completely
+ <p>The two functions are separated so that you can completely
remove (or replace) automatic index generation should you want
- to.
+ to.</p>
<p>A "trailing slash" redirect is issued when the server
receives a request for a URL
- <samp>http://servername/foo/dirname</samp> where
- <samp>dirname</samp> is a directory. Directories require a
- trailing slash, so <code>mod_dir</code> issues a redirect to
- <samp>http://servername/foo/dirname/</samp>.</p>
-
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#directoryindex">DirectoryIndex</a></li>
- </ul>
- <hr />
-
- <h2><a id="directoryindex"
- name="directoryindex">DirectoryIndex</a> directive</h2>
- <!--%plaintext <?INDEX {\tt DirectoryIndex} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DirectoryIndex
- <em>local-url</em> [<em>local-url</em>] ...<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>DirectoryIndex
- index.html</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_dir
-
- <p>The DirectoryIndex directive sets the list of resources to
- look for, when the client requests an index of the directory by
- specifying a / at the end of the a directory name.
- <em>Local-url</em> is the (%-encoded) URL of a document on the
- server relative to the requested directory; it is usually the
+ <code>http://servername/foo/dirname</code> where
+ <code>dirname</code> is a directory. Directories require a
+ trailing slash, so <code><a href="mod_dir.html">mod_dir</a></code> issues a redirect to
+ <code>http://servername/foo/dirname/</code>.</p>
+</summary><h2>Directives</h2><ul><li><a href="#directoryindex">DirectoryIndex</a></li></ul><hr/><h2><a name="DirectoryIndex">DirectoryIndex</a> <a name="directoryindex">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>List of resources to look for when the client requests
+a directory</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>DirectoryIndex
+ <em>local-url</em> [<em>local-url</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DirectoryIndex index.html</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dir</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">DirectoryIndex</code> directive sets the
+ list of resources to look for, when the client requests an index
+ of the directory by specifying a / at the end of the a directory
+ name. <em>Local-url</em> is the (%-encoded) URL of a document on
+ the server relative to the requested directory; it is usually the
name of a file in the directory. Several URLs may be given, in
- which case the server will return the first one that it finds.
- If none of the resources exist and the <code>Indexes</code>
- option is set, the server will generate its own listing of the
+ which case the server will return the first one that it finds. If
+ none of the resources exist and the <code>Indexes</code> option is
+ set, the server will generate its own listing of the
directory.</p>
- <p>Example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
+DirectoryIndex index.html
+</code></td></tr></table></blockquote>
- <blockquote>
- <code>DirectoryIndex index.html</code>
- </blockquote>
- then a request for <code>http://myserver/docs/</code> would
+ <p>then a request for <code>http://myserver/docs/</code> would
return <code>http://myserver/docs/index.html</code> if it
- exists, or would list the directory if it did not.
+ exists, or would list the directory if it did not.</p>
<p>Note that the documents do not need to be relative to the
directory;</p>
- <blockquote>
- <code>DirectoryIndex index.html index.txt
- /cgi-bin/index.pl</code>
- </blockquote>
- would cause the CGI script <code>/cgi-bin/index.pl</code> to be
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>DirectoryIndex index.html index.txt /cgi-bin/index.pl</code></td></tr></table></blockquote>
+ <p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be
executed if neither <code>index.html</code> or
- <code>index.txt</code> existed in a directory.
-
- <p><!--#include virtual="footer.html" -->
- </p>
- </body>
-</html>
-
+ <code>index.txt</code> existed in a directory.</p>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.21 +17 -117 httpd-2.0/docs/manual/mod/mod_env.html
Index: mod_env.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_env.html,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -d -b -u -r1.20 -r1.21
--- mod_env.html 5 Dec 2001 16:46:14 -0000 1.20
+++ mod_env.html 6 Mar 2002 17:08:19 -0000 1.21
@@ -1,132 +1,32 @@
-<!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 module mod_env</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 module mod_env</h1>
-
- <p>This module provides for modifying the environment which is
- passed to CGI scripts and SSI pages.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a> mod_env.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- env_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.1 and later.</p>
-
- <h2>Summary</h2>
-
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_env - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_env</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Modifies the environment which is
+ passed to CGI scripts and SSI pages</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>env_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This module allows for control of the environment that will
be provided to CGI scripts and SSI pages. Environment variables
may be passed from the shell which invoked the httpd process.
Alternatively, environment variables may be set or unset within
the configuration process.</p>
-
- <p>For additional information, we provide a document on <a
- href="../env.html">Environment Variables in Apache</a>.</p>
-
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#passenv">PassEnv</a></li>
-
- <li><a href="#setenv">SetEnv</a></li>
-
- <li><a href="#unsetenv">UnsetEnv</a></li>
- </ul>
- <hr />
-
- <h2><a id="passenv" name="passenv">PassEnv</a> directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> PassEnv
- <em>env-variable</em> [<em>env-variable</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> FileInfo<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_env<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> PassEnv is only
- available in Apache 1.1 and later. Directory and .htaccess context
- is availble in Apache 1.3.7 and later.
-
+ </summary><p><strong>See also </strong></p><ul><li><a href="../env.html">Environment Variables</a></li></ul><h2>Directives</h2><ul><li><a href="#passenv">PassEnv</a></li><li><a href="#setenv">SetEnv</a></li><li><a href="#unsetenv">UnsetEnv</a></li></ul><hr/><h2><a name="PassEnv">PassEnv</a> <a name="passenv">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Passes environment variables from the shell</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>PassEnv
+ <em>env-variable</em> [<em>env-variable</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_env</td></tr></table></td></tr></table><usage>
<p>Specifies one or more environment variables to pass to CGI
scripts and SSI pages from the environment of the shell which
invoked the httpd process. Example:</p>
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
PassEnv LD_LIBRARY_PATH
-</pre>
- <hr />
-
- <h2><a id="setenv" name="setenv">SetEnv</a> directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SetEnv <em>env-variable
- value</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> FileInfo<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_env<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> SetEnv is only
- available in Apache 1.1 and later. Directory and .htaccess context
- is availble in Apache 1.3.7 and later.
-
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="SetEnv">SetEnv</a> <a name="setenv">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets environment variables</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SetEnv <em>env-variable value</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_env</td></tr></table></td></tr></table><usage>
<p>Sets an environment variable, which is then passed on to CGI
scripts and SSI pages. Example:</p>
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
SetEnv SPECIAL_PATH /foo/bin
-</pre>
- <hr />
-
- <h2><a id="unsetenv" name="unsetenv">UnsetEnv</a>
- directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> UnsetEnv
- <em>env-variable</em> [<em>env-variable</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> FileInfo<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_env<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> UnsetEnv is only
- available in Apache 1.1 and later. Directory and .htaccess context
- is availble in Apache 1.3.7 and later.
-
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="UnsetEnv">UnsetEnv</a> <a name="unsetenv">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Removes variables from the environment</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>UnsetEnv <em>env-variable</em> [<em>env-variable</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_env</td></tr></table></td></tr></table><usage>
<p>Removes one or more environment variables from those passed
on to CGI scripts and SSI pages. Example:</p>
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
UnsetEnv LD_LIBRARY_PATH
-</pre>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
-
+</code></td></tr></table></blockquote>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.49 +124 -236 httpd-2.0/docs/manual/mod/mod_include.html
Index: mod_include.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_include.html,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -d -b -u -r1.48 -r1.49
--- mod_include.html 20 Feb 2002 15:20:32 -0000 1.48
+++ mod_include.html 6 Mar 2002 17:08:19 -0000 1.49
@@ -1,32 +1,9 @@
-<!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 module mod_include</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">Module mod_include</h1>
-
- <p>This module provides for server-parsed html documents.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_include.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- include_module</p>
-
- <h2>Summary</h2>
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_include - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_include</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides for server-parsed html
+documents.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>include_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility></compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This module provides a filter which will process files
before they are sent to the client. The processing is
@@ -35,21 +12,13 @@
inclusion other files or programs, as well as the setting and
printing of environment variables.</p>
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#ssiendtag">SSIEndTag</a></li>
- <li><a href="#ssierrormsg">SSIErrorMsg</a></li>
- <li><a href="#ssistarttag">SSIStartTag</a></li>
- <li><a href="#ssitimeformat">SSITimeFormat</a></li>
- <li><a href="#xbithack">XBitHack</a></li>
- </ul>
+ <seealso><strong>See also</strong>:
+ <a href="core.html#options" class="directive"><code class="directive">Options</code></a>,
+ <a href="core.html#setoutputfilter" class="directive"><code class="directive">SetOutputFilter</code></a>
+ and <a href="core.html#acceptpathinfo" class="directive"><code class="directive">AcceptPathInfo</code></a>.</seealso>
- <p>See also: <a href="core.html#options">Options</a>, <a
- href="core.html#SetOutputFilter">SetOutputFilter</a>,
- and <a href="core.html#acceptpathinfo">AcceptPathInfo</a>.</p>
+</summary><h2>Directives</h2><ul><li><a href="#ssiendtag">SSIEndTag</a></li><li><a href="#ssierrormsg">SSIErrorMsg</a></li><li><a href="#ssistarttag">SSIStartTag</a></li><li><a href="#ssitimeformat">SSITimeFormat</a></li><li><a href="#xbithack">XBitHack</a></li></ul><h2><a name="enabling">Enabling Server-Side Includes</a></h2>
- <h2>Enabling Server-Side Includes</h2>
<p>Server Side Includes are implemented by the
<code>INCLUDES</code> <a href="../filter.html">filter</a>. If
@@ -58,10 +27,10 @@
parse them and assign the resulting document the mime type of
<code>text/html</code>:</p>
- <blockquote>
- <code>AddType text/html .shtml<br />
- AddOutputFilter INCLUDES .shtml</code>
- </blockquote>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ AddType text/html .shtml<br>
+ AddOutputFilter INCLUDES .shtml
+ </code></td></tr></table></blockquote>
<p>The following directive must be given for the directories
containing the shtml files (typically in a
@@ -69,9 +38,9 @@
also valid .htaccess files if <code>AllowOverride
Options</code> is set):</p>
- <blockquote>
- <code>Options +Includes</code>
- </blockquote>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ Options +Includes
+ </code></td></tr></table></blockquote>
<p>For backwards compatibility, the <code>server-parsed</code>
<a href="../handler.html">handler</a> also activates the
@@ -81,23 +50,23 @@
<code>text/x-server-parsed-html3</code> (and the resulting
output will have the mime type <code>text/html</code>).</p>
- <p>For more information, see our <a
- href="../howto/ssi.html">Tutorial on Server Side
- Includes</a>.</p>
+ <seealso>For more information, see our <a href="../howto/ssi.html">Tutorial on Server Side
+ Includes</a>.</seealso>
+<h2><a name="basic">Basic Elements</a></h2>
- <h2>Basic Elements</h2>
- The document is parsed as an HTML document, with special
- commands embedded as SGML comments. A command has the syntax:
+ <p>The document is parsed as an HTML document, with special
+ commands embedded as SGML comments. A command has the syntax: </p>
- <blockquote>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<code><!--#</code><em>element attribute=value
attribute=value ...</em> <code>--></code>
- </blockquote>
- The value will often be enclosed in double quotes; many
+ </code></td></tr></table></blockquote>
+
+ <p>The value will often be enclosed in double quotes; many
commands only allow a single attribute-value pair. Note that
the comment terminator (<samp>--></samp>) should be preceded
by whitespace to ensure that it isn't considered part of an SSI
- token.
+ token. </p>
<p>The allowed elements are:</p>
@@ -133,11 +102,12 @@
<dt><strong><a id="echo" name="echo">echo</a></strong></dt>
<dd>
- This command prints one of the <a href="#includevars">include
- variables</a>, defined
- below. If the variable is unset, it is printed as
- <code>(none)</code>. Any dates printed are subject to the
- currently configured <code>timefmt</code>. Attributes:
+ <p>This command prints one of the <a href="#includevars">include
+ variables</a>, defined below. If the variable is unset, it
+ is printed as <code>(none)</code>. Any dates printed are
+ subject to the currently configured <code>timefmt</code>.</p>
+
+ <p>Attributes:</p>
<dl>
<dt><strong>var</strong></dt>
@@ -173,8 +143,7 @@
<dd>
The exec command executes a given shell command or CGI
- script. The IncludesNOEXEC <a
- href="core.html#options">Option</a> disables this command
+ script. The IncludesNOEXEC <a href="core.html#option" class="directive"><code class="directive">Option</code></a> disables this command
completely. The valid attributes are:
<dl>
@@ -188,9 +157,8 @@
invoked as a CGI script, even if the server would not
normally recognize it as such. However, the directory
containing the script must be enabled for CGI scripts
- (with <a
- href="mod_alias.html#scriptalias">ScriptAlias</a> or
- the ExecCGI <a href="core.html#options">Option</a>).
+ (with <a href="mod_alias.html#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a>
+ or the ExecCGI <a href="core.html#option" class="directive"><code class="directive">Option</code></a>).
<p>The CGI script is given the PATH_INFO and query
string (QUERY_STRING) of the original request from the
@@ -201,7 +169,7 @@
<p>For example:</p>
- <code><!--#exec cgi="/cgi-bin/example.cgi" --></code>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code><!--#exec cgi="/cgi-bin/example.cgi" --></code></td></tr></table></blockquote>
<p>If the script returns a Location: header instead of
output, then this will be translated into an HTML
@@ -215,15 +183,17 @@
cgi</code>, but can be done with <code>include
virtual</code>, as shown here:</p>
- <code><!--#include virtual="/cgi-bin/example.cgi?argument=value" --></code>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <!--#include virtual="/cgi-bin/example.cgi?argument=value" -->
+ </code></td></tr></table></blockquote>
+
</dd>
<dt><strong>cmd</strong></dt>
<dd>
<p>The server will execute the given string using
- <code>/bin/sh</code>. The <a
- href="#includevars">include variables</a> are available
+ <code>/bin/sh</code>. The <a href="#includevars">include variables</a> are available
to the command, in addition to the usual set of CGI
variables.</p>
@@ -241,7 +211,9 @@
non-suexec configuration on unix, it will not produce the
desired result under Win32, or when running suexec:</p>
- <code><!--#exec cmd="perl /path/to/perlscript arg1 arg2" --></code>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <!--#exec cmd="perl /path/to/perlscript arg1 arg2" -->
+ </code></td></tr></table></blockquote>
</dd>
</dl>
@@ -289,8 +261,6 @@
Otherwise CGI scripts are invoked as normal using the
complete URL given in the command, including any query
string.
- <!--%plaintext <?INDEX CGI scripts, {\tt include} element and> -->
-
<p>An attribute defines the location of the document; the
inclusion is done for each attribute given to the include
@@ -327,11 +297,13 @@
in the parsed file. You may include a query string in a CGI
url:</p>
- <code><!--#include virtual="/cgi-bin/example.cgi?argument=value" --></code>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <!--#include virtual="/cgi-bin/example.cgi?argument=value" -->
+ </code></td></tr></table></blockquote>
<p><code>include virtual</code> should be used in preference
to <code>exec cgi</code> to include the output of CGI
- programs into an HTML document.
+ programs into an HTML document.</p>
</dd>
</dl>
</dd>
@@ -341,13 +313,14 @@
<dd>
<p>This prints out a listing of all existing variables and
their values. Starting with Apache 1.3.12, special characters
- are entity encoded (see the <a
- href="#echo"><code>echo</code></a> element for details)
+ are entity encoded (see the <a href="#echo"><code>echo</code></a> element for details)
before being output. There are no attributes.</p>
<p>For example:</p>
- <p><code><!--#printenv --></code></p>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <!--#printenv -->
+ </code></td></tr></table></blockquote>
<p>The <strong>printenv</strong> element is available only in
Apache 1.2 and above.</p>
@@ -366,16 +339,19 @@
<dd>The value to give a variable.</dd>
</dl>
- <p>
- For example: <code><!--#set var="category" value="help"
- --></code></p>
+ <p>For example:</p>
+
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <!--#set var="category" value="help" -->
+ </code></td></tr></table></blockquote>
<p>The <strong>set</strong> element is available only in
Apache 1.2 and above.</p>
</dd>
</dl>
+<h2><a name="includevars">Include Variables</a></h2>
+
- <h2><a name="includevars">Include Variables</a></h2>
In addition to the variables in the standard CGI environment,
these are available for the <code>echo</code> command, for
<code>if</code> and <code>elif</code>, and to any program
@@ -406,8 +382,8 @@
<dd>The last modification date of the document requested by
the user.</dd>
</dl>
+<h2>Variable Substitution</h2>
- <h2>Variable Substitution</h2>
<p>Variable substitution is done within quoted strings in most
cases where they may reasonably occur as an argument to an SSI
@@ -417,18 +393,19 @@
as the arguments to conditional operators. You can insert a
literal dollar sign into the string using backslash
quoting:</p>
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<!--#if expr="$a = \$test" -->
-</pre>
+</code></td></tr></table></blockquote>
<p>If a variable reference needs to be substituted in the
middle of a character sequence that might otherwise be
considered a valid identifier in its own right, it can be
disambiguated by enclosing the reference in braces,
- <em>à la</em> shell substitution:</p>
-<pre>
+ <em>a la</em> shell substitution:</p>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<!--#set var="Zed" value="${REMOTE_HOST}_${REQUEST_METHOD}" -->
-</pre>
+</code></td></tr></table></blockquote>
<p>This will result in the <samp>Zed</samp> variable being set
to "<samp>X_Y</samp>" if <samp>REMOTE_HOST</samp> is
@@ -438,26 +415,28 @@
<p>EXAMPLE: the below example will print "in foo" if the
DOCUMENT_URI is /foo/file.html, "in bar" if it is
/bar/file.html and "in neither" otherwise:</p>
-<pre>
- <!--#if expr="\"$DOCUMENT_URI\" = \"/foo/file.html\"" -->
- in foo
- <!--#elif expr="\"$DOCUMENT_URI\" = \"/bar/file.html\"" -->
- in bar
- <!--#else -->
- in neither
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <!--#if expr="\"$DOCUMENT_URI\" = \"/foo/file.html\"" --><br>
+ in foo<br>
+ <!--#elif expr="\"$DOCUMENT_URI\" = \"/bar/file.html\"" --><br>
+ in bar<br>
+ <!--#else --><br>
+ in neither<br>
<!--#endif -->
-</pre>
+</code></td></tr></table></blockquote>
+<h2>Flow Control Elements</h2>
+
- <h2><a id="flowctrl" name="flowctrl">Flow Control
- Elements</a></h2>
These are available in Apache 1.2 and above. The basic flow
control elements are:
-<pre>
- <!--#if expr="<em>test_condition</em>" -->
- <!--#elif expr="<em>test_condition</em>" -->
- <!--#else -->
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <!--#if expr="<em>test_condition</em>" --><br>
+ <!--#elif expr="<em>test_condition</em>" --><br>
+ <!--#else --><br>
<!--#endif -->
-</pre>
+</code></td></tr></table></blockquote>
<p>The <strong><code>if</code></strong> element works like an
if statement in a programming language. The test condition is
@@ -482,11 +461,11 @@
<dd>true if <em>string</em> is not empty</dd>
- <dt><em>string1</em> = <em>string2</em><br />
- <em>string1</em> != <em>string2</em><br />
- <em>string1</em> < <em>string2</em><br />
- <em>string1</em> <= <em>string2</em><br />
- <em>string1</em> > <em>string2</em><br />
+ <dt><em>string1</em> = <em>string2</em><br>
+ <em>string1</em> != <em>string2</em><br>
+ <em>string1</em> < <em>string2</em><br>
+ <em>string1</em> <= <em>string2</em><br>
+ <em>string1</em> > <em>string2</em><br>
<em>string1</em> >= <em>string2</em></dt>
<dd>Compare string1 with string 2. If string2 has the form
@@ -517,10 +496,11 @@
<p>"<em>=</em>" and "<em>!=</em>" bind more tightly than
"<em>&&</em>" and "<em>||</em>". "<em>!</em>" binds
most tightly. Thus, the following are equivalent:</p>
-<pre>
- <!--#if expr="$a = test1 && $b = test2" -->
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <!--#if expr="$a = test1 && $b = test2" --><br>
<!--#if expr="($a = test1) && ($b = test2)" -->
-</pre>
+</code></td></tr></table></blockquote>
<p>Anything that's not recognized as a variable or an operator
is treated as a string. Strings can also be quoted:
@@ -528,12 +508,15 @@
(blanks and tabs) because it is used to separate tokens such as
variables. If multiple strings are found in a row, they are
concatenated using blanks. So,</p>
-<pre>
- <em>string1 string2</em> results in <em>string1 string2</em>
- <em>'string1 string2'</em> results in <em>string1 string2</em>
-</pre>
- <h2>Using Server Side Includes for ErrorDocuments</h2>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <pre><em>string1 string2</em> results in <em>string1 string2</em></pre>
+ <pre><em>'string1 string2'</em> results in <em>string1 string2</em></pre>
+</code></td></tr></table></blockquote>
+
+<h2>Using Server Side Includes for ErrorDocuments</h2>
+
+
There is <a href="../misc/custom_errordocs.html">a document</a>
which describes how to use the features of mod_include to offer
internationalized customized server error documents.
@@ -542,85 +525,29 @@
<p>Files processed for server-side includes no longer accept
requests with PATH_INFO (trailing pathname information) by
- default. You can use the <a
- href="core.html#AcceptPathInfo">AcceptPathInfo</a> directive to
+ default. You can use the <a href="code.html#acceptpathinfo" class="directive"><code class="directive">AcceptPathInfo</code></a> directive to
configure the server to accept requests with PATH_INFO.</p>
- <hr />
-
- <h2><a id="ssiendtag"
- name="ssiendtag">SSIEndTag</a> directive</h2>
- <p><a
- href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SSIEndTag <em>tag</em><br
- /> <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>SSIEndTag
- "-->"</code><br /> <a
- href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br /> <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br /> <a
- href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_include<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- Available in version 2.0.30 and later.</p>
-
-
+<hr/><h2><a name="SSIEndTag">SSIEndTag</a> <a name="ssiendtag">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Changes the string that mod_include looks for to end an
+include command.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SSIEndTag <em>tag</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>SSIEndTag "-->"</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_include</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.2 and Available in version 2.0.30 and later.
+</td></tr></table></td></tr></table><usage>
<p>This directive changes the string that mod_include looks for
to mark the end of a include command.</p>
- <p>See also: <a href="#ssistarttag">SSIStartTag</a>.</p>
-
- <hr />
- <h2><a id="ssierrormsg" name="ssierrormsg">SSIErrorMsg</a>
- directive</h2>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SSIErrorMsg
- <em>message</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>SSIErrorMsg
- "[an error occurred while processing this directive]"</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_include<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- Available in version 2.0.30 and later.</p>
-
-
+ <seealso>See also: <code class="directive">SSIStartTag</code>.</seealso>
+</usage><hr/><h2><a name="SSIErrorMsg">SSIErrorMsg</a> <a name="ssierrormsg">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Changes the error message displayed when there is an error</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SSIErrorMsg <em>message</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>SSIErrorMsg
+"[an error occurred while processing this directive]"</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_include</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in version 2.0.30 and later.</td></tr></table></td></tr></table><usage>
<p>The SSIErrorMsg directive changes the error message displayed
when mod_include encounters an error. For production servers you
may consider changing the default error message to
- <code>"<-- Error -->"</code> so that the message
+ <code>"<-- Error -->"</code> so that the message
is not presented to the user.
</p>
<p>This directive has the same effect as the <code><--#config
errmsg=<em>message</em> --></code> element.</p>
- <hr />
- <h2><a id="ssistarttag" name="ssistarttag">SSIStartTag</a>
- directive</h2>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SSIStartTag
- <em>tag</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>SSIStartTag
- "<--!"</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_include<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- Available in version 2.0.30 and later.</p>
+</usage><hr/><h2><a name="SSIStartTag">SSIStartTag</a> <a name="ssistarttag">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Changes the string that mod_include looks for to start an
+include element</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>SSIStartTag "<--!"</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_include</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in version 2.0.30 and later.</td></tr></table></td></tr></table><usage>
<p>This directive changes the string that mod_include looks for
to mark an include element to process.</p>
@@ -629,54 +556,18 @@
output of a file each processing different commands (possibly at
different times).</p>
- <p>See also: <a href="#ssiendtag">SSIEndTag</a>.</p>
-
- <hr />
- <h2><a id="ssitimeformat" name="ssitimeformat">SSITimeFormat</a>
- directive</h2>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SSITimeFormat
- <em>formatstring</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>SSITimeFormat
- "%A, %d-%b-%Y %H:%M:%S %Z"</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_include<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- Available in version 2.0.30 and later.</p>
+ <seealso>See also: <code class="directive">SSIEndTag</code></seealso>
- <p>This directive changes the format in which date strings are displayed
+</usage><hr/><h2><a name="SSITimeFormat">SSITimeFormat</a> <a name="ssitimeformat">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures the format in which date strings are
+displayed</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SSITimeFormat <em>formatstring</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>SSITimeFormat "%A, %d-%b-%Y %H:%M:%S %Z"</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_include</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in version 2.0.30 and later.</td></tr></table></td></tr></table><usage>
+<p>This directive changes the format in which date strings are displayed
when echoing DATE environment variables. The <em>formatstring</em>
is as in strftime(3) from the C standard library.</p>
<p>This directive has the same effect as the <code><--#config
timefmt=<em>formatstring</em> --></code> element.</p>
-
- <hr />
- <h2><a id="xbithack" name="xbithack">XBitHack</a>
- directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> XBitHack
- on|off|full<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>XBitHack
- off</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Options<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_include
-
+</usage><hr/><h2><a name="XBitHack">XBitHack</a> <a name="xbithack">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Parse SSI directives in files with the execute
+bit set</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>XBitHack on|off|full</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>XBitHack off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_include</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td/></tr></table></td></tr></table><usage>
<p>The XBitHack directives controls the parsing of ordinary
html documents. This directive only affects files associated
with the MIME type <code>text/html</code>. XBitHack can take on
@@ -702,15 +593,12 @@
this bit allows clients and proxies to cache the result of
the request.
- <p><strong>Note:</strong> you would not want to use the full
+ <blockquote><table><tr><td bgcolor="#e0e5f5"><strong>Note:</strong> you would not want to use the full
option, unless you assure the group-execute bit is unset for
every SSI script which might <code>#include</code> a CGI
or otherwise produces different output on each hit (or could
- potentially change on subsequent requests).</p>
+ potentially change on subsequent requests).</td></tr></table></blockquote>
</dd>
</dl>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
-
+ </usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.15 +20 -136 httpd-2.0/docs/manual/mod/mod_info.html
Index: mod_info.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_info.html,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -b -u -r1.14 -r1.15
--- mod_info.html 19 Feb 2002 18:37:19 -0000 1.14
+++ mod_info.html 6 Mar 2002 17:08:19 -0000 1.15
@@ -1,93 +1,40 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_info - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_info</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>This module provides a comprehensive overview of the server
+--><title>mod_info - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_info</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides a comprehensive overview of the server
configuration including all installed modules and directives in the
-configuration files.</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>info_module</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
-<compatibility>Available in Apache 1.1 and later</compatibility>
-</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-
-<h2>Using mod_info</h2>
+configuration files.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>info_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.1 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <h2>Using mod_info</h2>
-<p>To configure it, add the following to your
+ <p>To configure it, add the following to your
<code>httpd.conf</code> file.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Location /server-info><br>
SetHandler server-info<br>
</Location><br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
You may wish to add a
- <code class="directive"><a href="core.html#<limit>" class="directive"><Limit></a></code>
+ <a href="core.html#<limit>" class="directive"><code class="directive"><Limit></code></a>
clause inside the
- <code class="directive"><a href="core.html#<location>" class="directive"><location></a></code>
+ <a href="core.html#<location>" class="directive"><code class="directive"><location></code></a>
directive to limit access to your server configuration
information.
<p>Once configured, the server information is obtained by
- accessing <code>http://your.host.dom/server-info</code>
-</p>
-
+ accessing <code>http://your.host.dom/server-info</code></p>
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
+ <blockquote><table><tr><td bgcolor="#e0e5f5">
Note that the configuration files are read by the
module at run-time, and therefore the display may
<em>not</em> reflect the running server's active
configuration if the files have been changed since the server
was last reloaded. Also, the configuration files must be
readable by the user as which the server is running (see the
- <code class="directive"><a href="mpm_common.html#user" class="directive">User</a></code> directive), or
+ <a href="mpm_common.html#user" class="directive"><code class="directive">User</code></a> directive), or
else the directive settings will not be listed.
<p>It should also be noted that if
@@ -96,78 +43,15 @@
files, including <em>per</em>-directory files (<em>e.g.</em>,
<code>.htaccess</code>). This may have security-related
ramifications for your site.</p>
-
-</td>
-</tr>
-</table>
-</blockquote>
-
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#addmoduleinfo">AddModuleInfo</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Allows additional information to be added to the module
-information displayed by the server-info handler</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AddModuleInfo <em>module-name string</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
-host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_info</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.3 and above</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This allows the content of <em>string</em> to be shown as
+ </td></tr></table></blockquote>
+</summary><h2>Directives</h2><ul><li><a href="#addmoduleinfo">AddModuleInfo</a></li></ul><hr/><h2><a name="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Allows additional information to be added to the module
+information displayed by the server-info handler</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AddModuleInfo <em>module-name string</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
+host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_info</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.3 and above</td></tr></table></td></tr></table><usage>
+ <p>This allows the content of <em>string</em> to be shown as
HTML interpreted, <strong>Additional Information</strong> for
the module <em>module-name</em>. Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddModuleInfo mod_auth.c 'See <A HREF="http://www.apache.org/docs/mod/mod_auth.html">http://www.apache.org/docs/mod/mod_auth.html</A>'
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</code></td></tr></table></blockquote>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.57 +175 -213 httpd-2.0/docs/manual/mod/mod_log_config.html
Index: mod_log_config.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_log_config.html,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -d -b -u -r1.56 -r1.57
--- mod_log_config.html 10 Jan 2002 03:23:33 -0000 1.56
+++ mod_log_config.html 6 Mar 2002 17:08:19 -0000 1.57
@@ -1,34 +1,10 @@
-<!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 module mod_log_config</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">Module mod_log_config</h1>
-
- <p>This module provides for logging of the requests made to the
- server, using the Common Log Format or a user-specified
- format.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_log_config.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- log_config_module</p>
-
- <h2>Summary</h2>
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_log_config - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_log_config</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides for logging of the requests
+made to the server, using the Common Log Format or a
+user-specified format.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>log_config_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility></compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This module provides for flexible logging of client
requests. Logs are written in a customizable format, and may be
@@ -45,21 +21,11 @@
directives can be used multiple times in each server to cause
each request to be logged to multiple files.</p>
- <p>See also: <a href="../logs.html">Apache Log Files</a>.</p>
-
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#cookielog">CookieLog</a></li>
-
- <li><a href="#customlog">CustomLog</a></li>
-
- <li><a href="#logformat">LogFormat</a></li>
+<seealso><strong>See also</strong>:
+<a href="../logs.html">Apache Log Files</a>.</seealso>
- <li><a href="#transferlog">TransferLog</a></li>
- </ul>
+<h2><a name="formats">Custom Log Formats</a></h2>
- <h2><a id="formats" name="formats">Custom Log Formats</a></h2>
<p>The format argument to the <code>LogFormat</code> and
<code>CustomLog</code> directives is a string. This string is
@@ -72,47 +38,107 @@
<p>The characteristics of the request itself are logged by
placing "%" directives in the format string, which are replaced
in the log file by the values as follows:</p>
-<pre>
-%...a: Remote IP-address
-%...A: Local IP-address
-%...B: Bytes sent, excluding HTTP headers.
-%...b: Bytes sent, excluding HTTP headers. In CLF format
- i.e. a '-' rather than a 0 when no bytes are sent.
-%...{Foobar}C: The contents of cookie "Foobar" in the request sent to the
- server.
-%...D: The time taken to serve the request, in microseconds.
-%...{FOOBAR}e: The contents of the environment variable FOOBAR
-%...f: Filename
-%...h: Remote host
-%...H The request protocol
-%...{Foobar}i: The contents of Foobar: header line(s) in the request
- sent to the server.
-%...l: Remote logname (from identd, if supplied)
-%...m The request method
-%...{Foobar}n: The contents of note "Foobar" from another module.
-%...{Foobar}o: The contents of Foobar: header line(s) in the reply.
-%...p: The canonical Port of the server serving the request
-%...P: The process ID of the child that serviced the request.
-%...q The query string (prepended with a ? if a query string exists,
- otherwise an empty string)
-%...r: First line of request
-%...s: Status. For requests that got internally redirected, this is
- the status of the *original* request --- %...>s for the last.
-%...t: Time, in common log format time format (standard english format)
-%...{format}t: The time, in the form given by format, which should
- be in strftime(3) format. (potentially localized)
-%...T: The time taken to serve the request, in seconds.
-%...u: Remote user (from auth; may be bogus if return status (%s) is 401)
-%...U: The URL path requested, not including any query string.
-%...v: The canonical ServerName of the server serving the request.
-%...V: The server name according to the UseCanonicalName setting.
-%...X: Connection status when response is completed.
- 'X' = connection aborted before the response completed.
- '+' = connection may be kept alive after the response is sent.
- '-' = connection will be closed after the response is sent.
- (This directive was %...c in late versions of Apache 1.3, but
- this conflicted with the historical ssl %...{var}c syntax.)
-</pre>
+
+<table>
+
+<tr><td>%...a:</td>
+<td>Remote IP-address</td></tr>
+
+<tr><td>%...A:</td>
+<td>Local IP-address</td></tr>
+
+<tr><td>%...B:</td>
+<td>Bytes sent, excluding HTTP headers.</td></tr>
+
+<tr><td>%...b:</td>
+<td>Bytes sent, excluding HTTP headers. In CLF format
+i.e. a '-' rather than a 0 when no bytes are sent.</td></tr>
+
+<tr><td>%...{Foobar}C:</td>
+<td>The contents of cookie "Foobar" in the request sent to the server.</td></tr>
+
+<tr><td>%...D:</td>
+<td>The time taken to serve the request, in microseconds.</td></tr>
+
+<tr><td>%...{FOOBAR}e:</td>
+<td>The contents of the environment variable FOOBAR</td></tr>
+
+<tr><td>%...f:</td>
+<td>Filename</td></tr>
+
+<tr><td>%...h:</td>
+<td>Remote host</td></tr>
+
+<tr><td>%...H</td>
+<td>The request protocol</td></tr>
+
+<tr><td>%...{Foobar}i:</td>
+<td>The contents of Foobar: header line(s) in the request
+sent to the server.</td></tr>
+
+<tr><td>%...l:</td>
+<td>Remote logname (from identd, if supplied)</td></tr>
+
+<tr><td>%...m:</td>
+<td>The request method</td></tr>
+
+<tr><td>%...{Foobar}n:</td>
+<td>The contents of note "Foobar" from another module.</td></tr>
+
+<tr><td>%...{Foobar}o:</td>
+<td>The contents of Foobar: header line(s) in the reply.</td></tr>
+
+<tr><td>%...p:</td>
+<td>The canonical Port of the server serving the request</td></tr>
+
+<tr><td>%...P:</td>
+<td>The process ID of the child that serviced the request.</td></tr>
+
+<tr><td>%...q:</td>
+<td>The query string (prepended with a ? if a query string exists,
+otherwise an empty string)</td></tr>
+
+<tr><td>%...r:</td>
+<td>First line of request</td></tr>
+
+<tr><td>%...s:</td>
+<td>Status. For requests that got internally redirected, this is
+the status of the *original* request --- %...>s for the last.</td></tr>
+
+<tr><td>%...t:</td>
+<td>Time, in common log format time format (standard english format)</td></tr>
+
+<tr><td>%...{format}t:</td>
+<td>The time, in the form given by format, which should
+be in strftime(3) format. (potentially localized)</td></tr>
+
+<tr><td>%...T:</td>
+<td>The time taken to serve the request, in seconds.</td></tr>
+
+<tr><td>%...u:</td>
+<td>Remote user (from auth; may be bogus if return status (%s) is 401)</td></tr>
+
+<tr><td>%...U:</td>
+<td>The URL path requested, not including any query string.</td></tr>
+
+<tr><td>%...v:</td>
+<td>The canonical ServerName of the server serving the request.</td></tr>
+
+<tr><td>%...V:</td>
+<td>The server name according to the UseCanonicalName setting.</td></tr>
+
+<tr><td>%...X:</td>
+<td>Connection status when response is completed.
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+'X' = connection aborted before the response completed.<br>
+'+' = connection may be kept alive after the response is sent.<br>
+'-' = connection will be closed after the response is sent.
+</code></td></tr></table></blockquote>
+<blockquote><table><tr><td bgcolor="#e0e5f5">(This directive was %...c in late versions of Apache 1.3, but
+this conflicted with the historical ssl %...{var}c syntax.)</td></tr></table></blockquote>
+</td></tr>
+
+</table>
<p>The "..." can be nothing at all (<em>e.g.</em>, <code>"%h %u
%r %s %b"</code>), or it can indicate conditions for inclusion
@@ -155,72 +181,42 @@
<dd><code>"%{User-agent}i"</code></dd>
</dl>
- <p>Note that the canonical <a
- href="core.html#servername">ServerName</a> and <a
- href="mpm_common.html#listen">Listen</a> of the server serving the
+ <p>Note that the canonical <a href="core.html#servername">ServerName</a> and <a href="mpm_common.html#listen">Listen</a> of the server serving the
request are used for <code>%v</code> and <code>%p</code>
- respectively. This happens regardless of the <a
- href="core.html#usecanonicalname">UseCanonicalName</a> setting
+ respectively. This happens regardless of the <a href="core.html#usecanonicalname">UseCanonicalName</a> setting
because otherwise log analysis programs would have to duplicate
the entire vhost matching algorithm in order to decide what
host really served the request.</p>
+
<h2>Security Considerations</h2>
- <p>See the <a
- href="../misc/security_tips.html#serverroot">security tips</a>
+
+
+ <p>See the <a href="../misc/security_tips.html#serverroot">security tips</a>
document for details on why your security could be compromised
if the directory where logfiles are stored is writable by
anyone other than the user that starts the server.</p>
- <hr />
-
- <h2><a id="cookielog" name="cookielog">CookieLog</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt CookieLog} directive> -->
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> CookieLog
- <em>filename</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_cookies<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Only available
- in Apache 1.2 and above</p>
- <p>The CookieLog directive sets the filename for logging of
- cookies. The filename is relative to the <a
- href="core.html#serverroot">ServerRoot</a>. This directive is
- included only for compatibility with mod_cookies, and is
- deprecated.</p>
- <hr />
- <h2><a id="customlog" name="customlog">CustomLog</a> <a
- id="customlogconditional"
- name="customlogconditional">directive</a></h2>
+</summary><h2>Directives</h2><ul><li><a href="#cookielog">CookieLog</a></li><li><a href="#customlog">CustomLog</a></li><li><a href="#logformat">LogFormat</a></li><li><a href="#transferlog">TransferLog</a></li></ul><hr/><h2><a name="CookieLog">CookieLog</a> <a name="cookielog">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets filename for the logging of cookies</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CookieLog <em>filename</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
+host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_log_config</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Only available in Apache 1.2 and above</td></tr></table></td></tr></table><usage>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> CustomLog
+ <p>The <code class="directive">CookieLog</code> directive sets the
+ filename for logging of cookies. The filename is relative to the
+ <a href="core.html#serverroot" class="directive"><code class="directive">serverroot</code></a>. This directive is
+ included only for compatibility with <code><a href="mod_cookies.html">mod_cookies</a></code>,
+ and is deprecated.</p>
+</usage><hr/><h2><a name="CustomLog">CustomLog</a> <a name="customlog">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets filename and format of log file</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CustomLog
<em>file</em>|<em>pipe</em> <em>format</em>|<em>nickname</em>
- [env=[!]<em>environment-variable</em>]<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Nickname only
- available in Apache 1.3 or later. Conditional logging available
- in 1.3.5 or later.<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_log_config</p>
-
- <p>The <code>CustomLog</code> directive is used to log requests
- to the server. A log format is specified, and the logging can
- optionally be made conditional on request characteristics using
- environment variables.</p>
+ [env=[!]<em>environment-variable</em>]</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
+host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_log_config</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Nickname only available in Apache 1.3 or later.
+Conditional logging available in 1.3.5 or later.</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">CustomLog</code> directive is used to
+ log requests to the server. A log format is specified, and the
+ logging can optionally be made conditional on request
+ characteristics using environment variables.</p>
<p>The first argument, which specifies the location to which
the logs will be written, can take on one of the following two
@@ -229,8 +225,7 @@
<dl>
<dt><em>file</em></dt>
- <dd>A filename, relative to the <a
- href="core.html#serverroot">ServerRoot</a>.</dd>
+ <dd>A filename, relative to the <a href="core.html#serverroot">ServerRoot</a>.</dd>
<dt><em>pipe</em></dt>
@@ -250,14 +245,15 @@
<p>For example, the following two sets of directives have
exactly the same effect:</p>
-<pre>
- # CustomLog with format nickname
- LogFormat "%h %l %u %t \"%r\" %>s %b" common
- CustomLog logs/access_log common
- # CustomLog with explicit format string
- CustomLog logs/access_log "%h %l %u %t \"%r\" %>s %b"
-</pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ # CustomLog with format nickname<br>
+ LogFormat "%h %l %u %t \"%r\" %>s %b" common<br>
+ CustomLog logs/access_log common<br>
+<br>
+ # CustomLog with explicit format string<br>
+ CustomLog logs/access_log "%h %l %u %t \"%r\" %>s %b"<br>
+</code></td></tr></table></blockquote>
<p>The third argument is optional and allows the decision on
whether or not to log a particular request to be based on the
@@ -268,98 +264,64 @@
request will be logged.</p>
<p>Environment variables can be set on a <em>per</em>-request
- basis using the <a href="mod_setenvif.html">mod_setenvif</a>
- and/or <a href="mod_rewrite.html">mod_rewrite</a> modules. For
+ basis using the <code><a href="mod_setenvif.html">mod_setenvif</a></code>
+ and/or <code><a href="mod_rewrite.html">mod_rewrite</a></code> modules. For
example, if you don't want to record requests for all GIF
images on your server in a separate logfile but not your main
log, you can use:</p>
-<pre>
- SetEnvIf Request_URI \.gif$ gif-image
- CustomLog gif-requests.log common env=gif-image
- CustomLog nongif-requests.log common env=!gif-image
-</pre>
- <hr />
-
- <h2><a id="logformat" name="logformat">LogFormat</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt LogFormat} directive> -->
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LogFormat
- <em>format</em>|<em>nickname</em> [<em>nickname</em>]<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>LogFormat "%h %l
- %u %t \"%r\" %>s %b"</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Nickname only
- available in Apache 1.3 or later<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_log_config</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ SetEnvIf Request_URI \.gif$ gif-image<br>
+ CustomLog gif-requests.log common env=gif-image<br>
+ CustomLog nongif-requests.log common env=!gif-image
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="LogFormat">LogFormat</a> <a name="logformat">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Describes a format for use in a log file</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LogFormat
+ <em>format</em>|<em>nickname</em> [<em>nickname</em>]</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
+host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_log_config</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Nickname only available in Apache 1.3 or later.
+</td></tr></table></td></tr></table><usage>
<p>This directive specifies the format of the access log
file.</p>
- <p>The <code>LogFormat</code> directive can take one of two
+ <p>The <code class="directive">LogFormat</code> directive can take one of two
forms. In the first form, where only one argument is specified,
this directive sets the log format which will be used by logs
- specified in subsequent <a href="#transferlog">TransferLog</a>
+ specified in subsequent <code class="directive">TransferLog</code>
directives. The single argument can specify an explicit
<em>format</em> as discussed in <a href="#formats">custom log
formats</a> section above. Alternatively, it can use a
<em>nickname</em> to refer to a log format defined in a
- previous <code>LogFormat</code> directive as described
+ previous <code class="directive">LogFormat</code> directive as described
below.</p>
- <p>The second form of the <code>LogFormat</code> directive
- associates an explicit <em>format</em> with a
+ <p>The second form of the <code class="directive">LogFormat</code>
+ directive associates an explicit <em>format</em> with a
<em>nickname</em>. This <em>nickname</em> can then be used in
- subsequent <code>LogFormat</code> or <a
- href="#customlog">CustomLog</a> directives rather than
- repeating the entire format string. A <samp>LogFormat</samp>
+ subsequent <code class="directive">LogFormat</code> or
+ <code class="directive">CustomLog</code> directives rather than
+ repeating the entire format string. A
+ <code class="directive">LogFormat</code>
directive which defines a nickname <strong>does nothing
else</strong> -- that is, it <em>only</em> defines the
nickname, it doesn't actually apply the format and make it the
- default. Therefore, it will not affect subsequent <a
- href="#transferlog">TransferLog</a> directives.</p>
- <hr />
-
- <h2><a id="transferlog" name="transferlog">TransferLog</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt TransferLog} directive> -->
+ default. Therefore, it will not affect subsequent
+ <code class="directive">TransferLog</code> directives.</p>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> TransferLog
- <em>file</em>|<em>pipe</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> none<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_log_config</p>
+</usage><hr/><h2><a name="TransferLog">TransferLog</a> <a name="transferlog">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Specifly location of a log file</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>TransferLog <em>file</em>|<em>pipe</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
+host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_log_config</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td/></tr></table></td></tr></table><usage>
<p>This directive has exactly the same arguments and effect as
- the <a href="#customlog">CustomLog</a> directive, with the
+ the <code class="directive">CustomLog</code> directive, with the
exception that it does not allow the log format to be specified
explicitly or for conditional logging of requests. Instead, the
log format is determined by the most recently specified
- specified <a href="#logformat">LogFormat</a> directive (which
+ specified <code class="directive">LogFormat</code> directive (which
does not define a nickname). Common Log Format is used if no
other format has been specified.</p>
<p>Example:</p>
-<pre>
- LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""<br>
TransferLog logs/access_log
-</pre>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
+</code></td></tr></table></blockquote>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.63 +393 -1425 httpd-2.0/docs/manual/mod/mod_rewrite.html
Index: mod_rewrite.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_rewrite.html,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -d -b -u -r1.62 -r1.63
--- mod_rewrite.html 19 Feb 2002 18:37:19 -0000 1.62
+++ mod_rewrite.html 6 Mar 2002 17:08:19 -0000 1.63
@@ -1,86 +1,38 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_rewrite - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_rewrite</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Provides a rule-based rewriting engine to rewrite requested
-URLs on the fly</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>rewrite_module</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
-<compatibility>Available in Apache 1.3 and later</compatibility>
-</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<blockquote>
-
-<em>``The great thing about mod_rewrite is it gives you
+--><title>mod_rewrite - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_rewrite</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Provides a rule-based rewriting engine to rewrite requested
+URLs on the fly</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>rewrite_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <blockquote>
+ <em>``The great thing about mod_rewrite is it gives you
all the configurability and flexibility of Sendmail.
The downside to mod_rewrite is that it gives you all
the configurability and flexibility of Sendmail.''</em>
-
-<div align="RIGHT">
+ <div align="RIGHT">
-- Brian Behlendorf<br>
Apache Group
</div>
+ </blockquote>
-</blockquote>
-
-
-<blockquote>
-
-<em>`` Despite the tons of examples and docs,
+ <blockquote>
+ <em>`` Despite the tons of examples and docs,
mod_rewrite is voodoo. Damned cool voodoo, but still
voodoo. ''</em>
-
-<div align="RIGHT">
+ <div align="RIGHT">
-- Brian Moore<br>
bem@news.cmc.net
</div>
-
-</blockquote>
-
+ </blockquote>
-<p>Welcome to mod_rewrite, the Swiss Army Knife of URL
+ <p>Welcome to mod_rewrite, the Swiss Army Knife of URL
manipulation!</p>
-
-<p>This module uses a rule-based rewriting engine (based on a
+ <p>This module uses a rule-based rewriting engine (based on a
regular-expression parser) to rewrite requested URLs on the
fly. It supports an unlimited number of rules and an
unlimited number of attached rule conditions for each rule to
@@ -91,8 +43,7 @@
various formats can be used to achieve a really granular URL
matching.</p>
-
-<p>This module operates on the full URLs (including the
+ <p>This module operates on the full URLs (including the
path-info part) both in per-server context
(<code>httpd.conf</code>) and per-directory context
(<code>.htaccess</code>) and can even generate query-string
@@ -100,78 +51,30 @@
sub-processing, external request redirection or even to an
internal proxy throughput.</p>
-
-<p>But all this functionality and flexibility has its
+ <p>But all this functionality and flexibility has its
drawback: complexity. So don't expect to understand this
entire module in just one day.</p>
-
-<p>This module was invented and originally written in April
+ <p>This module was invented and originally written in April
1996 and gifted exclusively to the The Apache Group in July 1997
by</p>
+ <blockquote>
+ <a href="http://www.engelschall.com/"><code>Ralf S.
+ Engelschall</code></a><br>
+ <a href="mailto:rse@engelschall.com"><code>rse@engelschall.com</code></a><br>
+ <a href="http://www.engelschall.com/"><code>www.engelschall.com</code></a>
+ </blockquote>
+</summary><h2>Directives</h2><ul><li><a href="#rewritebase">RewriteBase</a></li><li><a href="#rewritecond">RewriteCond</a></li><li><a href="#rewriteengine">RewriteEngine</a></li><li><a href="#rewritelock">RewriteLock</a></li><li><a href="#rewritelog">RewriteLog</a></li><li><a href="#rewriteloglevel">RewriteLogLevel</a></li><li><a href="#rewritemap">RewriteMap</a></li><li><a href="#rewriteoptions">RewriteOptions</a></li><li><a href="#rewriterule">RewriteRule</a></li></ul><h2><a name="Internal">Interal Processing</a></h2>
-<blockquote>
-
-<a href="http://www.engelschall.com/"><code>Ralf S.
- Engelschall</code></a>
-<br>
-
-<a href="mailto:rse@engelschall.com"><code>rse@engelschall.com</code></a>
-<br>
-
-<a href="http://www.engelschall.com/"><code>www.engelschall.com</code></a>
-
-</blockquote>
-
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#rewriteengine">RewriteEngine</a>
-</li>
-<li>
-<a href="#rewriteoptions">RewriteOptions</a>
-</li>
-<li>
-<a href="#rewritelog">RewriteLog</a>
-</li>
-<li>
-<a href="#rewriteloglevel">RewriteLogLevel</a>
-</li>
-<li>
-<a href="#rewritelock">RewriteLock</a>
-</li>
-<li>
-<a href="#rewritemap">RewriteMap</a>
-</li>
-<li>
-<a href="#rewritebase">RewriteBase</a>
-</li>
-<li>
-<a href="#rewritecond">RewriteCond</a>
-</li>
-<li>
-<a href="#rewriterule">RewriteRule</a>
-</li>
-</ul>
-<h2>
-<a name="Internal">Interal Processing</a>
-</h2>
-
-
-<p>The internal processing of this module is very complex but
+ <p>The internal processing of this module is very complex but
needs to be explained once even to the average user to avoid
common mistakes and to let you exploit its full
functionality.</p>
+<h3><a name="InternalAPI">API Phases</a></h3>
-<h3>
-<a name="InternalAPI">API Phases</a>
-</h3>
-
-
-<p>First you have to understand that when Apache processes a
+ <p>First you have to understand that when Apache processes a
HTTP request it does this in phases. A hook for each of these
phases is provided by the Apache API. Mod_rewrite uses two of
these hooks: the URL-to-filename translation hook which is
@@ -181,8 +84,7 @@
config files (<code>.htaccess</code>) have been read, but
before the content handler is activated.</p>
-
-<p>So, after a request comes in and Apache has determined the
+ <p>So, after a request comes in and Apache has determined the
corresponding server (or virtual server) the rewriting engine
starts processing of all mod_rewrite directives from the
per-server configuration in the URL-to-filename phase. A few
@@ -196,10 +98,8 @@
mod_rewrite can operate. To make this point more clear
remember the following two points:</p>
-
-<ol>
-
-<li>Although mod_rewrite rewrites URLs to URLs, URLs to
+ <ol>
+ <li>Although mod_rewrite rewrites URLs to URLs, URLs to
filenames and even filenames to filenames, the API
currently provides only a URL-to-filename hook. In Apache
2.0 the two missing hooks will be added to make the
@@ -208,8 +108,7 @@
Apache does more in the URL-to-filename hook than the API
intends for it.</li>
-
-<li>
+ <li>
Unbelievably mod_rewrite provides URL manipulations in
per-directory context, <em>i.e.</em>, within
<code>.htaccess</code> files, although these are reached
@@ -236,22 +135,15 @@
egg problem. But on the other hand this is the only way
mod_rewrite can provide (locally restricted) URL
manipulations to the average user.</p>
+ </li>
+ </ol>
-</li>
-
-</ol>
-
-
-<p>Don't forget these two points!</p>
-
-
+ <p>Don't forget these two points!</p>
-<h3>
-<a name="InternalRuleset">Ruleset Processing</a>
-</h3>
+<h3><a name="InternalRuleset">Ruleset Processing</a></h3>
-<p>Now when mod_rewrite is triggered in these two API phases, it
+ <p>Now when mod_rewrite is triggered in these two API phases, it
reads the configured rulesets from its configuration
structure (which itself was either created on startup for
per-server context or during the directory walk of the Apache
@@ -262,42 +154,30 @@
configuration contexts. Only the final result processing is
different. </p>
-
-<p>The order of rules in the ruleset is important because the
+ <p>The order of rules in the ruleset is important because the
rewriting engine processes them in a special (and not very
obvious) order. The rule is this: The rewriting engine loops
- through the ruleset rule by rule (<code class="directive"><a href="#rewriterule" class="directive">RewriteRule</a></code> directives) and
+ through the ruleset rule by rule (<a href="#rewriterule" class="directive"><code class="directive">RewriteRule</code></a> directives) and
when a particular rule matches it optionally loops through
existing corresponding conditions (<code>RewriteCond</code>
directives). For historical reasons the conditions are given
first, and so the control flow is a little bit long-winded. See
Figure 1 for more details.</p>
+ <div align="CENTER">
+ <table cellspacing="0" cellpadding="2" border="0">
+ <tr>
+ <td bgcolor="#CCCCCC"><img src="../images/mod_rewrite_fig1.gif" width="428" height="385" alt="[Needs graphics capability to display]"></td>
+ </tr>
-<div align="CENTER">
-
-<table cellspacing="0" cellpadding="2" border="0">
-
-<tr>
-
-<td bgcolor="#CCCCCC"><img src="../images/mod_rewrite_fig1.gif" width="428" height="385" alt="[Needs graphics capability to display]"></td>
-
-</tr>
-
-
-<tr>
-
-<td align="CENTER"><strong>Figure 1:</strong> The
+ <tr>
+ <td align="CENTER"><strong>Figure 1:</strong> The
control flow through the rewriting ruleset</td>
+ </tr>
+ </table>
+ </div>
-</tr>
-
-</table>
-
-</div>
-
-
-<p>As you can see, first the URL is matched against the
+ <p>As you can see, first the URL is matched against the
<em>Pattern</em> of each rule. When it fails mod_rewrite
immediately stops processing this rule and continues with the
next rule. If the <em>Pattern</em> matches, mod_rewrite looks
@@ -320,13 +200,9 @@
+<h3><a name="quoting">Quoting Special Characters</a></h3>
-<h3>
-<a name="quoting">Quoting Special Characters</a>
-</h3>
-
-
-<p>As of Apache 1.3.20, special characters in
+ <p>As of Apache 1.3.20, special characters in
<i>TestString</i> and <i>Substitution</i> strings can be
escaped (that is, treated as normal characters without their
usual special meaning) by prefixing them with a slosh ('\')
@@ -336,13 +212,9 @@
to treat it as a backreference.</p>
+<h3><a name="InternalBackRefs">Regex Back-Reference Availability</a></h3>
-<h3>
-<a name="InternalBackRefs">Regex Back-Reference Availability</a>
-</h3>
-
-
-<p>One important thing here has to be remembered: Whenever you
+ <p>One important thing here has to be remembered: Whenever you
use parentheses in <em>Pattern</em> or in one of the
<em>CondPattern</em>, back-references are internally created
which can be used with the strings <code>$N</code> and
@@ -351,43 +223,28 @@
Figure 2 shows to which locations the back-references are
transfered for expansion.</p>
+ <div align="CENTER">
+ <table cellspacing="0" cellpadding="2" border="0">
+ <tr>
+ <td bgcolor="#CCCCCC"><img src="../images/mod_rewrite_fig2.gif" width="381" height="179" alt="[Needs graphics capability to display]"></td>
+ </tr>
-<div align="CENTER">
-
-<table cellspacing="0" cellpadding="2" border="0">
-
-<tr>
-
-<td bgcolor="#CCCCCC"><img src="../images/mod_rewrite_fig2.gif" width="381" height="179" alt="[Needs graphics capability to display]"></td>
-
-</tr>
-
-
-<tr>
-
-<td align="CENTER"><strong>Figure 2:</strong> The
+ <tr>
+ <td align="CENTER"><strong>Figure 2:</strong> The
back-reference flow through a rule</td>
+ </tr>
+ </table>
+ </div>
-</tr>
-
-</table>
-
-</div>
-
-
-<p>We know this was a crash course on mod_rewrite's internal
+ <p>We know this was a crash course on mod_rewrite's internal
processing. But you will benefit from this knowledge when
reading the following documentation of the available
directives.</p>
+<h2><a name="EnvVar">Environment Variables</a></h2>
-<h2>
-<a name="EnvVar">Environment Variables</a>
-</h2>
-
-
-<p>This module keeps track of two additional (non-standard)
+ <p>This module keeps track of two additional (non-standard)
CGI/SSI environment variables named <code>SCRIPT_URL</code>
and <code>SCRIPT_URI</code>. These contain the
<em>logical</em> Web-view to the current resource, while the
@@ -395,89 +252,34 @@
<code>SCRIPT_FILENAME</code> contain the <em>physical</em>
System-view. </p>
-
-<p>Notice: These variables hold the URI/URL <em>as they were
+ <p>Notice: These variables hold the URI/URL <em>as they were
initially requested</em>, <em>i.e.</em>, <em>before</em> any
rewriting. This is important because the rewriting process is
primarily used to rewrite logical URLs to physical
pathnames.</p>
+ <p><strong>Example:</strong></p>
-<p>
-<strong>Example:</strong>
-</p>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
SCRIPT_NAME=/sw/lib/w3s/tree/global/u/rse/.www/index.html
SCRIPT_FILENAME=/u/rse/.www/index.html
SCRIPT_URL=/u/rse/
SCRIPT_URI=http://en1.engelschall.com/u/rse/
</pre>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<h2>
-<a name="Solutions">Practical Solutions</a>
-</h2>
-
+<h2><a name="Solutions">Practical Solutions</a></h2>
-<p>We also have an <a href="../misc/rewriteguide.html">URL
+ <p>We also have an <a href="../misc/rewriteguide.html">URL
Rewriting Guide</a> available, which provides a collection of
practical solutions for URL-based problems. There you can
find real-life rulesets and additional information about
mod_rewrite.</p>
-
-<hr>
-<h2>
-<a name="RewriteBase">RewriteBase</a> <a name="rewritebase">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the base URL for per-directory rewrites</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RewriteBase <em>URL-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>RewriteBase physical-directory-path</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">RewriteBase</code> directive explicitly
+<hr/><h2><a name="RewriteBase">RewriteBase</a> <a name="rewritebase">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the base URL for per-directory rewrites</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RewriteBase <em>URL-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>RewriteBase physical-directory-path</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">RewriteBase</code> directive explicitly
sets the base URL for per-directory rewrites. As you will see
- below, <code class="directive"><a href="#rewriterule" class="directive">RewriteRule</a></code>
+ below, <a href="#rewriterule" class="directive"><code class="directive">RewriteRule</code></a>
can be used in per-directory config files
(<code>.htaccess</code>). There it will act locally,
<em>i.e.</em>, the local directory prefix is stripped at this
@@ -485,8 +287,7 @@
remainder. At the end it is automatically added back to the
path.</p>
-
-<p>When a substitution occurs for a new URL, this module has
+ <p>When a substitution occurs for a new URL, this module has
to re-inject the URL into the server processing. To be able
to do this it needs to know what the corresponding URL-prefix
or URL-base is. By default this prefix is the corresponding
@@ -496,28 +297,15 @@
use the <code>RewriteBase</code> directive to specify the
correct URL-prefix.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5"> If your webserver's URLs are <strong>not</strong> directly
+<blockquote><table><tr><td bgcolor="#e0e5f5"> If your webserver's URLs are <strong>not</strong> directly
related to physical file paths, you have to use
<code class="directive">RewriteBase</code> in every <code>.htaccess</code>
-files where you want to use <code class="directive"><a href="#rewriterule" class="directive">RewriteRule</a></code> directives.
-</td>
-</tr>
-</table>
-</blockquote>
-
-
-<p> For example, assume the following per-directory config file:</p>
-
+files where you want to use <a href="#rewriterule" class="directive"><code class="directive">RewriteRule</code></a> directives.
+</td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+ <p> For example, assume the following per-directory config file:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
#
# /abc/def/.htaccess -- per-dir config file for directory /abc/def
@@ -534,31 +322,16 @@
# now the rewriting rules
RewriteRule ^oldstuff\.html$ newstuff.html
</pre>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>In the above example, a request to
+ <p>In the above example, a request to
<code>/xyz/oldstuff.html</code> gets correctly rewritten to
the physical file <code>/abc/def/newstuff.html</code>.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>For Apache Hackers</strong>
-</p>
-
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>For Apache Hackers</strong></p>
<p>The following list gives detailed information about
the internal processing steps:</p>
-
<pre>
-
<font size="-1">Request:
/xyz/oldstuff.html
@@ -571,11 +344,8 @@
Result:
/abc/def/newstuff.html
</font>
-
</pre>
-
-<p>
-<font size="-1">This seems very complicated but is
+ <p><font size="-1">This seems very complicated but is
the correct Apache internal processing, because the
per-directory rewriting comes too late in the
process. So, when it occurs the (rewritten) request
@@ -585,81 +355,30 @@
internally to the Apache server and the same
procedure is used by many other operations inside
Apache. So, you can be sure the design and
- implementation is correct.</font>
-</p>
-
-</td>
-</tr>
-</table>
-</blockquote>
-
-
-</usage>
-<hr>
-<h2>
-<a name="RewriteCond">RewriteCond</a> <a name="rewritecond">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Defines a condition under which rewriting will take place
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax> RewriteCond
- <em>TestString</em> <em>CondPattern</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
+ implementation is correct.</font></p>
+</td></tr></table></blockquote>
-<p>The <code class="directive">RewriteCond</code> directive defines a
- rule condition. Precede a <code class="directive"><a href="#rewriterule" class="directive">RewriteRule</a></code> directive with one
+</usage><hr/><h2><a name="RewriteCond">RewriteCond</a> <a name="rewritecond">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Defines a condition under which rewriting will take place
+</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax> RewriteCond
+ <em>TestString</em> <em>CondPattern</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">RewriteCond</code> directive defines a
+ rule condition. Precede a <a href="#rewriterule" class="directive"><code class="directive">RewriteRule</code></a> directive with one
or more <code class="directive">RewriteCond</code> directives. The following
rewriting rule is only used if its pattern matches the current
state of the URI <strong>and</strong> if these additional
conditions apply too.</p>
-
-<p>
-<em>TestString</em> is a string which can contains the
+ <p><em>TestString</em> is a string which can contains the
following expanded constructs in addition to plain text:</p>
-
-<ul>
-
-<li>
-
-<strong>RewriteRule backreferences</strong>: These are
+ <ul>
+ <li>
+ <strong>RewriteRule backreferences</strong>: These are
backreferences of the form
<blockquote>
-
-<strong><code>$N</code></strong>
-
-</blockquote>
+ <strong><code>$N</code></strong>
+ </blockquote>
(0 <= N <= 9) which provide access to the grouped
parts (parenthesis!) of the pattern from the
corresponding <code>RewriteRule</code> directive (the one
@@ -667,81 +386,60 @@
directives).
</li>
-
-<li>
-
-<strong>RewriteCond backreferences</strong>: These are
+ <li>
+ <strong>RewriteCond backreferences</strong>: These are
backreferences of the form
<blockquote>
-
-<strong><code>%N</code></strong>
-
-</blockquote>
+ <strong><code>%N</code></strong>
+ </blockquote>
(1 <= N <= 9) which provide access to the grouped
parts (parentheses!) of the pattern from the last matched
<code>RewriteCond</code> directive in the current bunch
of conditions.
</li>
-
-<li>
-
-<strong>RewriteMap expansions</strong>: These are
+ <li>
+ <strong>RewriteMap expansions</strong>: These are
expansions of the form
<blockquote>
-
-<strong><code>${mapname:key|default}</code></strong>
-
-</blockquote>
+ <strong><code>${mapname:key|default}</code></strong>
+ </blockquote>
See <a href="#mapfunc">the documentation for
RewriteMap</a> for more details.
</li>
-
-<li>
-
-<strong>Server-Variables</strong>: These are variables of
+ <li>
+ <strong>Server-Variables</strong>: These are variables of
the form
<blockquote>
-
-<strong><code>%{</code> <em>NAME_OF_VARIABLE</em>
+ <strong><code>%{</code> <em>NAME_OF_VARIABLE</em>
<code>}</code></strong>
-
-</blockquote>
+ </blockquote>
where <em>NAME_OF_VARIABLE</em> can be a string taken
from the following list:
<table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
-
-<tr>
-
-<td valign="TOP">
+ <tr>
+ <td valign="TOP">
<strong>HTTP headers:</strong>
-
-<p>
-<font size="-1">HTTP_USER_AGENT<br>
+ <p><font size="-1">HTTP_USER_AGENT<br>
HTTP_REFERER<br>
HTTP_COOKIE<br>
HTTP_FORWARDED<br>
HTTP_HOST<br>
HTTP_PROXY_CONNECTION<br>
HTTP_ACCEPT<br>
-
-</font>
-</p>
-
-</td>
+ </font></p>
+ </td>
<td valign="TOP">
<strong>connection & request:</strong>
-
-<p>
-<font size="-1">REMOTE_ADDR<br>
+ <p><font size="-1">REMOTE_ADDR<br>
REMOTE_HOST<br>
REMOTE_USER<br>
REMOTE_IDENT<br>
@@ -750,41 +448,28 @@
PATH_INFO<br>
QUERY_STRING<br>
AUTH_TYPE<br>
+ </font></p>
+ </td>
+ </tr>
-</font>
-</p>
-
-</td>
-
-</tr>
-
-
-<tr>
-
-<td valign="TOP">
+ <tr>
+ <td valign="TOP">
<strong>server internals:</strong>
-
-<p>
-<font size="-1">DOCUMENT_ROOT<br>
+ <p><font size="-1">DOCUMENT_ROOT<br>
SERVER_ADMIN<br>
SERVER_NAME<br>
SERVER_ADDR<br>
SERVER_PORT<br>
SERVER_PROTOCOL<br>
SERVER_SOFTWARE<br>
-
-</font>
-</p>
-
-</td>
+ </font></p>
+ </td>
<td valign="TOP">
<strong>system stuff:</strong>
-
-<p>
-<font size="-1">TIME_YEAR<br>
+ <p><font size="-1">TIME_YEAR<br>
TIME_MON<br>
TIME_DAY<br>
TIME_HOUR<br>
@@ -792,39 +477,24 @@
TIME_SEC<br>
TIME_WDAY<br>
TIME<br>
-
-</font>
-</p>
-
-</td>
+ </font></p>
+ </td>
<td valign="TOP">
<strong>specials:</strong>
-
-<p>
-<font size="-1">API_VERSION<br>
+ <p><font size="-1">API_VERSION<br>
THE_REQUEST<br>
REQUEST_URI<br>
REQUEST_FILENAME<br>
IS_SUBREQ<br>
+ </font></p>
+ </td>
+ </tr>
+ </table>
-</font>
-</p>
-
-</td>
-
-</tr>
-
-</table>
-
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-
-<p>These variables all
+<blockquote><table><tr><td bgcolor="#e0e5f5">
+ <p>These variables all
correspond to the similarly named HTTP
MIME-headers, C variables of the Apache server or
<code>struct tm</code> fields of the Unix system.
@@ -832,27 +502,18 @@
the CGI specification. Those that are special to
mod_rewrite include:</p>
+ <dl>
+ <dt><code>IS_SUBREQ</code></dt>
-<dl>
-
-<dt>
-<code>IS_SUBREQ</code>
-</dt>
-
-
-<dd>Will contain the text "true" if the request
+ <dd>Will contain the text "true" if the request
currently being processed is a sub-request,
"false" otherwise. Sub-requests may be generated
by modules that need to resolve additional files
or URIs in order to complete their tasks.</dd>
+ <dt><code>API_VERSION</code></dt>
-<dt>
-<code>API_VERSION</code>
-</dt>
-
-
-<dd>This is the version of the Apache module API
+ <dd>This is the version of the Apache module API
(the internal interface between server and
module) in the current httpd build, as defined in
include/ap_mmn.h. The module API version
@@ -861,55 +522,33 @@
instance, it is 19990320:10), but is mainly of
interest to module authors.</dd>
+ <dt><code>THE_REQUEST</code></dt>
-<dt>
-<code>THE_REQUEST</code>
-</dt>
-
-
-<dd>The full HTTP request line sent by the
+ <dd>The full HTTP request line sent by the
browser to the server (e.g., "<code>GET
/index.html HTTP/1.1</code>"). This does not
include any additional headers sent by the
browser.</dd>
+ <dt><code>REQUEST_URI</code></dt>
-<dt>
-<code>REQUEST_URI</code>
-</dt>
-
-
-<dd>The resource requested in the HTTP request
+ <dd>The resource requested in the HTTP request
line. (In the example above, this would be
"/index.html".)</dd>
+ <dt><code>REQUEST_FILENAME</code></dt>
-<dt>
-<code>REQUEST_FILENAME</code>
-</dt>
-
-
-<dd>The full local filesystem path to the file or
+ <dd>The full local filesystem path to the file or
script matching the request.</dd>
+ </dl>
+</td></tr></table></blockquote>
+ </li>
+ </ul>
-</dl>
-
-</td>
-</tr>
-</table>
-</blockquote>
-
-</li>
-
-</ul>
-
-
-<p>Special Notes:</p>
-
-
-<ol>
+ <p>Special Notes:</p>
-<li>The variables SCRIPT_FILENAME and REQUEST_FILENAME
+ <ol>
+ <li>The variables SCRIPT_FILENAME and REQUEST_FILENAME
contain the same value, <em>i.e.</em>, the value of the
<code>filename</code> field of the internal
<code>request_rec</code> structure of the Apache server.
@@ -918,23 +557,20 @@
REQUEST_URI (which contains the value of the
<code>uri</code> field of <code>request_rec</code>).</li>
-
-<li>There is the special format:
+ <li>There is the special format:
<code>%{ENV:variable}</code> where <em>variable</em> can be
any environment variable. This is looked-up via internal
Apache structures and (if not found there) via
<code>getenv()</code> from the Apache server process.</li>
-
-<li>There is the special format:
+ <li>There is the special format:
<code>%{HTTP:header}</code> where <em>header</em> can be
any HTTP MIME-header name. This is looked-up from the HTTP
request. Example: <code>%{HTTP:Proxy-Connection}</code> is
the value of the HTTP header
``<code>Proxy-Connection:</code>''.</li>
-
-<li>There is the special format
+ <li>There is the special format
<code>%{LA-U:variable}</code> for look-aheads which perform
an internal (URL-based) sub-request to determine the final
value of <em>variable</em>. Use this when you want to use a
@@ -952,61 +588,49 @@
phases come <em>before</em> this phase, you just can use
<code>%{REMOTE_USER}</code> there.</li>
-
-<li>There is the special format:
+ <li>There is the special format:
<code>%{LA-F:variable}</code> which performs an internal
(filename-based) sub-request to determine the final value
of <em>variable</em>. Most of the time this is the same as
LA-U above.</li>
+ </ol>
-</ol>
-
-
-<p>
-<em>CondPattern</em> is the condition pattern,
+ <p><em>CondPattern</em> is the condition pattern,
<em>i.e.</em>, a regular expression which is applied to the
current instance of the <em>TestString</em>, <em>i.e.</em>,
<em>TestString</em> is evaluated and then matched against
<em>CondPattern</em>.</p>
-
-<p>
-<strong>Remember:</strong> <em>CondPattern</em> is a
+ <p><strong>Remember:</strong> <em>CondPattern</em> is a
standard <em>Extended Regular Expression</em> with some
additions:</p>
-
-<ol>
-
-<li>You can prefix the pattern string with a
+ <ol>
+ <li>You can prefix the pattern string with a
'<code>!</code>' character (exclamation mark) to specify a
<strong>non</strong>-matching pattern.</li>
-
-<li>
+ <li>
There are some special variants of <em>CondPatterns</em>.
Instead of real regular expression strings you can also
use one of the following:
<ul>
-
-<li>'<strong><CondPattern</strong>' (is lexically
+ <li>'<strong><CondPattern</strong>' (is lexically
lower)<br>
Treats the <em>CondPattern</em> as a plain string and
compares it lexically to <em>TestString</em>. True if
<em>TestString</em> is lexically lower than
<em>CondPattern</em>.</li>
-
-<li>'<strong>>CondPattern</strong>' (is lexically
+ <li>'<strong>>CondPattern</strong>' (is lexically
greater)<br>
Treats the <em>CondPattern</em> as a plain string and
compares it lexically to <em>TestString</em>. True if
<em>TestString</em> is lexically greater than
<em>CondPattern</em>.</li>
-
-<li>'<strong>=CondPattern</strong>' (is lexically
+ <li>'<strong>=CondPattern</strong>' (is lexically
equal)<br>
Treats the <em>CondPattern</em> as a plain string and
compares it lexically to <em>TestString</em>. True if
@@ -1016,33 +640,28 @@
is just <samp>""</samp> (two quotation marks) this
compares <em>TestString</em> to the empty string.</li>
-
-<li>'<strong>-d</strong>' (is
+ <li>'<strong>-d</strong>' (is
<strong>d</strong>irectory)<br>
Treats the <em>TestString</em> as a pathname and tests
if it exists and is a directory.</li>
-
-<li>'<strong>-f</strong>' (is regular
+ <li>'<strong>-f</strong>' (is regular
<strong>f</strong>ile)<br>
Treats the <em>TestString</em> as a pathname and tests
if it exists and is a regular file.</li>
-
-<li>'<strong>-s</strong>' (is regular file with
+ <li>'<strong>-s</strong>' (is regular file with
<strong>s</strong>ize)<br>
Treats the <em>TestString</em> as a pathname and tests
if it exists and is a regular file with size greater
than zero.</li>
-
-<li>'<strong>-l</strong>' (is symbolic
+ <li>'<strong>-l</strong>' (is symbolic
<strong>l</strong>ink)<br>
Treats the <em>TestString</em> as a pathname and tests
if it exists and is a symbolic link.</li>
-
-<li>'<strong>-F</strong>' (is existing file via
+ <li>'<strong>-F</strong>' (is existing file via
subrequest)<br>
Checks if <em>TestString</em> is a valid file and
accessible via all the server's currently-configured
@@ -1050,54 +669,35 @@
subrequest to determine the check, so use it with care
because it decreases your servers performance!</li>
-
-<li>'<strong>-U</strong>' (is existing URL via
+ <li>'<strong>-U</strong>' (is existing URL via
subrequest)<br>
Checks if <em>TestString</em> is a valid URL and
accessible via all the server's currently-configured
access controls for that path. This uses an internal
subrequest to determine the check, so use it with care
because it decreases your server's performance!</li>
+ </ul>
-</ul>
-
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Notice</strong>
-</p>
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Notice</strong></p>
All of these tests can
also be prefixed by an exclamation mark ('!') to
negate their meaning.
-</td>
-</tr>
-</table>
-</blockquote>
-
-</li>
-
-</ol>
-
+</td></tr></table></blockquote>
+ </li>
+ </ol>
-<p>Additionally you can set special flags for
+ <p>Additionally you can set special flags for
<em>CondPattern</em> by appending</p>
-
-<blockquote>
-
-<strong><code>[</code><em>flags</em><code>]</code></strong>
-
-</blockquote>
+ <blockquote>
+ <strong><code>[</code><em>flags</em><code>]</code></strong>
+ </blockquote>
as the third argument to the <code>RewriteCond</code>
directive. <em>Flags</em> is a comma-separated list of the
following flags:
<ul>
-
-<li>'<strong><code>nocase|NC</code></strong>'
+ <li>'<strong><code>nocase|NC</code></strong>'
(<strong>n</strong>o <strong>c</strong>ase)<br>
This makes the test case-insensitive, <em>i.e.</em>, there
is no difference between 'A-Z' and 'a-z' both in the
@@ -1106,52 +706,33 @@
<em>TestString</em> and <em>CondPattern</em>. It has no
effect on filesystem and subrequest checks.</li>
-
-<li>
+ <li>
'<strong><code>ornext|OR</code></strong>'
(<strong>or</strong> next condition)<br>
Use this to combine rule conditions with a local OR
instead of the implicit AND. Typical example:
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
RewriteCond %{REMOTE_HOST} ^host1.* [OR]
RewriteCond %{REMOTE_HOST} ^host2.* [OR]
RewriteCond %{REMOTE_HOST} ^host3.*
RewriteRule ...some special stuff for any of these hosts...
</pre>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
Without this flag you would have to write the cond/rule
three times.
</li>
+ </ul>
-</ul>
-
-
-<p>
-<strong>Example:</strong>
-</p>
-
+ <p><strong>Example:</strong></p>
-<p>To rewrite the Homepage of a site according to the
+ <p>To rewrite the Homepage of a site according to the
``<code>User-Agent:</code>'' header of the request, you can
use the following: </p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
RewriteCond %{HTTP_USER_AGENT} ^Mozilla.*
RewriteRule ^/$ /homepage.max.html [L]
@@ -1161,14 +742,9 @@
RewriteRule ^/$ /homepage.std.html [L]
</pre>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>Interpretation: If you use Netscape Navigator as your
+ <p>Interpretation: If you use Netscape Navigator as your
browser (which identifies itself as 'Mozilla'), then you
get the max homepage, which includes Frames, <em>etc.</em>
If you use the Lynx browser (which is Terminal-based), then
@@ -1176,152 +752,39 @@
tables, <em>etc.</em> If you use any other browser you get
the standard homepage.</p>
+</usage><hr/><h2><a name="RewriteEngine">RewriteEngine</a> <a name="rewriteengine">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RewriteEngine on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>RewriteEngine off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
-</usage>
-<hr>
-<h2>
-<a name="RewriteEngine">RewriteEngine</a> <a name="rewriteengine">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RewriteEngine on|off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>RewriteEngine off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-
-<p>The <code class="directive">RewriteEngine</code> directive enables or
+ <p>The <code class="directive">RewriteEngine</code> directive enables or
disables the runtime rewriting engine. If it is set to
<code>off</code> this module does no runtime processing at
all. It does not even update the <code>SCRIPT_URx</code>
environment variables.</p>
+ <p>Use this directive to disable the module instead of
+ commenting out all the <a href="#rewriterule" class="directive"><code class="directive">RewriteRule</code></a> directives!</p>
-<p>Use this directive to disable the module instead of
- commenting out all the <code class="directive"><a href="#rewriterule" class="directive">RewriteRule</a></code> directives!</p>
-
-
-<p>Note that, by default, rewrite configurations are not
+ <p>Note that, by default, rewrite configurations are not
inherited. This means that you need to have a
<code>RewriteEngine on</code> directive for each virtual host
in which you wish to use it.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="RewriteLock">RewriteLock</a> <a name="rewritelock">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the name of the lock file used for RewriteMap
-synchronization</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RewriteLock <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive sets the filename for a synchronization
- lockfile which mod_rewrite needs to communicate with <code class="directive"><a href="#rewritemap" class="directive">RewriteMap</a></code>
+</usage><hr/><h2><a name="RewriteLock">RewriteLock</a> <a name="rewritelock">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the name of the lock file used for RewriteMap
+synchronization</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RewriteLock <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
+ <p>This directive sets the filename for a synchronization
+ lockfile which mod_rewrite needs to communicate with <a href="#rewritemap" class="directive"><code class="directive">RewriteMap</code></a>
<em>programs</em>. Set this lockfile to a local path (not on a
NFS-mounted device) when you want to use a rewriting
map-program. It is not required for other types of rewriting
maps.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="RewriteLog">RewriteLog</a> <a name="rewritelog">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the name of the file used for logging rewrite engine
-processing</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RewriteLog <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">RewriteLog</code> directive sets the name
+</usage><hr/><h2><a name="RewriteLog">RewriteLog</a> <a name="rewritelog">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the name of the file used for logging rewrite engine
+processing</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RewriteLog <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">RewriteLog</code> directive sets the name
of the file to which the server logs any rewriting actions it
performs. If the name does not begin with a slash
('<code>/</code>') then it is assumed to be relative to the
<em>Server Root</em>. The directive should occur only once per
server config.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5"> To disable the logging of
+<blockquote><table><tr><td bgcolor="#e0e5f5"> To disable the logging of
rewriting actions it is not recommended to set
<em>Filename</em> to <code>/dev/null</code>, because
although the rewriting engine does not then output to a
@@ -1330,202 +793,75 @@
to the administrator!</strong> To disable logging either
remove or comment out the <code class="directive">RewriteLog</code>
directive or use <code>RewriteLogLevel 0</code>!
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Security</strong>
-</p>
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Security</strong></p>
See the <a href="../misc/security_tips.html">Apache Security Tips</a>
document for details on why your security could be compromised if the
directory where logfiles are stored is writable by anyone other than
the user that starts the server.
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee">
-<p align="center">
-<strong>Example</strong>
-</p>
-<code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
RewriteLog "/usr/local/var/apache/logs/rewrite.log"
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-</usage>
-<hr>
-<h2>
-<a name="RewriteLogLevel">RewriteLogLevel</a> <a name="rewriteloglevel">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the verbosity of the log file used by the rewrite
-engine</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RewriteLogLevel <em>Level</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>RerwiteLogLevel 0</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
+</code></td></tr></table></blockquote>
-<p>The <code class="directive">RewriteLogLevel</code> directive sets the
+</usage><hr/><h2><a name="RewriteLogLevel">RewriteLogLevel</a> <a name="rewriteloglevel">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the verbosity of the log file used by the rewrite
+engine</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RewriteLogLevel <em>Level</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>RerwiteLogLevel 0</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">RewriteLogLevel</code> directive sets the
verbosity level of the rewriting logfile. The default level 0
means no logging, while 9 or more means that practically all
actions are logged.</p>
-
-<p>To disable the logging of rewriting actions simply set
+ <p>To disable the logging of rewriting actions simply set
<em>Level</em> to 0. This disables all rewrite action
logs.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5"> Using a high value for
+<blockquote><table><tr><td bgcolor="#e0e5f5"> Using a high value for
<em>Level</em> will slow down your Apache server
dramatically! Use the rewriting logfile at a
<em>Level</em> greater than 2 only for debugging!
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee">
-<p align="center">
-<strong>Example</strong>
-</p>
-<code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
RewriteLogLevel 3
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-</usage>
-<hr>
-<h2>
-<a name="RewriteMap">RewriteMap</a> <a name="rewritemap">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Defines a mapping function for key-lookup</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RewriteMap <em>MapName</em> <em>MapType</em>:<em>MapSource</em>
-
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
+</code></td></tr></table></blockquote>
-<p>The <code class="directive">RewriteMap</code> directive defines a
+</usage><hr/><h2><a name="RewriteMap">RewriteMap</a> <a name="rewritemap">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Defines a mapping function for key-lookup</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RewriteMap <em>MapName</em> <em>MapType</em>:<em>MapSource</em>
+</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">RewriteMap</code> directive defines a
<em>Rewriting Map</em> which can be used inside rule
substitution strings by the mapping-functions to
insert/substitute fields through a key lookup. The source of
this lookup can be of various types.</p>
-
-<p>The <a id="mapfunc" name="mapfunc"><em>MapName</em></a> is
+ <p>The <a id="mapfunc" name="mapfunc"><em>MapName</em></a> is
the name of the map and will be used to specify a
mapping-function for the substitution strings of a rewriting
rule via one of the following constructs:</p>
-
-<blockquote>
-
-<strong><code>${</code> <em>MapName</em> <code>:</code>
- <em>LookupKey</em> <code>}</code>
-<br>
-
-<code>${</code> <em>MapName</em> <code>:</code>
+ <blockquote>
+ <strong><code>${</code> <em>MapName</em> <code>:</code>
+ <em>LookupKey</em> <code>}</code><br>
+ <code>${</code> <em>MapName</em> <code>:</code>
<em>LookupKey</em> <code>|</code> <em>DefaultValue</em>
<code>}</code></strong>
+ </blockquote>
-</blockquote>
-
-
-<p>When such a construct occurs the map <em>MapName</em> is
+ <p>When such a construct occurs the map <em>MapName</em> is
consulted and the key <em>LookupKey</em> is looked-up. If the
key is found, the map-function construct is substituted by
<em>SubstValue</em>. If the key is not found then it is
substituted by <em>DefaultValue</em> or by the empty string
if no <em>DefaultValue</em> was specified.</p>
-
-<p>The following combinations for <em>MapType</em> and
+ <p>The following combinations for <em>MapType</em> and
<em>MapSource</em> can be used:</p>
-
-<ul>
-
-<li>
-
-<strong>Standard Plain Text</strong>
-<br>
+ <ul>
+ <li>
+ <strong>Standard Plain Text</strong><br>
MapType: <code>txt</code>, MapSource: Unix filesystem
path to valid regular file
@@ -1535,24 +871,12 @@
character) or pairs like the following - one per
line.</p>
-
-<blockquote>
-
-<strong><em>MatchingKey</em>
+ <blockquote>
+ <strong><em>MatchingKey</em>
<em>SubstValue</em></strong>
+ </blockquote>
-</blockquote>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee">
-<p align="center">
-<strong>Example</strong>
-</p>
-<code>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
<pre>
##
## map.txt -- rewriting map
@@ -1561,30 +885,15 @@
Ralf.S.Engelschall rse # Bastard Operator From Hell
Mr.Joe.Average joe # Mr. Average
</pre>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
RewriteMap real-to-user txt:/path/to/file/map.txt
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</li>
-
-
-<li>
+</code></td></tr></table></blockquote>
+ </li>
-<strong>Randomized Plain Text</strong>
-<br>
+ <li>
+ <strong>Randomized Plain Text</strong><br>
MapType: <code>rnd</code>, MapSource: Unix filesystem
path to valid regular file
@@ -1599,12 +908,7 @@
proxy situation where the looked up values are server
names. Example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
##
## map.txt -- rewriting map
@@ -1613,30 +917,15 @@
static www1|www2|www3|www4
dynamic www5|www6
</pre>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
RewriteMap servers rnd:/path/to/file/map.txt
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</li>
-
-
-<li>
+</code></td></tr></table></blockquote>
+ </li>
-<strong>Hash File</strong>
-<br>
+ <li>
+ <strong>Hash File</strong><br>
MapType: <code>dbm</code>, MapSource: Unix filesystem
path to valid regular file
@@ -1647,12 +936,7 @@
file with any NDBM tool or with the following Perl
script:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
#!/path/to/bin/perl
##
@@ -1675,30 +959,15 @@
untie %DB;
close(TXT);
</pre>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
$ txt2dbm map.txt map.db
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</li>
-
-
-<li>
+</code></td></tr></table></blockquote>
+ </li>
-<strong>Internal Function</strong>
-<br>
+ <li>
+ <strong>Internal Function</strong><br>
MapType: <code>int</code>, MapSource: Internal Apache
function
@@ -1706,39 +975,25 @@
Currently you cannot create your own, but the following
functions already exists:</p>
-
-<ul>
-
-<li>
-<strong>toupper</strong>:<br>
+ <ul>
+ <li><strong>toupper</strong>:<br>
Converts the looked up key to all upper case.</li>
-
-<li>
-<strong>tolower</strong>:<br>
+ <li><strong>tolower</strong>:<br>
Converts the looked up key to all lower case.</li>
-
-<li>
-<strong>escape</strong>:<br>
+ <li><strong>escape</strong>:<br>
Translates special characters in the looked up key to
hex-encodings.</li>
-
-<li>
-<strong>unescape</strong>:<br>
+ <li><strong>unescape</strong>:<br>
Translates hex-encodings in the looked up key back to
special characters.</li>
+ </ul>
+ </li>
-</ul>
-
-</li>
-
-
-<li>
-
-<strong>External Rewriting Program</strong>
-<br>
+ <li>
+ <strong>External Rewriting Program</strong><br>
MapType: <code>prg</code>, MapSource: Unix filesystem
path to valid regular file
@@ -1749,8 +1004,7 @@
'<code>#!/path/to/interpreter</code>' as the first
line).</p>
-
-<p>This program is started once at startup of the Apache
+ <p>This program is started once at startup of the Apache
servers and then communicates with the rewriting engine
over its <code>stdin</code> and <code>stdout</code>
file-handles. For each map-function lookup it will
@@ -1763,12 +1017,7 @@
program which will implement a 1:1 map (<em>i.e.</em>,
key == value) could be:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
#!/usr/bin/perl
$| = 1;
@@ -1777,38 +1026,26 @@
print $_;
}
</pre>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>But be very careful:</p>
-
-
-<ol>
+ <p>But be very careful:</p>
-<li>``<em>Keep it simple, stupid</em>'' (KISS), because
+ <ol>
+ <li>``<em>Keep it simple, stupid</em>'' (KISS), because
if this program hangs it will hang the Apache server
when the rule occurs.</li>
-
-<li>Avoid one common mistake: never do buffered I/O on
+ <li>Avoid one common mistake: never do buffered I/O on
<code>stdout</code>! This will cause a deadloop! Hence
the ``<code>$|=1</code>'' in the above example...</li>
-
-<li>Use the <code class="directive"><a href="#rewritelock" class="directive">RewriteLock</a></code> directive to
+ <li>Use the <a href="#rewritelock" class="directive"><code class="directive">RewriteLock</code></a> directive to
define a lockfile mod_rewrite can use to synchronize the
communication to the program. By default no such
synchronization takes place.</li>
-
-</ol>
-
-</li>
-
-</ul>
+ </ol>
+ </li>
+ </ul>
The <code class="directive">RewriteMap</code> directive can occur more than
once. For each mapping-function use one
<code class="directive">RewriteMap</code> directive to declare its rewriting
@@ -1816,129 +1053,40 @@
per-directory context it is of course possible to
<strong>use</strong> this map in per-directory context.
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Note</strong>
-</p> For plain text and DBM format files the
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p> For plain text and DBM format files the
looked-up keys are cached in-core until the <code>mtime</code> of the
mapfile changes or the server does a restart. This way you can have
map-functions in rules which are used for <strong>every</strong>
request. This is no problem, because the external lookup only happens
once!
-</td>
-</tr>
-</table>
-</blockquote>
-
-
-</usage>
-<hr>
-<h2>
-<a name="RewriteOptions">RewriteOptions</a> <a name="rewriteoptions">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets some special options for the rewrite engine</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RewriteOptions <em>Options</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
+</td></tr></table></blockquote>
+</usage><hr/><h2><a name="RewriteOptions">RewriteOptions</a> <a name="rewriteoptions">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets some special options for the rewrite engine</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RewriteOptions <em>Options</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
-<p>The <code class="directive">RewriteOptions</code> directive sets some
+ <p>The <code class="directive">RewriteOptions</code> directive sets some
special options for the current per-server or per-directory
configuration. The <em>Option</em> strings can be one of the
following:</p>
-
-<ul>
-
-<li>'<strong><code>inherit</code></strong>'<br>
+ <ul>
+ <li>'<strong><code>inherit</code></strong>'<br>
This forces the current configuration to inherit the
configuration of the parent. In per-virtual-server context
this means that the maps, conditions and rules of the main
server are inherited. In per-directory context this means
that conditions and rules of the parent directory's
<code>.htaccess</code> configuration are inherited.</li>
-
-</ul>
-
-</usage>
-<hr>
-<h2>
-<a name="RewriteRule">RewriteRule</a> <a name="rewriterule">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Defines rules for the rewriting engine</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>RewriteRule
- <em>Pattern</em> <em>Substitution</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">RewriteRule</code> directive is the real
+ </ul>
+</usage><hr/><h2><a name="RewriteRule">RewriteRule</a> <a name="rewriterule">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Defines rules for the rewriting engine</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RewriteRule
+ <em>Pattern</em> <em>Substitution</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_rewrite</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">RewriteRule</code> directive is the real
rewriting workhorse. The directive can occur more than once.
Each directive then defines one single rewriting rule. The
<strong>definition order</strong> of these rules is
<strong>important</strong>, because this order is used when
applying the rules at run-time.</p>
-
-<p>
-<a id="patterns" name="patterns"><em>Pattern</em></a> can
+ <p><a id="patterns" name="patterns"><em>Pattern</em></a> can
be (for Apache 1.1.x a System V8 and for Apache 1.2.x and
later a POSIX) <a id="regexp" name="regexp">regular
expression</a> which gets applied to the current URL. Here
@@ -1947,18 +1095,12 @@
because any number of rules may already have matched and made
alterations to it.</p>
+ <p>Some hints about the syntax of regular expressions:</p>
-<p>Some hints about the syntax of regular expressions:</p>
-
-
-<table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
-
-<tr>
-
-<td valign="TOP">
-
+ <table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
+ <tr>
+ <td valign="TOP">
<pre>
-
<strong>Text:</strong>
<strong><code>.</code></strong> Any single character
<strong><code>[</code></strong>chars<strong><code>]</code></strong> Character class: One of chars
@@ -1984,15 +1126,11 @@
<strong><code>\</code></strong>char escape that particular char
(for instance to specify the chars "<code>.[]()</code>" <em>etc.</em>)
</pre>
+ </td>
+ </tr>
+ </table>
-</td>
-
-</tr>
-
-</table>
-
-
-<p>For more information about regular expressions either have
+ <p>For more information about regular expressions either have
a look at your local regex(3) manpage or its
<code>src/regex/regex.3</code> copy in the Apache 1.3
distribution. If you are interested in more detailed
@@ -2000,20 +1138,15 @@
(POSIX regex, Perl regex, <em>etc.</em>) have a look at the
following dedicated book on this topic:</p>
-
-<blockquote>
-
-<em>Mastering Regular Expressions</em>
-<br>
+ <blockquote>
+ <em>Mastering Regular Expressions</em><br>
Jeffrey E.F. Friedl<br>
Nutshell Handbook Series<br>
O'Reilly & Associates, Inc. 1997<br>
ISBN 1-56592-257-3<br>
+ </blockquote>
-</blockquote>
-
-
-<p>Additionally in mod_rewrite the NOT character
+ <p>Additionally in mod_rewrite the NOT character
('<code>!</code>') is a possible pattern prefix. This gives
you the ability to negate a pattern; to say, for instance:
``<em>if the current URL does <strong>NOT</strong> match this
@@ -2021,14 +1154,7 @@
it is easier to match the negative pattern, or as a last
default rule.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Notice</strong>
-</p>
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Notice</strong></p>
When using the NOT character
to negate a pattern you cannot have grouped wildcard
parts in the pattern. This is impossible because when the
@@ -2036,38 +1162,26 @@
groups. In consequence, if negated patterns are used, you
cannot use <code>$N</code> in the substitution
string!
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<p>
-<a id="rhs" name="rhs"><em>Substitution</em></a> of a
+ <p><a id="rhs" name="rhs"><em>Substitution</em></a> of a
rewriting rule is the string which is substituted for (or
replaces) the original URL for which <em>Pattern</em>
matched. Beside plain text you can use</p>
-
-<ol>
-
-<li>back-references <code>$N</code> to the RewriteRule
+ <ol>
+ <li>back-references <code>$N</code> to the RewriteRule
pattern</li>
-
-<li>back-references <code>%N</code> to the last matched
+ <li>back-references <code>%N</code> to the last matched
RewriteCond pattern</li>
-
-<li>server-variables as in rule condition test-strings
+ <li>server-variables as in rule condition test-strings
(<code>%{VARNAME}</code>)</li>
-
-<li>
-<a href="#mapfunc">mapping-function</a> calls
+ <li><a href="#mapfunc">mapping-function</a> calls
(<code>${mapname:key|default}</code>)</li>
-
-</ol>
+ </ol>
Back-references are <code>$</code><strong>N</strong>
(<strong>N</strong>=0..9) identifiers which will be replaced
by the contents of the <strong>N</strong>th group of the
@@ -2086,8 +1200,7 @@
unless explicitly terminated by a
<code><strong>L</strong></code> flag - see below.</p>
-
-<p>There is a special substitution string named
+ <p>There is a special substitution string named
'<code>-</code>' which means: <strong>NO
substitution</strong>! Sounds silly? No, it is useful to
provide rewriting rules which <strong>only</strong> match
@@ -2096,8 +1209,7 @@
able to have more than one pattern to be applied before a
substitution occurs.</p>
-
-<p>One more note: You can even create URLs in the
+ <p>One more note: You can even create URLs in the
substitution string containing a query string part. Just use
a question mark inside the substitution string to indicate
that the following stuff should be re-injected into the
@@ -2105,14 +1217,7 @@
string, end the substitution string with just the question
mark.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Note</strong>
-</p>
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p>
There is a special feature:
When you prefix a substitution field with
<code>http://</code><em>thishost</em>[<em>:thisport</em>]
@@ -2122,46 +1227,28 @@
combination with a mapping-function which generates the
hostname part. Have a look at the first example in the
example section below to understand this.
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Remember</strong>
-</p>
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Remember</strong></p>
An unconditional external
redirect to your own server will not work with the prefix
<code>http://thishost</code> because of this feature. To
achieve such a self-redirect, you have to use the
<strong>R</strong>-flag (see below).
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<p>Additionally you can set special flags for
+ <p>Additionally you can set special flags for
<em>Substitution</em> by appending</p>
-
-<blockquote>
-
-<strong><code>[</code><em>flags</em><code>]</code></strong>
-
-</blockquote>
+ <blockquote>
+ <strong><code>[</code><em>flags</em><code>]</code></strong>
+ </blockquote>
as the third argument to the <code>RewriteRule</code>
directive. <em>Flags</em> is a comma-separated list of the
following flags:
<ul>
-
-<li>
+ <li>
'<strong><code>redirect|R</code>
[=<em>code</em>]</strong>' (force <a id="redirect" name="redirect"><strong>r</strong>edirect</a>)<br>
Prefix <em>Substitution</em> with
@@ -2179,9 +1266,7 @@
<code>/u/</code><em>user</em>, etc.<br>
-
-<p>
-<strong>Note:</strong> When you use this flag, make
+ <p><strong>Note:</strong> When you use this flag, make
sure that the substitution field is a valid URL! If not,
you are redirecting to an invalid location! And remember
that this flag itself only prefixes the URL with
@@ -2189,11 +1274,9 @@
continues. Usually you also want to stop and do the
redirection immediately. To stop the rewriting you also
have to provide the 'L' flag.</p>
+ </li>
-</li>
-
-
-<li>'<strong><code>forbidden|F</code></strong>' (force URL
+ <li>'<strong><code>forbidden|F</code></strong>' (force URL
to be <strong>f</strong>orbidden)<br>
This forces the current URL to be forbidden,
<em>i.e.</em>, it immediately sends back a HTTP response of
@@ -2201,15 +1284,13 @@
appropriate RewriteConds to conditionally block some
URLs.</li>
-
-<li>'<strong><code>gone|G</code></strong>' (force URL to be
+ <li>'<strong><code>gone|G</code></strong>' (force URL to be
<strong>g</strong>one)<br>
This forces the current URL to be gone, <em>i.e.</em>, it
immediately sends back a HTTP response of 410 (GONE). Use
this flag to mark pages which no longer exist as gone.</li>
-
-<li>
+ <li>
'<strong><code>proxy|P</code></strong>' (force
<strong>p</strong>roxy)<br>
This flag forces the substitution part to be internally
@@ -2232,11 +1313,9 @@
available to mod_rewrite. If not, then you first have to
rebuild the ``<code>httpd</code>'' program with mod_proxy
enabled.</p>
+ </li>
-</li>
-
-
-<li>'<strong><code>last|L</code></strong>'
+ <li>'<strong><code>last|L</code></strong>'
(<strong>l</strong>ast rule)<br>
Stop the rewriting process here and don't apply any more
rewriting rules. This corresponds to the Perl
@@ -2247,8 +1326,7 @@
('<code>/</code>') to a real one, <em>e.g.</em>,
'<code>/e/www/</code>'.</li>
-
-<li>'<strong><code>next|N</code></strong>'
+ <li>'<strong><code>next|N</code></strong>'
(<strong>n</strong>ext round)<br>
Re-run the rewriting process (starting again with the
first rewriting rule). Here the URL to match is again not
@@ -2257,13 +1335,10 @@
the <code>continue</code> command from the C language. Use
this flag to restart the rewriting process, <em>i.e.</em>,
to immediately go to the top of the loop.<br>
+ <strong>But be careful not to create an infinite
+ loop!</strong></li>
-<strong>But be careful not to create an infinite
- loop!</strong>
-</li>
-
-
-<li>'<strong><code>chain|C</code></strong>'
+ <li>'<strong><code>chain|C</code></strong>'
(<strong>c</strong>hained with next rule)<br>
This flag chains the current rule with the next rule
(which itself can be chained with the following rule,
@@ -2276,8 +1351,7 @@
when you let an external redirect happen (where the
``<code>.www</code>'' part should not to occur!).</li>
-
-<li>
+ <li>
'<strong><code>type|T</code></strong>=<em>MIME-type</em>'
(force MIME <strong>t</strong>ype)<br>
Force the MIME-type of the target file to be
@@ -2287,8 +1361,7 @@
inside the mapped directory to have a MIME type of
``<code>application/x-httpd-cgi</code>''.</li>
-
-<li>
+ <li>
'<strong><code>nosubreq|NS</code></strong>' (used only if
<strong>n</strong>o internal
<strong>s</strong>ub-request)<br>
@@ -2303,25 +1376,21 @@
exclude some rules.<br>
-
-<p>Use the following rule for your decision: whenever you
+ <p>Use the following rule for your decision: whenever you
prefix some URLs with CGI-scripts to force them to be
processed by the CGI-script, the chance is high that you
will run into problems (or even overhead) on
sub-requests. In these cases, use this flag.</p>
+ </li>
-</li>
-
-
-<li>'<strong><code>nocase|NC</code></strong>'
+ <li>'<strong><code>nocase|NC</code></strong>'
(<strong>n</strong>o <strong>c</strong>ase)<br>
This makes the <em>Pattern</em> case-insensitive,
<em>i.e.</em>, there is no difference between 'A-Z' and
'a-z' when <em>Pattern</em> is matched against the current
URL.</li>
-
-<li>'<strong><code>qsappend|QSA</code></strong>'
+ <li>'<strong><code>qsappend|QSA</code></strong>'
(<strong>q</strong>uery <strong>s</strong>tring
<strong>a</strong>ppend)<br>
This flag forces the rewriting engine to append a query
@@ -2329,8 +1398,7 @@
instead of replacing it. Use this when you want to add more
data to the query string via a rewrite rule.</li>
-
-<li>
+ <li>
'<strong><code>noescape|NE</code></strong>'
(<strong>n</strong>o URI <strong>e</strong>scaping of
output)<br>
@@ -2341,22 +1409,15 @@
'%24', and '%3B', respectively); this flag prevents this
from being done. This allows percent symbols to appear in
the output, as in
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
RewriteRule /foo/(.*) /bar?arg=P1\%3d$1 [R,NE]
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
which would turn '<code>/foo/zed</code>' into a safe
request for '<code>/bar?arg=P1=zed</code>'.
</li>
-
-<li>
+ <li>
'<strong><code>passthrough|PT</code></strong>'
(<strong>p</strong>ass <strong>t</strong>hrough to next
handler)<br>
@@ -2374,16 +1435,10 @@
engine of <code>mod_rewrite</code> and then
<code>/def</code> to <code>/ghi</code> with
<code>mod_alias</code>:
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
RewriteRule ^/abc(.*) /def$1 [PT]<br>
Alias /def /ghi
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
If you omit the <code>PT</code> flag then
<code>mod_rewrite</code> will do its job fine,
<em>i.e.</em>, it rewrites <code>uri=/abc/...</code> to
@@ -2398,29 +1453,17 @@
is the use of <code>mod_alias</code> and
<code>mod_rewrite</code>..</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>For Apache hackers</strong>
-</p>
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>For Apache hackers</strong></p>
If the current Apache API had a filename-to-filename
hook additionally to the URI-to-filename hook then we
wouldn't need this flag! But without such a hook this
flag is the only solution. The Apache Group has
discussed this problem and will add such a hook in
Apache version 2.0.
-</td>
-</tr>
-</table>
-</blockquote>
-
-</li>
-
+</td></tr></table></blockquote>
+ </li>
-<li>'<strong><code>skip|S</code></strong>=<em>num</em>'
+ <li>'<strong><code>skip|S</code></strong>=<em>num</em>'
(<strong>s</strong>kip next rule(s))<br>
This flag forces the rewriting engine to skip the next
<em>num</em> rules in sequence when the current rule
@@ -2430,8 +1473,7 @@
else-clause. (This is <strong>not</strong> the same as the
'chain|C' flag!)</li>
-
-<li>
+ <li>
'<strong><code>env|E=</code></strong><em>VAR</em>:<em>VAL</em>'
(set <strong>e</strong>nvironment variable)<br>
This forces an environment variable named <em>VAR</em> to
@@ -2446,17 +1488,9 @@
it in a following RewriteCond pattern via
<code>%{ENV:VAR}</code>. Use this to strip but remember
information from URLs.</li>
+ </ul>
-</ul>
-
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Note</strong>
-</p> Never forget that <em>Pattern</em> is
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p> Never forget that <em>Pattern</em> is
applied to a complete URL in per-server configuration
files. <strong>But in per-directory configuration files, the
per-directory prefix (which always is the same for a specific
@@ -2471,20 +1505,9 @@
prefix will <strong>not</strong> be added and an
external redirect or proxy throughput (if flag
<strong>P</strong> is used!) is forced!</p>
+</td></tr></table></blockquote>
-</td>
-</tr>
-</table>
-</blockquote>
-
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Note</strong>
-</p>
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p>
To enable the rewriting engine
for per-directory configuration files you need to set
``<code>RewriteEngine On</code>'' in these files
@@ -2494,34 +1517,21 @@
<code>FollowSymLinks</code> for a user's directory, then
you cannot use the rewriting engine. This restriction is
needed for security reasons.
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<p>Here are all possible substitution combinations and their
+ <p>Here are all possible substitution combinations and their
meanings:</p>
-
-<p>
-<strong>Inside per-server configuration
+ <p><strong>Inside per-server configuration
(<code>httpd.conf</code>)<br>
for request ``<code>GET
- /somepath/pathinfo</code>'':</strong>
-<br>
-
-</p>
-
-
-<table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
-
-<tr>
-
-<td>
+ /somepath/pathinfo</code>'':</strong><br>
+ </p>
+ <table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
+ <tr>
+ <td>
<pre>
-
<strong>Given Rule</strong> <strong>Resulting Substitution</strong>
---------------------------------------------- ----------------------------------
^/somepath(.*) otherpath$1 not supported, because invalid!
@@ -2554,36 +1564,23 @@
^/somepath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo
via internal proxy
</pre>
+ </td>
+ </tr>
+ </table>
-</td>
-
-</tr>
-
-</table>
-
-
-<p>
-<strong>Inside per-directory configuration for
- <code>/somepath</code>
-<br>
+ <p><strong>Inside per-directory configuration for
+ <code>/somepath</code><br>
(<em>i.e.</em>, file <code>.htaccess</code> in dir
<code>/physical/path/to/somepath</code> containing
<code>RewriteBase /somepath</code>)<br>
for request ``<code>GET
- /somepath/localpath/pathinfo</code>'':</strong>
-<br>
-
-</p>
-
-
-<table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
-
-<tr>
-
-<td>
+ /somepath/localpath/pathinfo</code>'':</strong><br>
+ </p>
+ <table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
+ <tr>
+ <td>
<pre>
-
<strong>Given Rule</strong> <strong>Resulting Substitution</strong>
---------------------------------------------- ----------------------------------
^localpath(.*) otherpath$1 /somepath/otherpath/pathinfo
@@ -2617,65 +1614,36 @@
^localpath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo
via internal proxy
</pre>
+ </td>
+ </tr>
+ </table>
-</td>
-
-</tr>
-
-</table>
-
-
-<p>
-<strong>Example:</strong>
-</p>
-
-
-<p>We want to rewrite URLs of the form </p>
-
+ <p><strong>Example:</strong></p>
-<blockquote>
+ <p>We want to rewrite URLs of the form </p>
-<code>/</code> <em>Language</em> <code>/~</code>
+ <blockquote>
+ <code>/</code> <em>Language</em> <code>/~</code>
<em>Realname</em> <code>/.../</code> <em>File</em>
-
-</blockquote>
+ </blockquote>
into
<blockquote>
-
-<code>/u/</code> <em>Username</em> <code>/.../</code>
+ <code>/u/</code> <em>Username</em> <code>/.../</code>
<em>File</em> <code>.</code> <em>Language</em>
+ </blockquote>
-</blockquote>
-
-
-<p>We take the rewrite mapfile from above and save it under
+ <p>We take the rewrite mapfile from above and save it under
<code>/path/to/file/map.txt</code>. Then we only have to
add the following lines to the Apache server configuration
file:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
-
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
RewriteLog /path/to/file/rewrite.log
RewriteMap real-to-user txt:/path/to/file/map.txt
RewriteRule ^/([^/]+)/~([^/]+)/(.*)$ /u/${real-to-user:$2|nobody}/$3.$1
</pre>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.20 +74 -409 httpd-2.0/docs/manual/mod/mod_setenvif.html
Index: mod_setenvif.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_setenvif.html,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -d -b -u -r1.19 -r1.20
--- mod_setenvif.html 19 Feb 2002 18:37:19 -0000 1.19
+++ mod_setenvif.html 6 Mar 2002 17:08:19 -0000 1.20
@@ -1,143 +1,31 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_setenvif - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_setenvif</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Allows the setting of environment variables based
-on characteristics of the request</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>setenvif_module</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
-<compatibility>Available in Apache 1.3 and later</compatibility>
-</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
+--><title>mod_setenvif - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_setenvif</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Allows the setting of environment variables based
+on characteristics of the request</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>setenvif_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
-<p>The <code><a href="mod_setenvif.html">mod_setenvif</a></code> module allows you to set
+ <p>The <code><a href="mod_setenvif.html">mod_setenvif</a></code> module allows you to set
environment variables according to whether different aspects of
the request match regular expressions you specify. These
environment variables can be used by other parts of the server
to make decisions about actions to be taken.</p>
-
-<p>The directives are considered in the order they appear in
+ <p>The directives are considered in the order they appear in
the configuration files. So more complex sequences can be used,
such as this example, which sets <code>netscape</code> if the
browser is mozilla but not MSIE.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
BrowserMatch ^Mozilla netscape<br>
BrowserMatch MSIE !netscape<br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</summary>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../env.html">Environment Variables in Apache</a>
-</li>
-</ul>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#browsermatch">BrowserMatch</a>
-</li>
-<li>
-<a href="#browsermatchnocase">BrowserMatchNoCase</a>
-</li>
-<li>
-<a href="#setenvif">SetEnvIf</a>
-</li>
-<li>
-<a href="#setenvifnocase">SetEnvIfNoCase</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="BrowserMatch">BrowserMatch</a> <a name="browsermatch">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets environment variables conditional on HTTP User-Agent
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>BrowserMatch <em>regex env-variable</em>[=<em>value</em>]
-[<em>env-variable</em>[=<em>value</em>]] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.2 and
+</code></td></tr></table></blockquote>
+</summary><p><strong>See also </strong></p><ul><li><a href="../env.html">Environment Variables in Apache</a></li></ul><h2>Directives</h2><ul><li><a href="#browsermatch">BrowserMatch</a></li><li><a href="#browsermatchnocase">BrowserMatchNoCase</a></li><li><a href="#setenvif">SetEnvIf</a></li><li><a href="#setenvifnocase">SetEnvIfNoCase</a></li></ul><hr/><h2><a name="BrowserMatch">BrowserMatch</a> <a name="browsermatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets environment variables conditional on HTTP User-Agent
+</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>BrowserMatch <em>regex env-variable</em>[=<em>value</em>]
+[<em>env-variable</em>[=<em>value</em>]] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.2 and
above (in Apache 1.2 this directive was found in the
- now-obsolete mod_browser module)</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">BrowserMatch</code> directive defines
+ now-obsolete mod_browser module)</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">BrowserMatch</code> directive defines
environment variables based on the <code>User-Agent</code> HTTP
request header field. The first argument should be a POSIX.2
extended regular expression (similar to an
@@ -145,25 +33,15 @@
the names of variables to set, and optionally values to which they
should be set. These take the form of</p>
+ <ol>
+ <li><code><em>varname</em></code>, or</li>
-<ol>
-
-<li>
-<code><em>varname</em></code>, or</li>
-
-
-<li>
-<code>!<em>varname</em></code>, or</li>
-
-
-<li>
-<code><em>varname</em>=<em>value</em></code>
-</li>
-
-</ol>
+ <li><code>!<em>varname</em></code>, or</li>
+ <li><code><em>varname</em>=<em>value</em></code></li>
+ </ol>
-<p>In the first form, the value will be set to "1". The second
+ <p>In the first form, the value will be set to "1". The second
will remove the given variable if already defined, and the
third will set the variable to the value given by
<code><em>value</em></code>. If a <code>User-Agent</code>
@@ -171,260 +49,109 @@
Entries are processed in the order in which they appear, and
later entries can override earlier ones.</p>
-
-<p>For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+ <p>For example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
BrowserMatch ^Mozilla forms jpeg=yes browser=netscape<br>
BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript<br>
BrowserMatch MSIE !javascript<br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>Note that the regular expression string is
+ <p>Note that the regular expression string is
<strong>case-sensitive</strong>. For case-INsensitive matching,
- see the <code class="directive"><a href="#browsermatchnocase" class="directive">BrowserMatchNoCase</a></code>
+ see the <a href="#browsermatchnocase" class="directive"><code class="directive">BrowserMatchNoCase</code></a>
directive.</p>
-
-<p>The <code class="directive">BrowserMatch</code> and
+ <p>The <code class="directive">BrowserMatch</code> and
<code class="directive">BrowserMatchNoCase</code> directives are special cases of
- the <code class="directive"><a href="#setenvif" class="directive">SetEnvIf</a></code> and <code class="directive"><a href="#setenvifnocase" class="directive">SetEnvIfNoCase</a></code>
+ the <a href="#setenvif" class="directive"><code class="directive">SetEnvIf</code></a> and <a href="#setenvifnocase" class="directive"><code class="directive">SetEnvIfNoCase</code></a>
directives. The following two lines have the same effect:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
BrowserMatchNoCase Robot is_a_robot<br>
SetEnvIfNoCase User-Agent Robot is_a_robot<br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="BrowserMatchNoCase">BrowserMatchNoCase</a> <a name="browsermatchnocase">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets environment variables conditional on User-Agent without
-respect to case</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>BrowserMatchNoCase <em>regex env-variable</em>[=<em>value</em>]
- [<em>env-variable</em>[=<em>value</em>]] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.2 and
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="BrowserMatchNoCase">BrowserMatchNoCase</a> <a name="browsermatchnocase">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets environment variables conditional on User-Agent without
+respect to case</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>BrowserMatchNoCase <em>regex env-variable</em>[=<em>value</em>]
+ [<em>env-variable</em>[=<em>value</em>]] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.2 and
above (in Apache 1.2 this directive was found in the
- now-obsolete mod_browser module)</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
+ now-obsolete mod_browser module)</td></tr></table></td></tr></table><usage>
-<p>The <code class="directive">BrowserMatchNoCase</code> directive is
- semantically identical to the <code class="directive"><a href="#browsermatch" class="directive">BrowserMatch</a></code> directive.
+ <p>The <code class="directive">BrowserMatchNoCase</code> directive is
+ semantically identical to the <a href="#browsermatch" class="directive"><code class="directive">BrowserMatch</code></a> directive.
However, it provides for case-insensitive matching. For
example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
BrowserMatchNoCase mac platform=macintosh<br>
BrowserMatchNoCase win platform=windows<br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>The <code class="directive">BrowserMatch</code> and
+ <p>The <code class="directive">BrowserMatch</code> and
<code class="directive">BrowserMatchNoCase</code> directives are special cases of
- the <code class="directive"><a href="#setenvif" class="directive">SetEnvIf</a></code> and <code class="directive"><a href="#setenvifnocase" class="directive">SetEnvIfNoCase</a></code>
+ the <a href="#setenvif" class="directive"><code class="directive">SetEnvIf</code></a> and <a href="#setenvifnocase" class="directive"><code class="directive">SetEnvIfNoCase</code></a>
directives. The following two lines have the same effect:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
BrowserMatchNoCase Robot is_a_robot<br>
SetEnvIfNoCase User-Agent Robot is_a_robot<br>
-
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h2>
-<a name="SetEnvIf">SetEnvIf</a> <a name="setenvif">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets environment variables based on attributes of the request
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>SetEnvIf <em>attribute
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="SetEnvIf">SetEnvIf</a> <a name="setenvif">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets environment variables based on attributes of the request
+</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SetEnvIf <em>attribute
regex env-variable</em>[=<em>value</em>]
- [<em>env-variable</em>[=<em>value</em>]] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.3 and
+ [<em>env-variable</em>[=<em>value</em>]] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.3 and
above; the Request_Protocol keyword and environment-variable
- matching are only available with 1.3.7 and later</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">SetEnvIf</code> directive defines environment
+ matching are only available with 1.3.7 and later</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">SetEnvIf</code> directive defines environment
variables based on attributes of the request. These attributes
can be the values of various HTTP request header fields (see <a href="http://www.rfc-editor.org/rfc/rfc2616.txt">RFC2616</a>
for more information about these), or of other aspects of the
request, including the following:</p>
-
-<ul>
-
-<li>
-<code>Remote_Host</code> - the hostname (if available) of
+ <ul>
+ <li><code>Remote_Host</code> - the hostname (if available) of
the client making the request</li>
-
-<li>
-<code>Remote_Addr</code> - the IP address of the client
+ <li><code>Remote_Addr</code> - the IP address of the client
making the request</li>
-
-<li>
-<code>Remote_User</code> - the authenticated username (if
+ <li><code>Remote_User</code> - the authenticated username (if
available)</li>
-
-<li>
-<code>Request_Method</code> - the name of the method
+ <li><code>Request_Method</code> - the name of the method
being used (<code>GET</code>, <code>POST</code>, <em>et
cetera</em>)</li>
-
-<li>
-<code>Request_Protocol</code> - the name and version of
+ <li><code>Request_Protocol</code> - the name and version of
the protocol with which the request was made (<em>e.g.</em>,
"HTTP/0.9", "HTTP/1.1", <em>etc.</em>)</li>
-
-<li>
-<code>Request_URI</code> - the portion of the URL
+ <li><code>Request_URI</code> - the portion of the URL
following the scheme and host portion</li>
+ </ul>
-</ul>
-
-
-<p>Some of the more commonly used request header field names
+ <p>Some of the more commonly used request header field names
include <code>Host</code>, <code>User-Agent</code>, and
<code>Referer</code>.</p>
-
-<p>If the <em>attribute</em> name doesn't match any of the
+ <p>If the <em>attribute</em> name doesn't match any of the
special keywords, nor any of the request's header field names,
it is tested as the name of an environment variable in the list
of those associated with the request. This allows
<code class="directive">SetEnvIf</code> directives to test against the result of
prior matches.</p>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
+<blockquote><table><tr><td bgcolor="#e0e5f5">
<strong>Only those environment variables defined by earlier
<code>SetEnvIf[NoCase]</code> directives are available for
testing in this manner. 'Earlier' means that they were
defined at a broader scope (such as server-wide) or
previously in the current directive's scope.</strong>
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<p>
-<em>attribute</em> may be a regular expression when used to
+ <p><em>attribute</em> may be a regular expression when used to
match a request header. If <em>attribute</em> is a regular
expression and it doesn't match any of the request's header
names, then <em>attribute</em> is not tested against the
request's environment variable list.</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee">
-<p align="center">
-<strong>Example:</strong>
-</p>
-<code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example:</strong></p><code>
SetEnvIf Request_URI "\.gif$" object_is_image=gif<br>
SetEnvIf Request_URI "\.jpg$" object_is_image=jpg<br>
@@ -435,95 +162,33 @@
SetEnvIf object_is_image xbm XBIT_PROCESSING=1<br>
:<br>
SetEnvIf ^TS* ^[a-z].* HAVE_TS<br>
+</code></td></tr></table></blockquote>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-
-<p>The first three will set the environment variable
+ <p>The first three will set the environment variable
<code>object_is_image</code> if the request was for an image
file, and the fourth sets <code>intra_site_referral</code> if
the referring page was somewhere on the
<code>www.mydomain.com</code> Web site.</p>
-
-<p>The last example will set environment variable
+ <p>The last example will set environment variable
<code>HAVE_TS</code> if the request contains any headers that
begin with "TS" whose values begins with any character in the
set [a-z].</p>
+</usage><hr/><h2><a name="SetEnvIfNoCase">SetEnvIfNoCase</a> <a name="setenvifnocase">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets environment variables based on attributes of the request
+without respect to case</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SetEnvIfNoCase <em>attribute regex env-variable</em>[=<em>value</em>]
+ [<em>env-variable</em>[=<em>value</em>]] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.3 and above</td></tr></table></td></tr></table><usage>
-</usage>
-<hr>
-<h2>
-<a name="SetEnvIfNoCase">SetEnvIfNoCase</a> <a name="setenvifnocase">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets environment variables based on attributes of the request
-without respect to case</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>SetEnvIfNoCase <em>attribute regex env-variable</em>[=<em>value</em>]
- [<em>env-variable</em>[=<em>value</em>]] ...</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_setenvif</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.3 and above</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-
-<p>The <code class="directive">SetEnvIfNoCase</code> is semantically identical to
- the <code class="directive"><a href="#setenvif" class="directive">SetEnvIf</a></code> directive,
+ <p>The <code class="directive">SetEnvIfNoCase</code> is semantically identical to
+ the <a href="#setenvif" class="directive"><code class="directive">SetEnvIf</code></a> directive,
and differs only in that the regular expression matching is
performed in a case-insensitive manner. For example:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
SetEnvIfNoCase Host Apache\.Org site=apache
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>This will cause the <code>site</code> environment variable
+ <p>This will cause the <code>site</code> environment variable
to be set to "<code>apache</code>" if the HTTP request header
field <code>Host:</code> was included and contained
<code>Apache.Org</code>, <code>apache.org</code>, or any other
combination.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.13 +29 -96 httpd-2.0/docs/manual/mod/mod_so.html
Index: mod_so.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_so.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -b -u -r1.12 -r1.13
--- mod_so.html 22 Sep 2001 19:36:01 -0000 1.12
+++ mod_so.html 6 Mar 2002 17:08:19 -0000 1.13
@@ -1,40 +1,13 @@
-<!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 module mod_so</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">Module mod_so</h1>
-
- <p>This module provides for loading of executable code and
- modules into the server at start-up or restart time.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base (Windows);
- Optional (Unix)<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a> mod_so.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- so_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.3 and later.</p>
-
- <h2>Summary</h2>
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_so - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_so</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>
+This module provides for loading of executable code and
+modules into the server at start-up or restart time.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base (Windows>; Optional (Unix)</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>so_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3 and later.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>On selected operating systems this module can be used to
- load modules into Apache at runtime via the <a
- href="../dso.html">Dynamic Shared Object</a> (DSO) mechanism,
+ load modules into Apache at runtime via the <a href="../dso.html">Dynamic Shared Object</a> (DSO) mechanism,
rather than requiring a recompilation.</p>
<p>On Unix, the loaded code typically comes from shared object
@@ -52,21 +25,12 @@
<p><strong>Warning: Apache 1.3 modules cannot be directly used
with Apache 2.0 - the module must be modified to dynamically
load or compile into Apache 2.0</strong>.</p>
+</summary><h2>Directives</h2><ul><li><a href="#loadfile">LoadFile</a></li><li><a href="#loadmodule">LoadModule</a></li></ul><h2>Creating Loadable Modules
+for Windows</h2>
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#loadfile">LoadFile</a></li>
-
- <li><a href="#loadmodule">LoadModule</a></li>
- </ul>
-
- <h2><a id="creating" name="creating">Creating Loadable Modules
- for Windows</a></h2>
-
- <p><strong>Note: the module name format changed for Windows
+ <p><blockquote><table><tr><td bgcolor="#e0e5f5">Note: the module name format changed for Windows
with Apache 1.3.15 and 2.0 - the modules are now named as
- mod_foo.so</strong>. While mod_so still loads modules with
+ mod_foo.so</td></tr></table></blockquote>. While mod_so still loads modules with
ApacheModuleFoo.dll names, the new naming convention is
preferred; if you are converting your loadable module for 2.0,
please fix the name to this 2.0 convention.</p>
@@ -87,7 +51,7 @@
<p>The second way is to compile the module as a DLL, a shared
library that can be loaded into the server at runtime, using
- the <code><a href="#loadmodule">LoadModule</a></code>
+ the <code><code class="directive">LoadModule</code></code>
directive. These module DLLs can be distributed and run on any
Apache for Windows installation, without recompilation of the
server.</p>
@@ -98,14 +62,15 @@
add the <code>AP_MODULE_DECLARE_DATA</code> (defined in the
Apache header files) to your module's module record definition.
For example, if your module has:</p>
-<pre>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
module foo_module;
-</pre>
+</code></td></tr></table></blockquote>
<p>Replace the above with:</p>
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
module AP_MODULE_DECLARE_DATA foo_module;
-</pre>
+</code></td></tr></table></blockquote>
<p>Note that this will only be activated on Windows, so the
module can continue to be used, unchanged, with Unix if needed.
@@ -125,61 +90,29 @@
<p>This should create a DLL version of your module. Now simply
place it in the <samp>modules</samp> directory of your server
- root, and use the <code><a
- href="#loadmodule">LoadModule</a></code> directive to load
- it.</p>
- <hr />
+ root, and use the <code class="directive">LoadModule</code>
+ directive to load it.</p>
- <h2><a id="loadfile" name="loadfile">LoadFile</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt LoadFile} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LoadFile
- <em>filename</em> [<em>filename</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_so
+<hr/><h2><a name="LoadFile">LoadFile</a> <a name="loadfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Link in the named object file or library</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LoadFile <em>filename</em> [<em>filename</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base (Windows>; Optional (Unix)</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_so</td></tr></table></td></tr></table><usage>
<p>The LoadFile directive links in the named object files or
libraries when the server is started or restarted; this is used
to load additional code which may be required for some module
to work. <em>Filename</em> is either an absolute path or
relative to <a href="core.html#serverroot">ServerRoot</a>.</p>
- <hr />
-
- <h2><a id="loadmodule" name="loadmodule">LoadModule</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt LoadModule} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LoadModule <em>module
- filename</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_so
-
+</usage><hr/><h2><a name="LoadModule">LoadModule</a> <a name="loadmodule">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Links in the object file or library, and adds to the list
+of active modules</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LoadModule <em>module filename</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base (Windows>; Optional (Unix)</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_so</td></tr></table></td></tr></table><usage>
<p>The LoadModule directive links in the object file or library
<em>filename</em> and adds the module structure named
<em>module</em> to the list of active modules. <em>Module</em>
is the name of the external variable of type
- <code>module</code> in the file, and is listed as the <a
- href="module-dict.html#ModuleIdentifier">Module Identifier</a>
+ <code>module</code> in the file, and is listed as the <a href="module-dict.html#ModuleIdentifier">Module Identifier</a>
in the module documentation. Example:</p>
- <blockquote>
- <code>LoadModule status_module modules/mod_status.so</code>
- </blockquote>
+ <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ LoadModule status_module modules/mod_status.so
+ </code></td></tr></table></blockquote>
<p>loads the named module from the modules subdirectory of the
ServerRoot.</p>
-
- <p><!--#include virtual="footer.html" -->
- </p>
- </body>
-</html>
-
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.13 +15 -75 httpd-2.0/docs/manual/mod/mod_speling.html
Index: mod_speling.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_speling.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -b -u -r1.12 -r1.13
--- mod_speling.html 22 Sep 2001 19:36:01 -0000 1.12
+++ mod_speling.html 6 Mar 2002 17:08:19 -0000 1.13
@@ -1,38 +1,11 @@
-<!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 module mod_speling</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">Module mod_speling</h1>
-
- <p>This module attempts to correct misspellings of URLs that
- users might have entered, by ignoring capitalization and by
- allowing up to one misspelling.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_speling.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- speling_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.3 and later. Available as an External module in Apache
- 1.1 and later.</p>
-
- <h2>Summary</h2>
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_speling - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_speling</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module attempts to correct misspellings of URLs that
+users might have entered, by ignoring capitalization and by
+allowing up to one misspelling.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>speling_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3 and later. Available as
+an External module in Apache 1.1 and later.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>Requests to documents sometimes cannot be served by the core
apache server because the request was misspelled or
@@ -60,43 +33,13 @@
the list of the matches is returned to the client, and the
client can select the correct candidate.</li>
</ul>
- <br />
- <br />
-
-
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#checkspelling">CheckSpelling</a></li>
- </ul>
- <hr />
- <!-- the HR is part of the directive description -->
- <h2><a id="checkspelling"
- name="checkspelling">CheckSpelling</a> directive</h2>
- <!--%plaintext <?INDEX {\tt CheckSpelling} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> CheckSpelling
- on|off<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>CheckSpelling
- Off</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Options <br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_speling<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> CheckSpelling
- was available as a separately available module for Apache 1.1,
- but was limited to miscapitalizations. As of Apache 1.3, it is
- part of the Apache distribution. Prior to Apache 1.3.2, the
- <samp>CheckSpelling</samp> directive was only available in the
- "server" and "virtual host" contexts.
+</summary><h2>Directives</h2><ul><li><a href="#checkspelling">CheckSpelling</a></li></ul><hr/><h2><a name="CheckSpelling">CheckSpelling</a> <a name="checkspelling">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>This directive enables or disables the spelling
+module.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CheckSpelling on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>CheckSpelling Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_speling</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>CheckSpelling was available as a separately available
+module for Apache 1.1, but was limited to miscapitalizations. As
+of Apache 1.3, it is part of the Apache distribution. Prior to Apache
+1.3.2, the CheckSpelling directive was only available in the
+"server" and "virtual host" contexts.</td></tr></table></td></tr></table><usage>
<p>This directive enables or disables the spelling module. When
enabled, keep in mind that</p>
@@ -120,7 +63,4 @@
get incorrectly treated as the negotiated file
"<samp>/stats.html</samp>".</li>
</ul>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
-
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.24 +33 -166 httpd-2.0/docs/manual/mod/mod_status.html
Index: mod_status.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_status.html,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -d -b -u -r1.23 -r1.24
--- mod_status.html 19 Feb 2002 18:37:19 -0000 1.23
+++ mod_status.html 6 Mar 2002 17:08:19 -0000 1.24
@@ -1,159 +1,76 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_status - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_status</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>This module provides information on server activity and
-performance.</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>status_module</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
-<compatibility>Available in Apache 1.1 and later</compatibility>
-</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
+--><title>mod_status - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_status</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides information on server activity and
+performance.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>status_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.1 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
+<blockquote><table><tr><td bgcolor="#e0e5f5">
<strong>Warning:</strong> This document has not been updated
to take into account changes made in the 2.0 version of the
Apache HTTP Server. Some of the information may still be
relevant, but please use it with care.
-</td>
-</tr>
-</table>
-</blockquote>
-
+</td></tr></table></blockquote>
-<p>The Status module allows a server administrator to find out
+ <p>The Status module allows a server administrator to find out
how well their server is performing. A HTML page is presented
that gives the current server statistics in an easily readable
form. If required this page can be made to automatically
refresh (given a compatible browser). Another page gives a
simple machine-readable list of the current server state.</p>
+ <p>The details given are:</p>
-<p>The details given are:</p>
-
-
-<ul>
-
-<li>The number of children serving requests</li>
-
-
-<li>The number of idle children</li>
+ <ul>
+ <li>The number of children serving requests</li>
+ <li>The number of idle children</li>
-<li>The status of each child, the number of requests that
+ <li>The status of each child, the number of requests that
child has performed and the total number of bytes served by
the child (*)</li>
+ <li>A total number of accesses and byte count served (*)</li>
-<li>A total number of accesses and byte count served (*)</li>
-
-
-<li>The time the server was started/restarted and the time it
+ <li>The time the server was started/restarted and the time it
has been running for</li>
-
-<li>Averages giving the number of requests per second, the
+ <li>Averages giving the number of requests per second, the
number of bytes served per second and the average number of
bytes per request (*)</li>
-
-<li>The current percentage CPU used by each child and in
+ <li>The current percentage CPU used by each child and in
total by Apache (*)</li>
-
-<li>The current hosts and requests being processed (*)</li>
-
-</ul>
+ <li>The current hosts and requests being processed (*)</li>
+ </ul>
A compile-time option must be used to display the details
marked "(*)" as the instrumentation required for obtaining
these statistics does not exist within standard Apache.
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#extendedstatus">ExtendedStatus</a>
-</li>
-</ul>
-<h2>Enabling Status Support</h2>
+</summary><h2>Directives</h2><ul><li><a href="#extendedstatus">ExtendedStatus</a></li></ul><h2>Enabling Status Support</h2>
To enable status reports only for browsers from the foo.com
domain add this code to your <code>httpd.conf</code>
configuration file
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Location /server-status><br>
SetHandler server-status<br>
-
<br>
Order Deny,Allow<br>
Deny from all<br>
Allow from .foo.com<br>
</Location>
-</code></td>
-</tr>
-</table>
-</blockquote>
-
+</code></td></tr></table></blockquote>
-<p>You can now access server statistics by using a Web browser
+ <p>You can now access server statistics by using a Web browser
to access the page
- <code>http://your.server.name/server-status</code>
-</p>
-
+ <code>http://your.server.name/server-status</code></p>
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p>Note that <code><a href="mod_status.html">mod_status</a></code> will only work
+ <blockquote><table><tr><td bgcolor="#e0e5f5"><p>Note that <code><a href="mod_status.html">mod_status</a></code> will only work
when you are running Apache in <a href="core.html#servertype">standalone</a> mode and not
- <a href="core.html#servertype">inetd</a> mode.</p>
-</td>
-</tr>
-</table>
-</blockquote>
-
+ <a href="core.html#servertype">inetd</a> mode.</p></td></tr></table></blockquote>
<h2>Automatic Updates</h2>
@@ -172,69 +89,19 @@
<code>/support</code> directory of Apache,
<code>log_server_status</code>.
- <blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
+ <blockquote><table><tr><td bgcolor="#e0e5f5">
<strong>It should be noted that if <code><a href="mod_status.html">mod_status</a></code> is
compiled into the server, its handler capability is available
in <em>all</em> configuration files, including
<em>per</em>-directory files (<em>e.g.</em>,
<code>.htaccess</code>). This may have security-related
ramifications for your site.</strong>
- </td>
-</tr>
-</table>
-</blockquote>
-
+ </td></tr></table></blockquote>
-<hr>
-<h2>
-<a name="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>This directive controls whether the server keeps track of
+<hr/><h2><a name="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>This directive controls whether the server keeps track of
extended status information for each request. This is only
-useful if the status module is enabled on the server.</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ExtendedStatus On|Off</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ExtendedStatus Off</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_status</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>ExtendedStatus is only available in Apache 1.3.2 and
-later.</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This setting applies to the entire server, and cannot be
+useful if the status module is enabled on the server.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ExtendedStatus On|Off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ExtendedStatus Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_status</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>ExtendedStatus is only available in Apache 1.3.2 and
+later.</td></tr></table></td></tr></table><usage>
+ <p>This setting applies to the entire server, and cannot be
enabled or disabled on a virtualhost-by-virtualhost basis.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.4 +8 -99 httpd-2.0/docs/manual/mod/mod_suexec.html
Index: mod_suexec.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_suexec.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -b -u -r1.3 -r1.4
--- mod_suexec.html 19 Feb 2002 18:37:19 -0000 1.3
+++ mod_suexec.html 6 Mar 2002 17:08:19 -0000 1.4
@@ -1,107 +1,16 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_suexec - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_suexec</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>This module allows CGI scripts to run as a specified user
-and Group.</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>suexec_module</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
-<compatibility>Available in Apache 2.0 and later</compatibility>
-</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>This module allows CGI scripts to run as a specified user
+--><title>mod_suexec - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_suexec</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module allows CGI scripts to run as a specified user
+and Group.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>suexec_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 2.0 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This module allows CGI scripts to run as a specified user
and Group.</p>
-
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#suexecusergroup">SuexecUserGroup</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="SuexecUserGroup">SuexecUserGroup</a> <a name="suexecusergroup">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>SuexecUserGroup <em>User Group</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_suexec</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>SuexecUserGroup is only available in 2.0 and
-later.</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">SuexecUserGroup</code> directive allows you to
+</summary><h2>Directives</h2><ul><li><a href="#suexecusergroup">SuexecUserGroup</a></li></ul><hr/><h2><a name="SuexecUserGroup">SuexecUserGroup</a> <a name="suexecusergroup">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SuexecUserGroup <em>User Group</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_suexec</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>SuexecUserGroup is only available in 2.0 and
+later.</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">SuexecUserGroup</code> directive allows you to
specify a user and group for CGI programs to run as. Non-CGI
requests are still processes with the user specified in the
User directive. This directive replaces using the User and
Group directives inside of VirtualHosts.</p>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.10 +24 -91 httpd-2.0/docs/manual/mod/mod_unique_id.html
Index: mod_unique_id.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_unique_id.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -b -u -r1.9 -r1.10
--- mod_unique_id.html 19 Feb 2002 18:37:19 -0000 1.9
+++ mod_unique_id.html 6 Mar 2002 17:08:19 -0000 1.10
@@ -1,50 +1,11 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_unique_id - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_unique_id</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>This module provides an environment variable with a unique
-identifier for each request.</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>unique_id_module</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
-<compatibility>Available in Apache 1.3 and later.</compatibility>
-</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
+--><title>mod_unique_id - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_unique_id</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides an environment variable with a unique
+identifier for each request.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>unique_id_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3 and later.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
-<p>This module provides a magic token for each request which is
+ <p>This module provides a magic token for each request which is
guaranteed to be unique across "all" requests under very
specific conditions. The unique identifier is even unique
across multiple machines in a properly configured cluster of
@@ -52,15 +13,10 @@
set to the identifier for each request. Unique identifiers are
useful for various reasons which are beyond the scope of this
document.</p>
-
-</summary>
-<h2>Directives</h2>
-<p>This module provides no directives.</p>
-<h2>Theory</h2>
-
+</summary><h2>Directives</h2><p>This module provides no directives.</p><h2>Theory</h2>
-<p>First a brief recap of how the Apache server works on Unix
+ <p>First a brief recap of how the Apache server works on Unix
machines. This feature currently isn't supported on Windows NT.
On Unix machines, Apache creates several children, the children
process requests one at a time. Each child can serve multiple
@@ -68,8 +24,7 @@
the children don't share any data with each other. We'll refer
to the children as httpd processes.</p>
-
-<p>Your website has one or more machines under your
+ <p>Your website has one or more machines under your
administrative control, together we'll call them a cluster of
machines. Each machine can possibly run multiple instances of
Apache. All of these collectively are considered "the
@@ -78,40 +33,32 @@
without extensive communication between machines in the
cluster.</p>
-
-<p>The machines in your cluster should satisfy these
+ <p>The machines in your cluster should satisfy these
requirements. (Even if you have only one machine you should
synchronize its clock with NTP.)</p>
-
-<ul>
-
-<li>The machines' times are synchronized via NTP or other
+ <ul>
+ <li>The machines' times are synchronized via NTP or other
network time protocol.</li>
-
-<li>The machines' hostnames all differ, such that the module
+ <li>The machines' hostnames all differ, such that the module
can do a hostname lookup on the hostname and receive a
different IP address for each machine in the cluster.</li>
+ </ul>
-</ul>
-
-
-<p>As far as operating system assumptions go, we assume that
+ <p>As far as operating system assumptions go, we assume that
pids (process ids) fit in 32-bits. If the operating system uses
more than 32-bits for a pid, the fix is trivial but must be
performed in the code.</p>
-
-<p>Given those assumptions, at a single point in time we can
+ <p>Given those assumptions, at a single point in time we can
identify any httpd process on any machine in the cluster from
all other httpd processes. The machine's IP address and the pid
of the httpd process are sufficient to do this. So in order to
generate unique identifiers for requests we need only
distinguish between different points in time.</p>
-
-<p>To distinguish time we will use a Unix timestamp (seconds
+ <p>To distinguish time we will use a Unix timestamp (seconds
since January 1, 1970 UTC), and a 16-bit counter. The timestamp
has only one second granularity, so the counter is used to
represent up to 65536 values during a single second. The
@@ -120,8 +67,7 @@
process. There are issues however with pid reuse over time, and
the counter is used to alleviate this issue.</p>
-
-<p>When an httpd child is created, the counter is initialized
+ <p>When an httpd child is created, the counter is initialized
with ( current microseconds divided by 10 ) modulo 65536 (this
formula was chosen to eliminate some variance problems with the
low order bits of the microsecond timers on some systems). When
@@ -130,8 +76,7 @@
incremented every time an identifier is generated (and allowed
to roll over).</p>
-
-<p>The kernel generates a pid for each process as it forks the
+ <p>The kernel generates a pid for each process as it forks the
process, and pids are allowed to roll over (they're 16-bits on
many Unixes, but newer systems have expanded to 32-bits). So
over time the same pid will be reused. However unless it is
@@ -141,8 +86,7 @@
be 32768 processes on some Unixes, but even this isn't likely
to happen).</p>
-
-<p>Suppose that time repeats itself for some reason. That is,
+ <p>Suppose that time repeats itself for some reason. That is,
suppose that the system's clock is screwed up and it revisits a
past time (or it is too far forward, is reset correctly, and
then revisits the future time). In this case we can easily show
@@ -155,8 +99,7 @@
time, at least at one second resolution, has repeated itself).
This is not a perfect defense.</p>
-
-<p>How good a defense is it? Suppose that one of your machines
+ <p>How good a defense is it? Suppose that one of your machines
serves at most 500 requests per second (which is a very
reasonable upper bound at this writing, because systems
generally do more than just shovel out static files). To do
@@ -172,8 +115,7 @@
such that it's still likely to occur, then perhaps you should
make the counter 32 bits (by editing the code).</p>
-
-<p>You may be concerned about the clock being "set back" during
+ <p>You may be concerned about the clock being "set back" during
summer daylight savings. However this isn't an issue because
the times used here are UTC, which "always" go forward. Note
that x86 based Unixes may need proper configuration for this to
@@ -182,8 +124,7 @@
even still, if you're running NTP then your UTC time will be
correct very shortly after reboot.</p>
-
-<p>The <code>UNIQUE_ID</code> environment variable is
+ <p>The <code>UNIQUE_ID</code> environment variable is
constructed by encoding the 112-bit (32-bit IP address, 32 bit
pid, 32 bit time stamp, 16 bit counter) quadruple using the
alphabet <code>[A-Za-z0-9@-]</code> in a manner similar to MIME
@@ -201,8 +142,7 @@
compared against other <code>UNIQUE_ID</code>s for equality
only.</p>
-
-<p>The ordering was chosen such that it's possible to change
+ <p>The ordering was chosen such that it's possible to change
the encoding in the future without worrying about collision
with an existing database of <code>UNIQUE_ID</code>s. The new
encodings should also keep the time stamp as the first element,
@@ -213,8 +153,7 @@
encoding format. Afterwards they can resume requests and begin
issuing the new encodings.</p>
-
-<p>This we believe is a relatively portable solution to this
+ <p>This we believe is a relatively portable solution to this
problem. It can be extended to multithreaded systems like
Windows NT, and can grow with future needs. The identifiers
generated have essentially an infinite life-time because future
@@ -227,10 +166,4 @@
shortened, but more information needs to be assumed (for
example the 32-bit IP address is overkill for any site, but
there is no portable shorter replacement for it). </p>
-
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+<hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.19 +49 -159 httpd-2.0/docs/manual/mod/mod_userdir.html
Index: mod_userdir.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_userdir.html,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -b -u -r1.18 -r1.19
--- mod_userdir.html 19 Feb 2002 18:37:19 -0000 1.18
+++ mod_userdir.html 6 Mar 2002 17:08:19 -0000 1.19
@@ -1,132 +1,47 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mod_userdir - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mod_userdir</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>This module provides for user-specific
-directories.</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>userdir_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-</summary>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#userdir">UserDir</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="UserDir">UserDir</a> <a name="userdir">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the directory from which to serve files when requests
+--><title>mod_userdir - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_userdir</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides for user-specific
+directories.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>userdir_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+</summary><h2>Directives</h2><ul><li><a href="#userdir">UserDir</a></li></ul><hr/><h2><a name="UserDir">UserDir</a> <a name="userdir">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the directory from which to serve files when requests
for a particular user are received, denoted by requests containing
~username, such as
-http://server.example.com/~bob/</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>UserDir <em>directory-filename</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>UserDir public_html</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
-host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_userdir</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>All forms except the UserDir public_html
+http://server.example.com/~bob/</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>UserDir <em>directory-filename</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>UserDir public_html</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
+host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_userdir</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>All forms except the UserDir public_html
form are only available in Apache 1.1 or above. Use of the
enabled keyword, or disabled with a
list of usernames, is only available in Apache 1.3 and
-above.</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
+above.</td></tr></table></td></tr></table><usage>
-<p>The <code class="directive">UserDir</code> directive sets the real
+ <p>The <code class="directive">UserDir</code> directive sets the real
directory in a user's home directory to use when a request for a
document for a user is received. <em>Directory-filename</em> is
one of the following:</p>
-
-<ul>
-
-<li>The name of a directory or a pattern such as those shown
+ <ul>
+ <li>The name of a directory or a pattern such as those shown
below.</li>
-
-<li>The keyword <code>disabled</code>. This turns off
+ <li>The keyword <code>disabled</code>. This turns off
<em>all</em> username-to-directory translations except those
explicitly named with the <code>enabled</code> keyword (see
below).</li>
-
-<li>The keyword <code>disabled</code> followed by a
+ <li>The keyword <code>disabled</code> followed by a
space-delimited list of usernames. Usernames that appear in
such a list will <em>never</em> have directory translation
performed, even if they appear in an <code>enabled</code>
clause.</li>
-
-<li>The keyword <code>enabled</code> followed by a
+ <li>The keyword <code>enabled</code> followed by a
space-delimited list of usernames. These usernames will have
directory translation performed even if a global disable is
in effect, but not if they also appear in a
<code>disabled</code> clause.</li>
+ </ul>
-</ul>
-
-
-<p>If neither the <code>enabled</code> nor the
+ <p>If neither the <code>enabled</code> nor the
<code>disabled</code> keywords appear in the
<code>Userdir</code> directive, the argument is treated as a
filename pattern, and is used to turn the name into a directory
@@ -134,79 +49,54 @@
<code>http://www.foo.com/~bob/one/two.html</code> will be
translated to:</p>
-
<table>
-
-<tr>
-<th>UserDir directive used</th>
-<th>Translated path</th>
-</tr>
-
-<tr>
-<td>UserDir public_html</td><td>~bob/public_html/one/two.html</td>
-</tr>
-
-<tr>
-<td>UserDir /usr/web</td><td>/usr/web/bob/one/two.html</td>
-</tr>
-
-<tr>
-<td>UserDir /home/*/www</td><td>/home/bob/www/one/two.html</td>
-</tr>
-
+<tr><th>UserDir directive used</th>
+<th>Translated path</th></tr>
+<tr><td>UserDir public_html</td><td>~bob/public_html/one/two.html</td></tr>
+<tr><td>UserDir /usr/web</td><td>/usr/web/bob/one/two.html</td></tr>
+<tr><td>UserDir /home/*/www</td><td>/home/bob/www/one/two.html</td></tr>
</table>
-
-<p>The following directives will send redirects to the client:</p>
-
+ <p>The following directives will send redirects to the client:</p>
<table>
-
-<tr>
-<th>UserDir directive used</th>
-<th>Translated path</th>
-</tr>
-
-<tr>
-<td>UserDir http://www.foo.com/users</td><td>http://www.foo.com/users/bob/one/two.html</td>
-</tr>
-
-<tr>
-<td>UserDir
-http://www.foo.com/*/usr</td><td>http://www.foo.com/bob/usr/one/two.html</td>
-</tr>
-
-<tr>
-<td>UserDir
-http://www.foo.com/~*/</td><td>http://www.foo.com/~bob/one/two.html</td>
-</tr>
-
+<tr><th>UserDir directive used</th>
+<th>Translated path</th></tr>
+<tr><td>UserDir http://www.foo.com/users</td><td>http://www.foo.com/users/bob/one/two.html</td></tr>
+<tr><td>UserDir
+http://www.foo.com/*/usr</td><td>http://www.foo.com/bob/usr/one/two.html</td></tr>
+<tr><td>UserDir
+http://www.foo.com/~*/</td><td>http://www.foo.com/~bob/one/two.html</td></tr>
</table>
-
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
+<blockquote><table><tr><td bgcolor="#e0e5f5">
<strong>Be careful when using this directive; for instance,
<code>"UserDir ./"</code> would map
<code>"/~root"</code> to <code>"/"</code> - which is probably
undesirable. If you are running Apache 1.3 or above, it is
strongly recommended that your configuration include a
"<code>UserDir disabled root</code>" declaration.
- See also the <code class="directive"><a href="core.html#directory" class="directive">Directory</a></code>
+ See also the <a href="core.html#directory" class="directive"><code class="directive">Directory</code></a>
directive and the <a href="../misc/security_tips.html">Security
Tips</a> page for more information.</strong>
-</td>
-</tr>
-</table>
-</blockquote>
+</td></tr></table></blockquote>
+<p>Additional examples:</p>
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+<p>To allow a few users to have <code>UserDir</code> directories, but
+not anyone else, use the following:</p>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+UserDir disabled<br>
+UserDir enabled user1 user2 user3
+</code></td></tr></table></blockquote>
+
+<p>To allow most users to have <code>UserDir</code> directories, but
+deny this to a few, use the following:</p>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+UserDir enabled<br>
+UserDir disabled user4 user5 user6
+</code></td></tr></table></blockquote>
+
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.11 +114 -245 httpd-2.0/docs/manual/mod/mod_vhost_alias.html
Index: mod_vhost_alias.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_vhost_alias.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -b -u -r1.10 -r1.11
--- mod_vhost_alias.html 16 Jan 2002 19:12:34 -0000 1.10
+++ mod_vhost_alias.html 6 Mar 2002 17:08:19 -0000 1.11
@@ -1,37 +1,9 @@
-<!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 module mod_vhost_alias</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">Module mod_vhost_alias</h1>
-
- <p>This module provides support for <a
- href="../vhosts/mass.html">dynamically configured mass virtual
- hosting</a>.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_vhost_alias.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- vhost_alias_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.3.7 and later.</p>
-
- <h2>Summary</h2>
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_vhost_alias - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_vhost_alias</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides support for <a href="../vhosts/mass.html">dynamically configured mass virtual
+hosting</a>.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>vhost_alias_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3.7 and later.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This module creates dynamically configured virtual hosts, by
allowing the IP address and/or the <code>Host:</code> header of
@@ -39,51 +11,31 @@
determine what files to serve. This allows for easy use of a
huge number of virtual hosts with similar configurations.</p>
- <h2>Directives</h2>
-
- <ul>
- <li><a
- href="#virtualdocumentroot">VirtualDocumentRoot</a></li>
-
- <li><a
- href="#virtualdocumentrootip">VirtualDocumentRootIP</a></li>
-
- <li><a href="#virtualscriptalias">VirtualScriptAlias</a></li>
-
- <li><a
- href="#virtualscriptaliasip">VirtualScriptAliasIP</a></li>
- </ul>
+ <seealso>See also: <a href="core.html#usecanonicalname" class="directive"><code class="directive">UseCanonicalName</code></a>.</seealso>
- <p>See also: <a
- href="core.html#usecanonicalname">UseCanonicalName</a>.</p>
+</summary><h2>Directives</h2><ul><li><a href="#virtualdocumentroot">VirtualDocumentRoot</a></li><li><a href="#virtualdocumentrootip">VirtualDocumentRootIP</a></li><li><a href="#virtualscriptalias">VirtualScriptAlias</a></li><li><a href="#virtualscriptaliasip">VirtualScriptAliasIP</a></li></ul><h2>Directory Name Interpolation</h2>
- <h2>Directory Name Interpolation</h2>
<p>All the directives in this module interpolate a string into
a pathname. The interpolated string (henceforth called the
- "name") may be either the server name (see the <a
- href="core.html#usecanonicalname"><code>UseCanonicalName</code></a>
+ "name") may be either the server name (see the <a href="core.html#usecanonicalname"><code>UseCanonicalName</code></a>
directive for details on how this is determined) or the IP
address of the virtual host on the server in dotted-quad
format. The interpolation is controlled by specifiers inspired
by <code>printf</code> which have a number of formats:</p>
- <dl>
- <dt><code>%%</code></dt>
-
- <dd>insert a <code>%</code></dd>
-
- <dt><code>%p</code></dt>
+<table>
- <dd>insert the port number of the virtual host</dd>
+<tr><td><code>%%</code></td>
+<td>insert a <code>%</code></td></tr>
- <dt><code>%N.M</code></dt>
+<tr><td><code>%p</code></td>
+<td>insert the port number of the virtual host</td></tr>
- <dd>insert (part of) the name</dd>
- </dl>
- <br />
- <br />
+<tr><td><code>%N.M</code></td>
+<td>insert (part of) the name</td></tr>
+</table>
<p><code>N</code> and <code>M</code> are used to specify
substrings of the name. <code>N</code> selects from the
@@ -93,97 +45,96 @@
present; the dot must be present if and only if <code>M</code>
is present. The interpretation is as follows:</p>
- <dl>
- <dt><code>0</code></dt>
-
- <dd>the whole name</dd>
-
- <dt><code>1</code></dt>
-
- <dd>the first part</dd>
-
- <dt><code>2</code></dt>
-
- <dd>the second part</dd>
-
- <dt><code>-1</code></dt>
+ <table>
+ <tr><td><code>0</code></td>
+ <td>the whole name</td></tr>
- <dd>the last part</dd>
+ <tr><td><code>1</code></td>
+ <td>the first part</td></tr>
- <dt><code>-2</code></dt>
+ <tr><td><code>2</code></td>
+ <td>the second part</td></tr>
- <dd>the penultimate part</dd>
+ <tr><td><code>-1</code></td>
+ <td>the last part</td></tr>
- <dt><code>2+</code></dt>
+ <tr><td><code>-2</code></td>
+ <td>the penultimate part</td></tr>
- <dd>the second and all subsequent parts</dd>
+ <tr><td><code>2+</code></td>
+ <td>the second and all subsequent parts</td></tr>
- <dt><code>-2+</code></dt>
+ <tr><td><code>-2+</code></td>
+ <td>the penultimate and all preceding parts</td></tr>
- <dd>the penultimate and all preceding parts</dd>
+ <tr><td><code>1+</code> and <code>-1+</code></td>
+ <td>the same as <code>0</code></td></tr>
+ </table>
- <dt><code>1+</code> and <code>-1+</code></dt>
+ <p>If <code>N</code> or <code>M</code> is greater than the number
+ of parts available a single underscore is interpolated. </p>
- <dd>the same as <code>0</code></dd>
- </dl>
- If <code>N</code> or <code>M</code> is greater than the number
- of parts available a single underscore is interpolated. <br />
- <br />
+<h2>Examples</h2>
- <h3>Examples</h3>
-
<p>For simple name-based virtual hosts you might use the
following directives in your server configuration file:</p>
-<pre>
- UseCanonicalName Off
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ UseCanonicalName Off<br>
VirtualDocumentRoot /usr/local/apache/vhosts/%0
-</pre>
- A request for
+</code></td></tr></table></blockquote>
+
+ <p>A request for
<code>http://www.example.com/directory/file.html</code> will be
satisfied by the file
<code>/usr/local/apache/vhosts/www.example.com/directory/file.html</code>.
- <br />
- <br />
-
+ </p>
<p>For a very large number of virtual hosts it is a good idea
to arrange the files to reduce the size of the
<code>vhosts</code> directory. To do this you might use the
following in your configuration file:</p>
-<pre>
- UseCanonicalName Off
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ UseCanonicalName Off<br>
VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2
-</pre>
- A request for
+</code></td></tr></table></blockquote>
+
+ <p>A request for
<code>http://www.example.isp.com/directory/file.html</code>
will be satisfied by the file
- <code>/usr/local/apache/vhosts/isp.com/e/x/a/example/directory/file.html</code>.
- A more even spread of files can be achieved by hashing from the
- end of the name, for example:
-<pre>
+ <code>/usr/local/apache/vhosts/isp.com/e/x/a/example/directory/file.html</code>.</p>
+
+ <p>A more even spread of files can be achieved by hashing from the
+ end of the name, for example: </p>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.-1/%2.-2/%2.-3/%2
-</pre>
- The example request would come from
- <code>/usr/local/apache/vhosts/isp.com/e/l/p/example/directory/file.html</code>.
- Alternatively you might use:
-<pre>
+</code></td></tr></table></blockquote>
+
+ <p>The example request would come from
+ <code>/usr/local/apache/vhosts/isp.com/e/l/p/example/directory/file.html</code>.</p>
+
+ <p>Alternatively you might use: </p>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2.4+
-</pre>
- The example request would come from
- <code>/usr/local/apache/vhosts/isp.com/e/x/a/mple/directory/file.html</code>.
- <br />
- <br />
+</code></td></tr></table></blockquote>
+ <p>The example request would come from
+ <code>/usr/local/apache/vhosts/isp.com/e/x/a/mple/directory/file.html</code>.</p>
<p>For IP-based virtual hosting you might use the following in
your configuration file:</p>
-<pre>
- UseCanonicalName DNS
- VirtualDocumentRootIP /usr/local/apache/vhosts/%1/%2/%3/%4/docs
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ UseCanonicalName DNS<br>
+ VirtualDocumentRootIP /usr/local/apache/vhosts/%1/%2/%3/%4/docs<br>
VirtualScriptAliasIP /usr/local/apache/vhosts/%1/%2/%3/%4/cgi-bin
-</pre>
- A request for
+</code></td></tr></table></blockquote>
+
+ <p>A request for
<code>http://www.example.isp.com/directory/file.html</code>
would be satisfied by the file
<code>/usr/local/apache/vhosts/10/20/30/40/docs/directory/file.html</code>
@@ -191,147 +142,65 @@
10.20.30.40. A request for
<code>http://www.example.isp.com/cgi-bin/script.pl</code> would
be satisfied by executing the program
- <code>/usr/local/apache/vhosts/10/20/30/40/cgi-bin/script.pl</code>.
- <br />
- <br />
-
+ <code>/usr/local/apache/vhosts/10/20/30/40/cgi-bin/script.pl</code>.</p>
<p>If you want to include the <code>.</code> character in a
<code>VirtualDocumentRoot</code> directive, but it clashes with
a <code>%</code> directive, you can work around the problem in
the following way:</p>
-<pre>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
VirtualDocumentRoot /usr/local/apache/vhosts/%2.0.%3.0
-</pre>
- A request for
+</code></td></tr></table></blockquote>
+
+ <p>A request for
<code>http://www.example.isp.com/directory/file.html</code>
will be satisfied by the file
- <code>/usr/local/apache/vhosts/example.isp/directory/file.html</code>.
- <br />
- <br />
-
+ <code>/usr/local/apache/vhosts/example.isp/directory/file.html</code>.</p>
- <p>The <a href="mod_log_config.html#formats">LogFormat
- directives</a> <code>%V</code> and <code>%A</code> are useful
+ <p>The <a href="mod_log_config.html#logformat" class="directive"><code class="directive">LogFormat</code></a>
+ directives <code>%V</code> and <code>%A</code> are useful
in conjunction with this module.</p>
- <hr />
-
- <h2><a id="virtualdocumentroot"
- name="virtualdocumentroot">VirtualDocumentRoot
- directive</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> VirtualDocumentRoot
- <em>interpolated-directory</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> None<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_vhost_alias<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- VirtualDocumentRoot is only available in 1.3.7 and later.</p>
+<hr/><h2><a name="VirtualDocumentRoot">VirtualDocumentRoot</a> <a name="virtualdocumentroot">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the document root
+for a given virtual host.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualDocumentRoot <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualDocumentRoot is only available in 1.3.7 and
+later.</td></tr></table></td></tr></table><usage>
<p>The <code>VirtualDocumentRoot</code> directive allows you to
determine where Apache will find your documents based on the
value of the server name. The result of expanding
<em>interpolated-directory</em> is used as the root of the
- document tree in a similar manner to the <a
- href="core.html#documentroot"><code>DocumentRoot</code></a>
- directive's argument. If <em>interpolated-directory</em> is
- <code>none</code> then <code>VirtaulDocumentRoot</code> is
- turned off. This directive cannot be used in the same context
- as <a
- href="#virtualdocumentrootip"><code>VirtualDocumentRootIP</code></a>.</p>
- <hr />
-
- <h2><a id="virtualdocumentrootip"
- name="virtualdocumentrootip">VirtualDocumentRootIP
- directive</a></h2>
+ document tree in a similar manner to the <a href="core.html#documentroot" class="directive"><code class="directive">DocumentRoot</code></a> directive's argument.
+ If <em>interpolated-directory</em> is <code>none</code> then
+ <code>VirtaulDocumentRoot</code> is turned off. This directive
+ cannot be used in the same context as
+ <code class="directive">VirtualDocumentRootIP</code>.</p>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> VirtualDocumentRootIP
- <em>interpolated-directory</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> None<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_vhost_alias<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- VirtualDocumentRootIP is only available in 1.3.7 and later.</p>
+</usage><hr/><h2><a name="VirtualDocumentRootIP">VirtualDocumentRootIP</a> <a name="virtualdocumentrootip">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the document root
+for a given virtual host</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualDocumentRootIP <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualDocumentRootIP is only available in 1.3.7
+and later.</td></tr></table></td></tr></table><usage>
- <p>The <code>VirtualDocumentRootIP</code> directive is like the
- <a
- href="#virtualdocumentroot"><code>VirtualDocumentRoot</code></a>
+<p>The <code>VirtualDocumentRootIP</code> directive is like the
+ <code class="directive">VirtualDocumentRoot</code>
directive, except that it uses the IP address of the server end
of the connection instead of the server name.</p>
- <hr />
-
- <h2><a id="virtualscriptalias"
- name="virtualscriptalias">VirtualScriptAlias directive</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> VirtualScriptAlias
- <em>interpolated-directory</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> None<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_vhost_alias<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- VirtualScriptAlias is only available in 1.3.7 and later.</p>
+</usage><hr/><h2><a name="VirtualScriptAlias">VirtualScriptAlias</a> <a name="virtualscriptalias">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the CGI directory for
+a given virtual host.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualScriptAlias <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualScriptAlias is only available in 1.3.7
+and later.</td></tr></table></td></tr></table><usage>
<p>The <code>VirtualScriptAlias</code> directive allows you to
determine where Apache will find CGI scripts in a similar
- manner to <a
- href="#virtualdocumentroot"><code>VirtualDocumentRoot</code></a>
+ manner to <code class="directive">VirtualDocumentRoot</code>
does for other documents. It matches requests for URIs starting
- <code>/cgi-bin/</code>, much like <code><a
- href="mod_alias.html#scriptalias">ScriptAlias</a>
- /cgi-bin/</code> would.</p>
- <hr />
-
- <h2><a id="virtualscriptaliasip"
- name="virtualscriptaliasip">VirtualScriptAliasIP
- directive</a></h2>
+ <code>/cgi-bin/</code>, much like <a href="mod_alias.html#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a>
+ <code>/cgi-bin/</code> would.</p>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> VirtualScriptAliasIP
- <em>interpolated-directory</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> None<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_vhost_alias<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- VirtualScriptAliasIP is only available in 1.3.7 and later.</p>
+</usage><hr/><h2><a name="VirtualScriptAliasIP">VirtualScriptAliasIP</a> <a name="virtualscriptaliasip">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the cgi directory for
+a given virtual host.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualScriptAliasIP <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualScriptAliasIP is only available in 1.3.7
+and later.</td></tr></table></td></tr></table><usage>
<p>The <code>VirtualScriptAliasIP</code> directive is like the
- <a
- href="#virtualscriptalias"><code>VirtualScriptAlias</code></a>
+ <a href="#virtualscriptalias"><code>VirtualScriptAlias</code></a>
directive, except that it uses the IP address of the server end
of the connection instead of the server name.</p>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
-
+ </usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.21 +137 -1076 httpd-2.0/docs/manual/mod/mpm_common.html
Index: mpm_common.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mpm_common.html,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -d -b -u -r1.20 -r1.21
--- mpm_common.html 26 Feb 2002 19:02:35 -0000 1.20
+++ mpm_common.html 6 Mar 2002 17:08:19 -0000 1.21
@@ -1,409 +1,99 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>mpm_common - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module mpm_common</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>A collection of directives that are implemented by
-more than one multi-processing module (MPM)</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#coredumpdirectory">CoreDumpDirectory</a>
-</li>
-<li>
-<a href="#group">Group</a>
-</li>
-<li>
-<a href="#listen">Listen</a>
-</li>
-<li>
-<a href="#listenbacklog">ListenBackLog</a>
-</li>
-<li>
-<a href="#lockfile">LockFile</a>
-</li>
-<li>
-<a href="#maxclients">MaxClients</a>
-</li>
-<li>
-<a href="#maxrequestperchild">MaxRequestPerChild</a>
-</li>
-<li>
-<a href="#maxsparethreads">MaxSpareThreads</a>
-</li>
-<li>
-<a href="#maxthreadsperchild">MaxThreadsPerChild</a>
-</li>
-<li>
-<a href="#minsparethreads">MinSpareThreads</a>
-</li>
-<li>
-<a href="#numservers">NumServers</a>
-</li>
-<li>
-<a href="#pidfile">PidFile</a>
-</li>
-<li>
-<a href="#scoreboardfile">ScoreBoardFile</a>
-</li>
-<li>
-<a href="#sendbuffersize">SendBufferSize</a>
-</li>
-<li>
-<a href="#serverlimit">ServerLimit</a>
-</li>
-<li>
-<a href="#startservers">StartServers</a>
-</li>
-<li>
-<a href="#startthreads">StartThreads</a>
-</li>
-<li>
-<a href="#threadlimit">ThreadLimit</a>
-</li>
-<li>
-<a href="#threadsperchild">ThreadsPerChild</a>
-</li>
-<li>
-<a href="#user">User</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="CoreDumpDirectory">CoreDumpDirectory</a> <a name="coredumpdirectory">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the directory where Apache attempts to
-switch before dumping core</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>CoreDumpDirectory <em>directory</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>CoreDumpDirectory ServerRoot</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
+--><title>mpm_common - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mpm_common</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>A collection of directives that are implemented by
+more than one multi-processing module (MPM)</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr></table></td></tr></table><h2>Directives</h2><ul><li><a href="#coredumpdirectory">CoreDumpDirectory</a></li><li><a href="#group">Group</a></li><li><a href="#listen">Listen</a></li><li><a href="#listenbacklog">ListenBackLog</a></li><li><a href="#lockfile">LockFile</a></li><li><a href="#maxclients">MaxClients</a></li><li><a href="#maxrequestsperchild">MaxRequestsPerChild</a></li><li><a href="#maxsparethreads">MaxSpareThreads</a></li><li><a href="#maxthreadsperchild">MaxThreadsPerChild</a></li><li><a href="#minsparethreads">MinSpareThreads</a></li><li><a href="#numservers">NumServers</a></li><li><a href="#pidfile">PidFile</a></li><li><a href="#scoreboardfile">ScoreBoardFile</a></li><li><a href="#sendbuffersize">SendBufferSize</a></li><li><a href="#serverlimit">ServerLimit</a></li><li><a href="#startservers">StartServers</a></li><li><a href="#startthreads">StartThreads</a></li><li><a href="#threadlimit">ThreadLimit</a></li><li><a href="#threadsperchild">ThreadsPerChild</a></li><li><a href="#user">User</a></li></ul><hr/><h2><a name="CoreDumpDirectory">CoreDumpDirectory</a> <a name="coredumpdirectory">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the directory where Apache attempts to
+switch before dumping core</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CoreDumpDirectory <em>directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>CoreDumpDirectory ServerRoot</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td></tr></table></td></tr></table><usage>
-<p>This controls the directory to which Apache attempts to
+ <p>This controls the directory to which Apache attempts to
switch before dumping core. The default is in the
- <code class="directive"><a href="core.html#serverroot" class="directive">ServerRoot</a></code> directory, however
+ <a href="core.html#serverroot" class="directive"><code class="directive">ServerRoot</code></a> directory, however
since this should not be writable by the user the server runs
as, core dumps won't normally get written. If you want a core
dump for debugging, you can use this directive to place it in a
different location.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Group">Group</a> <a name="group">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the group under which the server will answer
-requests</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Group <em>unix-group</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Group #-1</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">Group</code> directive sets the group under
+</usage><hr/><h2><a name="Group">Group</a> <a name="group">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the group under which the server will answer
+requests</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Group <em>unix-group</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Group #-1</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">Group</code> directive sets the group under
which the server will answer requests. In order to use this
directive, the stand-alone server must be run initially as root.
<em>Unix-group</em> is one of:</p>
+ <dl>
+ <dt>A group name</dt>
-<dl>
-
-<dt>A group name</dt>
-
-
-<dd>Refers to the given group by name.</dd>
-
-
-<dt># followed by a group number.</dt>
-
-
-<dd>Refers to a group by its number.</dd>
+ <dd>Refers to the given group by name.</dd>
-</dl>
+ <dt># followed by a group number.</dt>
-<p>It is recommended that you set up a new group specifically for
+ <dd>Refers to a group by its number.</dd>
+ </dl>
+ <p>It is recommended that you set up a new group specifically for
running the server. Some admins use user <code>nobody</code>,
but this is not always possible or desirable.</p>
-
-<p>Note: if you start the server as a non-root user, it will
+ <p>Note: if you start the server as a non-root user, it will
fail to change to the specified group, and will instead
continue to run as the group of the original user.</p>
-
-<p>Special note: Use of this directive in <VirtualHost< is
+ <p>Special note: Use of this directive in <VirtualHost< is
no longer supported. To implement the <a href="../suexec.html">suEXEC wrapper</a> with Apache 2.0, use the
- <code class="directive"><a href="mod_suexec.html#suexecusergroup" class="directive">SuexecUserGroup</a></code>
- directive. SECURITY: See <code class="directive"><a href="#user" class="directive">User</a></code> for a discussion of the
+ <a href="mod_suexec.html#suexecusergroup" class="directive"><code class="directive">SuexecUserGroup</code></a>
+ directive. SECURITY: See <a href="#user" class="directive"><code class="directive">User</code></a> for a discussion of the
security considerations.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="Listen">Listen</a> <a name="listen">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the IP addresses and ports that the server
-listens to</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>Listen [<em>IP-address</em>:]<em>portnumber</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">Listen</code> directive instructs Apache to
+</usage><hr/><h2><a name="Listen">Listen</a> <a name="listen">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the IP addresses and ports that the server
+listens to</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Listen [<em>IP-address</em>:]<em>portnumber</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">Listen</code> directive instructs Apache to
listen to only specific IP addresses or ports; by default it
responds to requests on all IP interfaces. The Listen directive is
now a required directive. If it is not in the config file, the
server will fail to start. This is a change from previous versions
of Apache.</p>
-
-<p>The Listen directive tells the server to accept incoming
+ <p>The Listen directive tells the server to accept incoming
requests on the specified port or address-and-port combination.
If only a port number is specified, the server listens to the
given port on all interfaces. If an IP address is given as well
as a port, the server will listen on the given port and
interface.</p>
-
-<p>Multiple Listen directives may be used to specify a number
+ <p>Multiple Listen directives may be used to specify a number
of addresses and ports to listen to. The server will respond to
requests from any of the listed addresses and ports.</p>
-
-<p>For example, to make the server accept connections on both
+ <p>For example, to make the server accept connections on both
port 80 and port 8000, use:</p>
-
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Listen 80<br>
Listen 8000
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
To make the server accept connections on two specified
interfaces and port numbers, use
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Listen 192.170.2.1:80<br>
Listen 192.170.2.5:8000
-</code></td>
-</tr>
-</table>
-</blockquote>
+</code></td></tr></table></blockquote>
IPv6 addresses must be surrounded in square brackets, as in the
following example:
-<blockquote>
-<table cellpadding="10">
-<tr>
-<td bgcolor="#eeeeee"><code>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Listen [fe80::a00:20ff:fea7:ccea]:80
-</code></td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../dns-caveats.html">DNS Issues</a>
-</li>
-<li>
-<a href="../bind.html">Setting
- which addresses and ports Apache uses</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="ListenBackLog">ListenBackLog</a> <a name="listenbacklog">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maximum length of the queue of pending connections</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ListenBacklog <em>backlog</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ListenBacklog 511</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The maximum length of the queue of pending connections.
+</code></td></tr></table></blockquote>
+</usage><p><strong>See also </strong></p><ul><li><a href="../dns-caveats.html">DNS Issues</a></li><li><a href="../bind.html">Setting
+ which addresses and ports Apache uses</a></li></ul><hr/><h2><a name="ListenBackLog">ListenBackLog</a> <a name="listenbacklog">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maximum length of the queue of pending connections</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ListenBacklog <em>backlog</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ListenBacklog 511</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td></tr></table></td></tr></table><usage>
+ <p>The maximum length of the queue of pending connections.
Generally no tuning is needed or desired, however on some
systems it is desirable to increase this when under a TCP SYN
flood attack. See the backlog parameter to the
<code>listen(2)</code> system call.</p>
-
-<p>This will often be limited to a smaller number by the
+ <p>This will often be limited to a smaller number by the
operating system. This varies from OS to OS. Also note that
many OSes do not use exactly what is specified as the backlog,
but use a number based on (but normally larger than) what is
set.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="LockFile">LockFile</a> <a name="lockfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Location of the accept serialization lock file</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>LockFile <em>filename</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LockFile logs/accept.lock</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">LockFile</code> directive sets the path to
+</usage><hr/><h2><a name="LockFile">LockFile</a> <a name="lockfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Location of the accept serialization lock file</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>LockFile <em>filename</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LockFile logs/accept.lock</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">LockFile</code> directive sets the path to
the lockfile used when Apache is compiled with either
USE_FCNTL_SERIALIZED_ACCEPT or USE_FLOCK_SERIALIZED_ACCEPT. This
directive should normally be left at its default value. The main
@@ -412,441 +102,114 @@
disk</strong>. The PID of the main server process is
automatically appended to the filename.</p>
-
-<p>
-<strong>SECURITY:</strong> It is best to avoid putting this
+ <p><strong>SECURITY:</strong> It is best to avoid putting this
file in a world writable directory such as
<code>/var/tmp</code> because someone could create a denial of
service attack and prevent the server from starting by creating
a lockfile with the same name as the one the server will try to
create.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="MaxClients">MaxClients</a> <a name="maxclients">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maximum number of child processes that will be created
-to serve requests</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MaxClients <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>>MaxClients
- 8 (with threads) MaxClients 256</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="prefork.html">prefork</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">MaxClients</code> directive sets the limit
+</usage><hr/><h2><a name="MaxClients">MaxClients</a> <a name="maxclients">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maximum number of child processes that will be created
+to serve requests</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MaxClients <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>>MaxClients
+ 8 (with threads) MaxClients 256</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="prefork.html">prefork</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">MaxClients</code> directive sets the limit
on the number of child processes that will be created to serve
requests. When the server is built without threading, no more than
this number of clients can be served simultaneously. To configure
more than 256 clients with the prefork MPM, you must use the
- <code class="directive"><a href="#serverlimit" class="directive">ServerLimit</a></code> directive.
+ <a href="#serverlimit" class="directive"><code class="directive">ServerLimit</code></a> directive.
To configure more than 1024 clients with the worker MPM, you must
- use the <code class="directive"><a href="#serverlimit" class="directive">ServerLimit</a></code> and
- <code class="directive"><a href="#threadlimit" class="directive">ThreadLimit</a></code> directives.</p>
-
+ use the <a href="#serverlimit" class="directive"><code class="directive">ServerLimit</code></a> and
+ <a href="#threadlimit" class="directive"><code class="directive">ThreadLimit</code></a> directives.</p>
-<p>Any connection attempts over the
+ <p>Any connection attempts over the
<code class="directive">MaxClients</code> limit will normally be queued,
- up to a number based on the <code class="directive"><a href="#listenbacklog" class="directive">ListenBacklog</a></code> directive. Once a child
+ up to a number based on the <a href="#listenbacklog" class="directive"><code class="directive">ListenBacklog</code></a> directive. Once a child
process is freed at the end of a different request, the connection
will then be serviced.</p>
-
-<p>When the server is compiled with threading, then the maximum
+ <p>When the server is compiled with threading, then the maximum
number of simultaneous requests that can be served is obtained
from the value of this directive multiplied by
- <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code>.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="MaxRequestPerChild">MaxRequestPerChild</a> <a name="maxrequestperchild">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Limit on the number of requests that an individual child server
-will handle during its life</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MaxRequestsPerChild <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxRequestsPerChild 10000</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">MaxRequestsPerChild</code> directive sets
+ <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a>.</p>
+</usage><hr/><h2><a name="MaxRequestsPerChild">MaxRequestsPerChild</a> <a name="maxrequestsperchild">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Limit on the number of requests that an individual child server
+will handle during its life</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MaxRequestsPerChild <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxRequestsPerChild 10000</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">MaxRequestsPerChild</code> directive sets
the limit on the number of requests that an individual child
server process will handle. After
<code class="directive">MaxRequestsPerChild</code> requests, the child
process will die. If <code class="directive">MaxRequestsPerChild</code> is
0, then the process will never expire.</p>
-
-<p>Setting <code class="directive">MaxRequestsPerChild</code> to a
+ <p>Setting <code class="directive">MaxRequestsPerChild</code> to a
non-zero limit has two beneficial effects:</p>
-
-<ul>
-
-<li>it limits the amount of memory that process can consume
+ <ul>
+ <li>it limits the amount of memory that process can consume
by (accidental) memory leakage;</li>
-
-<li>by giving processes a finite lifetime, it helps reduce
+ <li>by giving processes a finite lifetime, it helps reduce
the number of processes when the server load reduces.</li>
+ </ul>
-</ul>
-
-
-<p>
-<strong>NOTE:</strong> For <em>KeepAlive</em> requests, only
+ <p><strong>NOTE:</strong> For <em>KeepAlive</em> requests, only
the first request is counted towards this limit. In effect, it
changes the behavior to limit the number of
<em>connections</em> per child.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="MaxSpareThreads">MaxSpareThreads</a> <a name="maxsparethreads">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maximum number of idle threads</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MaxSpareThreads <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxSpareThreads 10 (Perchild) or 500 (worker)</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Maximum number of idle threads. Different MPMs deal with this
+</usage><hr/><h2><a name="MaxSpareThreads">MaxSpareThreads</a> <a name="maxsparethreads">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maximum number of idle threads</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MaxSpareThreads <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxSpareThreads 10 (Perchild) or 500 (worker)</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code></td></tr></table></td></tr></table><usage>
+ <p>Maximum number of idle threads. Different MPMs deal with this
directive differently. <code><a href="perchild.html">perchild</a></code> monitors the
number of idle threads on a per-child basis. If there are too many
idle threads in that child, the server will begin to kill threads
within that child.</p>
-
-<p>
-<code><a href="worker.html">worker</a></code> deals with idle threads on a
+ <p><code><a href="worker.html">worker</a></code> deals with idle threads on a
server-wide basis. If there are too many idle threads in the
server then child processes are killed until the number of idle
threads is less than this number.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#minsparethreads" class="directive">MinSpareThreads</a></code>
-</li>
-<li>
-<code class="directive"><a href="#startservers" class="directive">StartServers</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="MaxThreadsPerChild">MaxThreadsPerChild</a> <a name="maxthreadsperchild">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maximum number of threads per child process</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MaxThreadsPerChild <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxThreadsPerChild 64</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Maximum number of threads per child. For MPMs with a
+</usage><p><strong>See also </strong></p><ul><li><a href="#minsparethreads" class="directive"><code class="directive">MinSpareThreads</code></a></li><li><a href="#startservers" class="directive"><code class="directive">StartServers</code></a></li></ul><hr/><h2><a name="MaxThreadsPerChild">MaxThreadsPerChild</a> <a name="maxthreadsperchild">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maximum number of threads per child process</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MaxThreadsPerChild <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxThreadsPerChild 64</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code></td></tr></table></td></tr></table><usage>
+ <p>Maximum number of threads per child. For MPMs with a
variable number of threads per child, this directive sets the
maximum number of threads that will be created in each child
process. To increase this value beyond its default, it is
necessary to change the value of the compile-time define
<code>HARD_THREAD_LIMIT</code> and recompile the server.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="MinSpareThreads">MinSpareThreads</a> <a name="minsparethreads">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Minimum number of idle threads available to handle request
-spikes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MinSpareServers <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MinSpareThreads 5 (Perchild) or 250 (worker)</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Minimum number of idle threads to handle request spikes.
+</usage><hr/><h2><a name="MinSpareThreads">MinSpareThreads</a> <a name="minsparethreads">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Minimum number of idle threads available to handle request
+spikes</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MinSpareServers <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MinSpareThreads 5 (Perchild) or 250 (worker)</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code></td></tr></table></td></tr></table><usage>
+ <p>Minimum number of idle threads to handle request spikes.
Different MPMs deal with this directive
differently. <code><a href="perchild.html">perchild</a></code> monitors the number of idle
threads on a per-child basis. If there aren't enough idle threads
in that child, the server will begin to create new threads within
that child.</p>
-
-<p>
-<code><a href="worker.html">worker</a></code> deals with idle threads on a
+ <p><code><a href="worker.html">worker</a></code> deals with idle threads on a
server-wide basis. If there aren't enough idle threads in the
server then child processes are created until the number of idle
threads is greater than number.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#maxsparethreads" class="directive">MaxSpareThreads</a></code>
-</li>
-<li>
-<code class="directive"><a href="#startservers" class="directive">StartServers</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="NumServers">NumServers</a> <a name="numservers">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Total number of children alive at the same time</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>NumServers <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>NumServers 2</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="perchild.html">perchild</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Number of children alive at the same time. MPMs that use
+</usage><p><strong>See also </strong></p><ul><li><a href="#maxsparethreads" class="directive"><code class="directive">MaxSpareThreads</code></a></li><li><a href="#startservers" class="directive"><code class="directive">StartServers</code></a></li></ul><hr/><h2><a name="NumServers">NumServers</a> <a name="numservers">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Total number of children alive at the same time</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>NumServers <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>NumServers 2</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="perchild.html">perchild</a></code></td></tr></table></td></tr></table><usage>
+ <p>Number of children alive at the same time. MPMs that use
this directive do not dynamically create new child processes so
this number should be large enough to handle the requests for
the entire site.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="PidFile">PidFile</a> <a name="pidfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the file where the server records the process ID
-of the daemon</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>PidFile <em>filename</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>PidFile logs/httpd.pid</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchilde.html">perchilde</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">PidFile</code> directive sets the file to
+</usage><hr/><h2><a name="PidFile">PidFile</a> <a name="pidfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the file where the server records the process ID
+of the daemon</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>PidFile <em>filename</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>PidFile logs/httpd.pid</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchilde.html">perchilde</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">PidFile</code> directive sets the file to
which the server records the process id of the daemon. If the
filename does not begin with a slash (/) then it is assumed to be
- relative to the <code class="directive"><a href="core.html#serverroot" class="directive">ServerRoot</a></code>.</p>
-
+ relative to the <a href="core.html#serverroot" class="directive"><code class="directive">ServerRoot</code></a>.</p>
-<p>It is often useful to be able to send the server a signal,
- so that it closes and then reopens its <code class="directive"><a href="core.html#errorlog" class="directive">ErrorLog</a></code> and TransferLog, and
+ <p>It is often useful to be able to send the server a signal,
+ so that it closes and then reopens its <a href="core.html#errorlog" class="directive"><code class="directive">ErrorLog</code></a> and TransferLog, and
re-reads its configuration files. This is done by sending a
SIGHUP (kill -1) signal to the process id listed in the
PidFile.</p>
-
-<p>The PidFile is subject to the same warnings about log file
+ <p>The PidFile is subject to the same warnings about log file
placement and <a href="../misc/security_tips.html#serverroot">security</a>.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ScoreBoardFile">ScoreBoardFile</a> <a name="scoreboardfile">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Location of the file used to store coordination data for
-the child processes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ScoreBoardFile <em>file-path</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScoreBoardFile logs/apache_status</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">ScoreBoardFile</code> directive is required
+</usage><hr/><h2><a name="ScoreBoardFile">ScoreBoardFile</a> <a name="scoreboardfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Location of the file used to store coordination data for
+the child processes</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ScoreBoardFile <em>file-path</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScoreBoardFile logs/apache_status</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ScoreBoardFile</code> directive is required
on some architectures to place a file that the server will use to
communicate between its children and the parent. The easiest way
to find out if your architecture requires a scoreboard file is to
@@ -855,311 +218,73 @@
that this file is not used at the same time by more than one
invocation of Apache.</p>
-
-<p>If you have to use a <code class="directive">ScoreBoardFile</code> then
+ <p>If you have to use a <code class="directive">ScoreBoardFile</code> then
you may see improved speed by placing it on a RAM disk. But be
careful that you heed the same warnings about log file placement
and <a href="../misc/security_tips.html">security</a>.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../stopping.html">Stopping and Restarting Apache</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="SendBufferSize">SendBufferSize</a> <a name="sendbuffersize">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>TCP buffer size</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>SendBufferSize <em>bytes</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The server will set the TCP buffer size to the number of bytes
+</usage><p><strong>See also </strong></p><ul><li><a href="../stopping.html">Stopping and Restarting Apache</a></li></ul><hr/><h2><a name="SendBufferSize">SendBufferSize</a> <a name="sendbuffersize">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>TCP buffer size</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SendBufferSize <em>bytes</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td></tr></table></td></tr></table><usage>
+ <p>The server will set the TCP buffer size to the number of bytes
specified. Very useful to increase past standard OS defaults on
high speed high latency (<em>i.e.</em>, 100ms or so, such as
transcontinental fast pipes).</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ServerLimit">ServerLimit</a> <a name="serverlimit">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Upper limit on configurable number of processes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ServerLimit <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerLimit 256 (prefork), ServerLimit 16 (worker)</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="prefork.html">prefork</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>For the <code><a href="prefork.html">prefork</a></code> MPM, this directive sets the
- maximum configured value for <code class="directive"><a href="#maxclients" class="directive">MaxClients</a></code> for the lifetime of the
+</usage><hr/><h2><a name="ServerLimit">ServerLimit</a> <a name="serverlimit">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Upper limit on configurable number of processes</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerLimit <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerLimit 256 (prefork), ServerLimit 16 (worker)</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="prefork.html">prefork</a></code></td></tr></table></td></tr></table><usage>
+ <p>For the <code><a href="prefork.html">prefork</a></code> MPM, this directive sets the
+ maximum configured value for <a href="#maxclients" class="directive"><code class="directive">MaxClients</code></a> for the lifetime of the
Apache process. For the worker MPM, this directive in combination
- with <code class="directive"><a href="#threadlimit" class="directive">ThreadLimit</a></code> sets
- the maximum configured value for <code class="directive"><a href="#maxclients" class="directive">MaxClients</a></code> for the lifetime of the
+ with <a href="#threadlimit" class="directive"><code class="directive">ThreadLimit</code></a> sets
+ the maximum configured value for <a href="#maxclients" class="directive"><code class="directive">MaxClients</code></a> for the lifetime of the
Apache process. Any attempts to change this directive during a
- restart will be ignored, but <code class="directive"><a href="#maxclients" class="directive">MaxClients</a></code> can be modified during
+ restart will be ignored, but <a href="#maxclients" class="directive"><code class="directive">MaxClients</code></a> can be modified during
a restart.</p>
-
-<p>Special care must be taken when using this directive. If
+ <p>Special care must be taken when using this directive. If
<code class="directive">ServerLimit</code> is set to a value much higher
than necessary, extra, unused shared memory will be allocated. If
- both <code class="directive">ServerLimit</code> and <code class="directive"><a href="#maxclients" class="directive">MaxClients</a></code> are set to values
+ both <code class="directive">ServerLimit</code> and <a href="#maxclients" class="directive"><code class="directive">MaxClients</code></a> are set to values
higher than the system can handle, Apache may not start or the
system may become unstable.</p>
-
-<p>With the <code><a href="prefork.html">prefork</a></code> MPM, use this directive only
- if you need to set <code class="directive"><a href="#maxclients" class="directive">MaxClients</a></code> higher higher than 256.
+ <p>With the <code><a href="prefork.html">prefork</a></code> MPM, use this directive only
+ if you need to set <a href="#maxclients" class="directive"><code class="directive">MaxClients</code></a> higher higher than 256.
Do not set the value of this directive any higher than what you
- might want to set <code class="directive"><a href="#maxclients" class="directive">MaxClients</a></code> to.</p>
-
+ might want to set <a href="#maxclients" class="directive"><code class="directive">MaxClients</code></a> to.</p>
-<p>With the <code><a href="worker.html">worker</a></code> MPM, use this directive only
- if your <code class="directive"><a href="#maxclients" class="directive">MaxClients</a></code> and
- <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code>
+ <p>With the <code><a href="worker.html">worker</a></code> MPM, use this directive only
+ if your <a href="#maxclients" class="directive"><code class="directive">MaxClients</code></a> and
+ <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a>
settings require more than 16 server processes. Do not set the
value of this directive any higher than the number of server
- processes required by what you may want for <code class="directive"><a href="#maxclients " class="directive">MaxClients </a></code> and <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code>.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="StartServers">StartServers</a> <a name="startservers">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Number of child server processes created at startup</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>StartServers <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>StartServers 5</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">StartServers</code> directive sets the
+ processes required by what you may want for <a href="#maxclients " class="directive"><code class="directive">MaxClients </code></a> and <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a>.</p>
+</usage><hr/><h2><a name="StartServers">StartServers</a> <a name="startservers">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Number of child server processes created at startup</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>StartServers <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>StartServers 5</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">StartServers</code> directive sets the
number of child server processes created on startup. As the number
of processes is dynamically controlled depending on the load,
there is usually little reason to adjust this parameter.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#minsparethreads" class="directive">MinSpareThreads</a></code>
-</li>
-<li>
-<code class="directive"><a href="#maxsparethreads" class="directive">MaxSpareThreads</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="StartThreads">StartThreads</a> <a name="startthreads">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Nubmer of threads each child creates on startup</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>StartThreads <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>StartThreads 5</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="perchild.html">perchild</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>Number of threads each child creates on startup. As the
+</usage><p><strong>See also </strong></p><ul><li><a href="#minsparethreads" class="directive"><code class="directive">MinSpareThreads</code></a></li><li><a href="#maxsparethreads" class="directive"><code class="directive">MaxSpareThreads</code></a></li></ul><hr/><h2><a name="StartThreads">StartThreads</a> <a name="startthreads">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Nubmer of threads each child creates on startup</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>StartThreads <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>StartThreads 5</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="perchild.html">perchild</a></code></td></tr></table></td></tr></table><usage>
+ <p>Number of threads each child creates on startup. As the
number of threads is dynamically controlled depending on the
load, there is usually little reason to adjust this
parameter.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ThreadLimit">ThreadLimit</a> <a name="threadlimit">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Sets the upper limit on the configurable number of threads
-per child process</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ThreadLimit <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ThreadLimit 64</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive sets the maximum configured value for <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code> for the lifetime
+</usage><hr/><h2><a name="ThreadLimit">ThreadLimit</a> <a name="threadlimit">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the upper limit on the configurable number of threads
+per child process</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ThreadLimit <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ThreadLimit 64</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code></td></tr></table></td></tr></table><usage>
+ <p>This directive sets the maximum configured value for <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a> for the lifetime
of the Apache process. Any attempts to change this directive
- during a restart will be ignored, but <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code> can be modified
+ during a restart will be ignored, but <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a> can be modified
during a restart up to the value of this directive.</p>
-
-<p>Special care must be taken when using this directive. If
+ <p>Special care must be taken when using this directive. If
<code class="directive">ThreadLimit</code> is set to a value much higher
- than <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code>,
+ than <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a>,
extra unused shared memory will be allocated. If both
- <code class="directive">ThreadLimit</code> and <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code> are set to values
+ <code class="directive">ThreadLimit</code> and <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a> are set to values
higher than the system can handle, Apache may not start or the
system may become unstable.</p>
-
-<p>Use this directive only if you need to set <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code> higher than 64. Do
+ <p>Use this directive only if you need to set <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a> higher than 64. Do
not set the value of this directive any higher than what you might
- want to set <code class="directive"><a href="#threadsperchild" class="directive">ThreadsPerChild</a></code> to.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="ThreadsPerChild">ThreadsPerChild</a> <a name="threadsperchild">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Number of threads created by each child process</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>ThreadsPerChild <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ThreadsPerChild 50</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>This directive sets the number of threads created by each
+ want to set <a href="#threadsperchild" class="directive"><code class="directive">ThreadsPerChild</code></a> to.</p>
+</usage><hr/><h2><a name="ThreadsPerChild">ThreadsPerChild</a> <a name="threadsperchild">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Number of threads created by each child process</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ThreadsPerChild <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ThreadsPerChild 50</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="mpm_winnt.html">mpm_winnt</a></code></td></tr></table></td></tr></table><usage>
+ <p>This directive sets the number of threads created by each
child process. The child creates these threads at startup and
never creates more. if using an MPM like mpmt_winnt, where
there is only one child process, this number should be high
@@ -1167,67 +292,24 @@
like worker, where there are multiple child processes, the
total number of threads should be high enough to handle the
common load on the server.</p>
-
-</usage>
-<hr>
-<h2>
-<a name="User">User</a> <a name="user">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>The userid under which the server will answer
-requests</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>User <em>unix-userid</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>User #-1</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">User</code> directive sets the userid as
+</usage><hr/><h2><a name="User">User</a> <a name="user">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>The userid under which the server will answer
+requests</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>User <em>unix-userid</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>User #-1</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td><code><a href="worker.html">worker</a></code>, <code><a href="perchild.html">perchild</a></code>, <code><a href="prefork.html">prefork</a></code></td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">User</code> directive sets the userid as
which the server will answer requests. In order to use this
directive, the standalone server must be run initially as
root. <em>Unix-userid</em> is one of:</p>
+ <dl>
+ <dt>A username</dt>
-<dl>
-
-<dt>A username</dt>
-
-
-<dd>Refers to the given user by name.</dd>
-
-
-<dt># followed by a user number.</dt>
-
-
-<dd>Refers to a user by their number.</dd>
+ <dd>Refers to the given user by name.</dd>
-</dl>
+ <dt># followed by a user number.</dt>
+ <dd>Refers to a user by their number.</dd>
+ </dl>
-<p>The user should have no privileges which result in it being
+ <p>The user should have no privileges which result in it being
able to access files which are not intended to be visible to the
outside world, and similarly, the user should not be able to
execute code which is not meant for httpd requests. It is
@@ -1235,41 +317,20 @@
running the server. Some admins use user <code>nobody</code>, but
this is not always possible or desirable. For example
<code><a href="mod_proxy.html">mod_proxy</a></code>'s cache, when enabled, must be
- accessible to this user (see <code class="directive"><a href="mod_proxy.html#cacheroot" class="directive">CacheRoot</a></code>).</p>
-
+ accessible to this user (see <a href="mod_proxy.html#cacheroot" class="directive"><code class="directive">CacheRoot</code></a>).</p>
-<p>Notes: If you start the server as a non-root user, it will
+ <p>Notes: If you start the server as a non-root user, it will
fail to change to the lesser privileged user, and will instead
continue to run as that original user. If you do start the
server as root, then it is normal for the parent process to
remain running as root.</p>
-
-<p>Special note: Use of this directive in <code class="directive"><a href="core.html#virtualhost" class="directive"><VirtualHost></a></code> is no longer supported. To
+ <p>Special note: Use of this directive in <a href="core.html#virtualhost" class="directive"><code class="directive"><VirtualHost></code></a> is no longer supported. To
configure your server for <a href="mod_suexec.html">suexec</a> use
- <code class="directive"><a href="mod_suexec.html#suexecusergroup" class="directive">SuexecUserGroup</a></code>.</p>
-
+ <a href="mod_suexec.html#suexecusergroup" class="directive"><code class="directive">SuexecUserGroup</code></a>.</p>
-<blockquote>
-<table>
-<tr>
-<td bgcolor="#e0e5f5">
-<p align="center">
-<strong>Security</strong>
-</p>
-<p>Don't set <code class="directive">User</code>
-(or <code class="directive"><a href="#group" class="directive">Group</a></code>) to
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Security</strong></p> <p>Don't set <code class="directive">User</code>
+(or <a href="#group" class="directive"><code class="directive">Group</code></a>) to
<code>root</code> unless you know exactly what you are doing, and what
-the dangers are.</p>
-</td>
-</tr>
-</table>
-</blockquote>
-
-</usage>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+the dangers are.</p></td></tr></table></blockquote>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.3 +7 -57 httpd-2.0/docs/manual/mod/mpm_winnt.html
Index: mpm_winnt.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mpm_winnt.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -b -u -r1.2 -r1.3
--- mpm_winnt.html 22 Sep 2001 19:36:01 -0000 1.2
+++ mpm_winnt.html 6 Mar 2002 17:08:19 -0000 1.3
@@ -1,61 +1,11 @@
-<!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 MPM pthread</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">Multi-Processing Module mpm_winnt</h1>
-
- <p>This Multi-Processing Module is optimized for Windows
- NT.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> MPM<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a> mpm_winnt.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- mpm_winnt_module</p>
-
- <h2>Summary</h2>
-
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mpm_winnt - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mpm_winnt</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This Multi-Processing Module is optimized for Windows
+ NT.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>mpm_winnt_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This Multi-Processing Module (MPM) is the default for the
Windows NT operating systems. It uses a single control process
which launches a single child process which in turn creates
threads to handle requests</p>
-
- <h2>Directives</h2>
-
- <ul>
- <li><a
- href="mpm_common.html#coredumpdirectory">CoreDumpDirectory</a></li>
-
- <li><a href="mpm_common.html#pidfile">PidFile</a></li>
-
- <li><a href="mpm_common.html#listen">Listen</a></li>
-
- <li><a
- href="mpm_common.html#listenbacklog">ListenBacklog</a></li>
-
- <li><a
- href="mpm_common.html#maxrequestsperchild">MaxRequestsPerChild</a></li>
-
- <li><a
- href="mpm_common.html#sendbuffersize">SendBufferSize</a></li>
-
- <li><a
- href="mpm_common.html#threadsperchild">ThreadsPerChild</a></li>
- </ul>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
-
+</summary><h2>Directives</h2><ul><li><a href="mpm_common.html#coredumpdirectory">CoreDumpDirectory</a></li><li><a href="mpm_common.html#listen">Listen</a></li><li><a href="mpm_common.html#listenbacklog">ListenBacklog</a></li><li><a href="mpm_common.html#maxrequestsperchild">MaxRequestsPerChild</a></li><li><a href="mpm_common.html#pidfile">PidFile</a></li><li><a href="mpm_common.html#sendbuffersize">SendBufferSize</a></li><li><a href="mpm_common.html#threadsperchild">ThreadsPerChild</a></li></ul><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
1.11 +44 -302 httpd-2.0/docs/manual/mod/prefork.html
Index: prefork.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/prefork.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -b -u -r1.10 -r1.11
--- prefork.html 26 Feb 2002 19:02:35 -0000 1.10
+++ prefork.html 6 Mar 2002 17:08:19 -0000 1.11
@@ -1,49 +1,14 @@
-<html>
-<head>
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<!--
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--->
-<title>prefork - Apache HTTP Server</title>
-<link href="../style/manual.css" type="text/css" rel="stylesheet">
-</head>
-<body>
-<blockquote>
-<div align="center">
-<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
-</div>
-<h1 align="center">Apache Module prefork</h1>
-<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table bgcolor="#ffffff">
-<tr>
-<td><span class="help">Description:</span></td><td>
-<description>Implements a non-threaded, pre-forking web server</description>
-</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>mpm_prefork_module</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<h2>Summary</h2>
-<summary>
-
-<p>This Multi-Processing Module (MPM) implements a
+--><title>prefork - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module prefork</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Implements a non-threaded, pre-forking web server</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>mpm_prefork_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This Multi-Processing Module (MPM) implements a
non-threaded, pre-forking web server which handles request in a
manner very similar to the default behavior of Apache 1.3 on
Unix.</p>
-
-<p>A single control process is responsible for launching child
+ <p>A single control process is responsible for launching child
processes which listen for connections and serve them when they
arrive. Apache always tries to maintain several <em>spare</em>
or idle server processes, which stand ready to serve incoming
@@ -51,25 +16,23 @@
child processes to be forked before their requests can be
served.</p>
-
-<p>The <code class="directive"><a href="mpm_common.html#startservers" class="directive">StartServers</a></code>,
- <code class="directive"><a href="#minspareservers" class="directive">MinSpareServers</a></code>,
- <code class="directive"><a href="#maxspareservers" class="directive">MaxSpareServers</a></code>, and
- <code class="directive"><a href="mpm_common.html#maxclients" class="directive">MaxClients</a></code> regulate how
+ <p>The <a href="mpm_common.html#startservers" class="directive"><code class="directive">StartServers</code></a>,
+ <a href="#minspareservers" class="directive"><code class="directive">MinSpareServers</code></a>,
+ <a href="#maxspareservers" class="directive"><code class="directive">MaxSpareServers</code></a>, and
+ <a href="mpm_common.html#maxclients" class="directive"><code class="directive">MaxClients</code></a> regulate how
the parent process creates children to serve requests. In general,
Apache is very self-regulating, so most sites do not need to
adjust these directives from their default values. Sites which
need to serve more than 256 simultaneous requests may need to
- increase <code class="directive"><a href="mpm_common.html#maxclients" class="directive">MaxClients</a></code>,
- while sites with limited memory may need to decrease <code class="directive"><a href="mpm_common.html#maxclients" class="directive">MaxClients</a></code> to keep the server from
+ increase <a href="mpm_common.html#maxclients" class="directive"><code class="directive">MaxClients</code></a>,
+ while sites with limited memory may need to decrease <a href="mpm_common.html#maxclients" class="directive"><code class="directive">MaxClients</code></a> to keep the server from
thrashing (swapping memory to disk and back). More information
about tuning process creation is provided in the <a href="../misc/perf-tuning.html">performance hints</a>
documentation.</p>
-
-<p>While the parent process is usually started as root under Unix
+ <p>While the parent process is usually started as root under Unix
in order to bind to port 80, the child processes are launched by
- Apache as a less-privileged user. The <code class="directive"><a href="mpm_common.html#user" class="directive">User</a></code> and <code class="directive"><a href="mpm_common.html#group" class="directive">Group</a></code> directives are used to set
+ Apache as a less-privileged user. The <a href="mpm_common.html#user" class="directive"><code class="directive">User</code></a> and <a href="mpm_common.html#group" class="directive"><code class="directive">Group</code></a> directives are used to set
the privileges of the Apache child processes. The child processes
must be able to read all the content that will be served, but
should have as few privileges beyond that as possible. In
@@ -77,110 +40,13 @@
these directives also set the privileges which will be inherited
by CGI scripts.</p>
-
-<p>
-<code class="directive"><a href="mpm_common.html#maxrequestsperchild" class="directive">MaxRequestsPerChild</a></code>
+ <p><a href="mpm_common.html#maxrequestsperchild" class="directive"><code class="directive">MaxRequestsPerChild</code></a>
controls how frequently the server recycles processes by killing
old ones and launching new ones.</p>
-
-</summary>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<a href="../bind.html">Setting which addresses and
- ports Apache uses</a>
-</li>
-</ul>
-<h2>Directives</h2>
-<ul>
-<li>
-<a href="#acceptmutex">AcceptMutex</a>
-</li>
-<li>
-<a href="mpm_common.html#coredumpdirectory">CoreDumpDirectory</a>
-</li>
-<li>
-<a href="mpm_common.html#listen">Listen</a>
-</li>
-<li>
-<a href="mpm_common.html#listenbacklog">ListenBacklog</a>
-</li>
-<li>
-<a href="mpm_common.html#lockfile">LockFile</a>
-</li>
-<li>
-<a href="mpm_common.html#maxrequestsperchild">MaxRequestsPerChild</a>
-</li>
-<li>
-<a href="mpm_common.html#maxspareservers">MaxSpareServers</a>
-</li>
-<li>
-<a href="#maxspareservers">MaxSpareServers</a>
-</li>
-<li>
-<a href="mpm_common.html#minspareservers">MinSpareServers</a>
-</li>
-<li>
-<a href="#minspareservers">MinSpareServers</a>
-</li>
-<li>
-<a href="mpm_common.html#pidfile">PidFile</a>
-</li>
-<li>
-<a href="mpm_common.html#scoreboardfile">ScoreBoardFile</a>
-</li>
-<li>
-<a href="mpm_common.html#sendbuffersize">SendBufferSize</a>
-</li>
-<li>
-<a href="mpm_common.html#serverlimit">ServerLimit</a>
-</li>
-<li>
-<a href="mpm_common.html#startservers">StartServers</a>
-</li>
-<li>
-<a href="mpm_common.html#user">User</a>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="AcceptMutex">AcceptMutex</a> <a name="acceptmutex">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Method that Apache uses to serialize multiple children
-accepting requests on network sockets</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>AcceptMutex default|<em>method</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AcceptMutex default</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>prefork</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">AcceptMutex</code> directives sets the
+</summary><p><strong>See also </strong></p><ul><li><a href="../bind.html">Setting which addresses and
+ ports Apache uses</a></li></ul><h2>Directives</h2><ul><li><a href="#acceptmutex">AcceptMutex</a></li><li><a href="mpm_common.html#coredumpdirectory">CoreDumpDirectory</a></li><li><a href="mpm_common.html#listen">Listen</a></li><li><a href="mpm_common.html#listenbacklog">ListenBacklog</a></li><li><a href="mpm_common.html#lockfile">LockFile</a></li><li><a href="mpm_common.html#maxrequestsperchild">MaxRequestsPerChild</a></li><li><a href="mpm_common.html#maxspareservers">MaxSpareServers</a></li><li><a href="#maxspareservers">MaxSpareServers</a></li><li><a href="mpm_common.html#minspareservers">MinSpareServers</a></li><li><a href="#minspareservers">MinSpareServers</a></li><li><a href="mpm_common.html#pidfile">PidFile</a></li><li><a href="mpm_common.html#scoreboardfile">ScoreBoardFile</a></li><li><a href="mpm_common.html#sendbuffersize">SendBufferSize</a></li><li><a href="mpm_common.html#serverlimit">ServerLimit</a></li><li><a href="mpm_common.html#startservers">StartServers</a></li><li><a href="mpm_common.html#user">User</a></li></ul><hr/><h2><a name="AcceptMutex">AcceptMutex</a> <a name="acceptmutex">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Method that Apache uses to serialize multiple children
+accepting requests on network sockets</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AcceptMutex default|<em>method</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AcceptMutex default</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>prefork</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">AcceptMutex</code> directives sets the
method that Apache uses to serialize multiple children accepting
requests on network sockets. Prior to Apache 2.0, the method was
selectable only at compile time. The optimal method to use is
@@ -188,177 +54,53 @@
see the <a href="../misc/perf-tuning.html">performance tuning</a>
documentation.</p>
-
-<p>If this directive is set to <code>default</code>, then the
+ <p>If this directive is set to <code>default</code>, then the
compile-time selected default will be used. Other possible
methods are listed below. Note that not all methods are
available on all platforms. If a method is specified which is
not available, a message will be written to the error log
listing the available methods.</p>
+ <dl>
+ <dt><code>flock</code></dt>
-<dl>
-
-<dt>
-<code>flock</code>
-</dt>
-
-
-<dd>uses the <code>flock(2)</code> system call to lock the
- file defined by the <code class="directive"><a href="mpm_common.html#lockfile" class="directive">LockFile</a></code> directive.</dd>
-
-
-<dt>
-<code>fcntl</code>
-</dt>
-
-
-<dd>uses the <code>fnctl(2)</code> system call to lock the
- file defined by the <code class="directive"><a href="mpm_common.html#lockfile" class="directive">LockFile</a></code> directive.</dd>
-
-
-<dt>
-<code>sysvsem</code>
-</dt>
+ <dd>uses the <code>flock(2)</code> system call to lock the
+ file defined by the <a href="mpm_common.html#lockfile" class="directive"><code class="directive">LockFile</code></a> directive.</dd>
+ <dt><code>fcntl</code></dt>
-<dd>uses SySV-style semaphores to implement the mutex.</dd>
+ <dd>uses the <code>fnctl(2)</code> system call to lock the
+ file defined by the <a href="mpm_common.html#lockfile" class="directive"><code class="directive">LockFile</code></a> directive.</dd>
+ <dt><code>sysvsem</code></dt>
-<dt>
-<code>pthread</code>
-</dt>
+ <dd>uses SySV-style semaphores to implement the mutex.</dd>
+ <dt><code>pthread</code></dt>
-<dd>uses POSIX mutexes as implemented by the POSIX Threads
+ <dd>uses POSIX mutexes as implemented by the POSIX Threads
(PThreads) specification.</dd>
-
-</dl>
-
-</usage>
-<hr>
-<h2>
-<a name="MaxSpareServers">MaxSpareServers</a> <a name="maxspareservers">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Maximum number of idle child server processes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MaxSpareServers <em>number</em>
-<br>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxSpareServers 10</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>prefork</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">MaxSpareServers</code> directive sets the
+ </dl>
+</usage><hr/><h2><a name="MaxSpareServers">MaxSpareServers</a> <a name="maxspareservers">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maximum number of idle child server processes</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MaxSpareServers <em>number</em><br></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxSpareServers 10</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>prefork</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">MaxSpareServers</code> directive sets the
desired maximum number of <em>idle</em> child server processes. An
idle process is one which is not handling a request. If there are
more than MaxSpareServers idle, then the parent process will kill
off the excess processes.</p>
-
-<p>Tuning of this parameter should only be necessary on very
+ <p>Tuning of this parameter should only be necessary on very
busy sites. Setting this parameter to a large number is almost
always a bad idea.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#minspareservers" class="directive">MinSpareServers</a></code>
-</li>
-<li>
-<code class="directive"><a href="mpm_common.html#startservers" class="directive">StartServers</a></code>
-</li>
-</ul>
-<hr>
-<h2>
-<a name="MinSpareServers">MinSpareServers</a> <a name="minspareservers">Directive</a>
-</h2>
-<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
-<tr>
-<td>
-<table width="100%" bgcolor="#ffffff">
-<tr>
-<td><strong>Description: </strong></td><td>Minimum number of idle child server processes</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
-<syntax>MinSpareServers <em>number</em>
-</syntax>
-</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MinSpareServers 5</code></td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td>
-</tr>
-<tr>
-<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>prefork</td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-<usage>
-
-<p>The <code class="directive">MinSpareServers</code> directive sets the
+</usage><p><strong>See also </strong></p><ul><li><a href="#minspareservers" class="directive"><code class="directive">MinSpareServers</code></a></li><li><a href="mpm_common.html#startservers" class="directive"><code class="directive">StartServers</code></a></li></ul><hr/><h2><a name="MinSpareServers">MinSpareServers</a> <a name="minspareservers">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Minimum number of idle child server processes</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MinSpareServers <em>number</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MinSpareServers 5</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>MPM</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>prefork</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">MinSpareServers</code> directive sets the
desired minimum number of <em>idle</em> child server processes. An
idle process is one which is not handling a request. If there are
fewer than MinSpareServers idle, then the parent process creates
new children at a maximum rate of 1 per second.</p>
-
-<p>Tuning of this parameter should only be necessary on very
+ <p>Tuning of this parameter should only be necessary on very
busy sites. Setting this parameter to a large number is almost
always a bad idea.</p>
-
-<p>This directive has no effect on Microsoft Windows.</p>
-
-</usage>
-<p>
-<strong>See also:</strong>
-</p>
-<ul>
-<li>
-<code class="directive"><a href="#maxspareservers" class="directive">MaxSpareServers</a></code>
-</li>
-<li>
-<code class="directive"><a href="mpm_common.html#startservers" class="directive">StartServers</a></code>
-</li>
-</ul>
-<hr>
-<h3 align="center">Apache HTTP Server Version 2.0</h3>
-<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
-</blockquote>
-</body>
-</html>
+ <p>This directive has no effect on Microsoft Windows.</p>
+</usage><p><strong>See also </strong></p><ul><li><a href="#maxspareservers" class="directive"><code class="directive">MaxSpareServers</code></a></li><li><a href="mpm_common.html#startservers" class="directive"><code class="directive">StartServers</code></a></li></ul><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file