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/02/19 19:37: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_include.html mod_info.html mod_rewrite.html mod_setenvif.html mod_status.html mod_suexec.html mod_unique_id.html mod_userdir.html
slive 02/02/19 10:37:21
Modified: docs/manual/mod core.html mod_access.html mod_actions.html
mod_alias.html mod_asis.html mod_auth.html
mod_include.html mod_info.html mod_rewrite.html
mod_setenvif.html mod_status.html mod_suexec.html
mod_unique_id.html mod_userdir.html
Log:
Here goes: now committing the transformed version of the xml docs. This is
necessary to avoid having to keep the two in sync while we convert.
Revision Changes Path
1.216 +4087 -2210httpd-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.215
retrieving revision 1.216
diff -u -d -b -u -r1.215 -r1.216
--- core.html 19 Feb 2002 16:23:05 -0000 1.215
+++ core.html 19 Feb 2002 18:37:19 -0000 1.216
@@ -1,204 +1,301 @@
-<!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 Core Features</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 Core Features</h1>
-
- <p>These configuration parameters control the core Apache
- features, and are always available.</p>
-
- <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="#clearmodulelist">ClearModuleList</a></li>
-
- <li><a href="#contentdigest">ContentDigest</a></li>
-
- <li><a href="#coredumpdirectory">CoreDumpDirectory</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 />
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
- <h2><a id="acceptpathinfo"
- name="adddefaultcharset">AcceptPathInfo directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AcceptPathInfo On|Off|Default<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>AcceptPathInfo Default</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- AcceptPathInfo is only available in Apache 2.0.30 and later
- <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
- <code>AcceptPathInfo</code> directive are:</p>
- <dl>
- <dt><code>off</code></dt><dd>A request will only be accepted if it
+
+<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
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.</dt>
+ <code>/test/here.html</code> maps to a valid file.</dd>
- <dt><code>default</code><dd>The treatment of requests with
- trailing pathname information is determined by the <a
- href="../handler.html">handler</a> responsible for the request.
+
+<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
+ 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>
- <p>The primary purpose of the <code>AcceptPathInfo</code>
+</dl>
+
+
+<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
@@ -206,637 +303,1036 @@
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>
-<pre>
-<Files "mypaths.shtml">
- Options +Includes
- SetOutputFilter INCLUDES
- AcceptPathInfo on
-</Files>
-</pre>
- <hr />
- <h2><a id="accessfilename" name="accessfilename">AccessFileName
- directive</a></h2>
+<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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AccessFileName
- <em>filename</em> [<em>filename</em>] ...<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>AccessFileName
- .htaccess</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> AccessFileName
- can accept more than one filename only in Apache 1.3 and later
+</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
+<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>
- <code>AccessFileName .acl</code>
- </blockquote>
- before returning the document /usr/local/web/index.html, the
- server will read /.acl, /usr/.acl, /usr/local/.acl and
- /usr/local/web/.acl for directives, unless they have been
- disabled with
- <blockquote>
- <code><Directory /><br />
- AllowOverride None<br />
- </Directory></code>
- </blockquote>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+AccessFileName .acl
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p><strong>See Also:</strong> <a
- href="#allowoverride">AllowOverride</a> and <a
- href="../configuring.html">Configuration Files</a></p>
- <hr />
- <h2><a id="adddefaultcharset"
- name="adddefaultcharset">AddDefaultCharset directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddDefaultCharset
- On|Off|<em>charset</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> all<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>AddDefaultCharset Off</code><br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- AddDefaultCharset is only available in Apache 1.3.12 and later
+<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>
- <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
+
+<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>
+
+
+<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
<code>META</code> tag. A setting of <code>AddDefaultCharset
- Off</code> disables this functionality. <code>AddDefaultCharset
- On</code> enables Apache's internal default charset of
- <code>iso-8859-1</code> as required by the directive. You can
- also specify an alternate <em>charset</em> to be used. For
- example:</p>
-
- <blockquote>
- <code>AddDefaultCharset utf-8</code>
- </blockquote>
+ Off</code> disables this
+ functionality. <code>AddDefaultCharset On</code> enables
+ Apache's internal default charset of <code>iso-8859-1</code> as
+ required by the directive. You can also specify an alternate
+ <em>charset</em> to be used. For example:</p>
- <hr />
- <h2><a id="addmodule" name="addmodule">AddModule
- directive</a></h2>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ AddDefaultCharset utf-8
+</code></td>
+</tr>
+</table>
+</blockquote>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddModule
- <em>module</em> [<em>module</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> AddModule is
- only available in Apache 1.2 and later
+</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
+<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 <a
- href="#clearmodulelist">ClearModuleList</a> directive.</p>
-
- <p>For example:</p>
+ active modules; this list can be cleared with the <code class="directive"><a href="#clearmodulelist" class="directive">ClearModuleList</a></code> directive.</p>
- <blockquote>
- <code>AddDefaultCharset utf-8</code>
- </blockquote>
- <hr />
+<p>For example:</p>
- <h2><a id="allowoverride" name="allowoverride">AllowOverride
- directive</a></h2>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+AddDefaultCharset utf-8
+</code></td>
+</tr>
+</table>
+</blockquote>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AllowOverride
- All|None|<em>directive-type</em> [<em>directive-type</em>]
- ...<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>AllowOverride
- All</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> core
+</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 <a
- href="#accessfilename">AccessFileName</a>) it needs to know
+<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
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
- directive which has the .htaccess <a
- href="directive-dict.html#Context">Context</a> is allowed in
+
+<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>
- <dd>
+<dl>
- Allow use of the authorization directives (<a
- href="mod_auth_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a>,
- <a
- href="mod_auth_dbm.html#authdbmuserfile">AuthDBMUserFile</a>,
- <a href="mod_auth.html#authgroupfile">AuthGroupFile</a>, <a
- href="#authname">AuthName</a>, <a
- href="#authtype">AuthType</a>, <a
- href="mod_auth.html#authuserfile">AuthUserFile</a>, <a
- href="#require">Require</a>, <em>etc.</em>).</dd>
+<dt>AuthConfig</dt>
- <dt>FileInfo</dt>
- <dd>
- Allow use of the directives controlling document types (<a
- href="#defaulttype">DefaultType</a>, <a
- href="#errordocument">ErrorDocument</a>, <a
- href="#forcetype">ForceType</a>, <a
- href="mod_negotiation.html#languagepriority">LanguagePriority</a>,
- <a href="#sethandler">SetHandler</a>, <a
- href="#setinputfilter">SetInputFilter</a>, <a
- href="#setoutputfilter">SetOutputFilter</a>, and <a
- href="mod_mime.html">mod_mime Add* and Remove*
- directives</a>, <em>etc.</em>).</dd>
+<dd>
- <dt>Indexes</dt>
+ 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>
+
+
+<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
+ <code><a href="mod_mime.html">mod_mime</a></code> Add* and Remove*
+ directives, <em>etc.</em>).</dd>
+
+
+<dt>Indexes</dt>
+
+
+<dd>
Allow use of the directives controlling directory indexing
- (<a
- href="mod_autoindex.html#adddescription">AddDescription</a>,
- <a href="mod_autoindex.html#addicon">AddIcon</a>, <a
- href="mod_autoindex.html#addiconbyencoding">AddIconByEncoding</a>,
- <a href="mod_autoindex.html#addiconbytype">AddIconByType</a>,
- <a href="mod_autoindex.html#defaulticon">DefaultIcon</a>, <a
- href="mod_dir.html#directoryindex">DirectoryIndex</a>, <a
- href="mod_autoindex.html#fancyindexing">FancyIndexing</a>, <a
- href="mod_autoindex.html#headername">HeaderName</a>, <a
- href="mod_autoindex.html#indexignore">IndexIgnore</a>, <a
- href="mod_autoindex.html#indexoptions">IndexOptions</a>, <a
- href="mod_autoindex.html#readmename">ReadmeName</a>,
+ (<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>,
<em>etc.</em>).</dd>
- <dt>Limit</dt>
- <dd>
- Allow use of the directives controlling host access (Allow,
- Deny and Order).</dd>
+<dt>Limit</dt>
- <dt>Options</dt>
- <dd>
+<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 specific directory
- features (<a href="#options">Options</a> and <a
- href="mod_include.html#xbithack">XBitHack</a>).</dd>
- </dl>
+ 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>
- <p>Example:</p>
+</dl>
- <blockquote><code>AllowOverride AuthConfig Indexes</code></blockquote>
- <p><strong>See Also:</strong> <a
- href="#accessfilename">AccessFileName</a> and <a
- href="configuring.html">Configuration Files</a></p>
- <hr />
+<p>Example:</p>
- <h2><a id="authname" name="authname">AuthName
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AuthName
- <em>auth-domain</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> AuthConfig<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>AllowOverride AuthConfig Indexes</code></td>
+</tr>
+</table>
+</blockquote>
- <p>This directive sets the name of the authorization realm for
- a directory. This realm is given to the client so that the user
+</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>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.
- <samp>AuthName</samp> takes a single argument; if the realm
- name contains spaces, it must be enclosed in quotation marks.
- It must be accompanied by <a href="#authtype">AuthType</a> and
- <a href="#require">Require</a> directives, and directives such
- as <a href="mod_auth.html#authuserfile">AuthUserFile</a> and <a
- href="mod_auth.html#authgroupfile">AuthGroupFile</a> to
+ <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
work.</p>
- <p>For example:</p>
- <blockquote><code>AuthName "Top Secret"</code></blockquote>
+<p>For example:</p>
- <p>The string provided for the <code>AuthRealm</code> is what will
- appear in the password dialog provided by most browsers.</p>
- <p><strong>See also:</strong> <a
- href="../howto/auth.html">Authentication, Authorization, and
- Access Control</a></p>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>AuthName "Top Secret"</code></td>
+</tr>
+</table>
+</blockquote>
- <hr />
- <h2><a id="authtype" name="authtype">AuthType
- directive</a></h2>
+<p>The string provided for the <code>AuthRealm</code> is what will
+ appear in the password dialog provided by most browsers.</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AuthType
- Basic|Digest<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> AuthConfig<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core
+</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
+<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 <a href="#authname">AuthName</a> and
- <a href="#require">Require</a> directives, and directives such
- as <a href="mod_auth.html#authuserfile">AuthUserFile</a> and <a
- href="mod_auth.html#authgroupfile">AuthGroupFile</a> to
+ 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
work.</p>
- <p><strong>See also:</strong> <a
- href="../howto/auth.html">Authentication, Authorization, and
- Access Control</a></p>
- <hr />
-
- <h2><a id="clearmodulelist"
- name="clearmodulelist">ClearModuleList directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ClearModuleList<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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ClearModuleList
- is only available in Apache 1.2 and later
-
- <p>The server comes with a built-in list of active modules.
- This directive clears the list. It is assumed that the list
- will then be re-populated using the <a
- href="#addmodule">AddModule</a> directive.</p>
- <hr />
-
- <h2><a id="contentdigest" name="contentdigest">ContentDigest
- directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ContentDigest
- on|off<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>ContentDigest
- 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> experimental<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ContentDigest is
- only available in Apache 1.1 and later
+</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
+<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>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
-</pre>
+</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>
- <hr />
-
- <h2><a id="defaulttype" name="defaulttype">DefaultType
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DefaultType
- <em>MIME-type</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>DefaultType
- text/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> FileInfo<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core
+</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
+<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>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
<code>DefaultType image/gif</code>
- </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 <a href="#forcetype">ForceType</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>
- <hr />
+ <p>Note that unlike <code class="directive"><a href="#forcetype" class="directive">ForceType</a></code>, 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>
- <h2><a id="directory" name="directory"><Directory>
- directive</a></h2>
+</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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <Directory
- <em>directory-path</em>> ... </Directory> <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> Core.
+<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
+ in a directory context may be used. <em>Directory-path</em> is
+ either the full path to a directory, or a wild-card string. In a
+ wild-card string, `?' matches any single character, and `*'
+ matches any sequences of characters. You may
+ 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>
- <p><Directory> and </Directory> 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 in a directory context may be used.
- <em>Directory-path</em> is either the full path to a directory,
- or a wild-card string. In a wild-card string, `?' matches any
- single character, and `*' matches any sequences of characters.
- As of Apache 1.3, you may 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>
-<pre>
- <Directory /usr/local/httpd/htdocs>
- Options Indexes FollowSymLinks
- </Directory>
-</pre>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ <Directory /usr/local/httpd/htdocs><br>
+ Options Indexes FollowSymLinks<br>
+ </Directory><br>
- <p><strong>Apache 1.2 and above:</strong> Extended regular
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
<Directory ~ "^/www/.*/[0-9]{3}">
-</pre>
+</code></td>
+</tr>
+</table>
+</blockquote>
would match directories in /www/ that consisted of three
numbers.
<p>If multiple (non-regular expression) directory sections
match the directory (or its parents) containing a document,
then the directives are applied in the order of shortest match
- first, interspersed with the directives from the <a
- href="#accessfilename">.htaccess</a> files. For example,
+ first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example,
with</p>
- <blockquote>
- <code><Directory /><br />
- AllowOverride None<br />
- </Directory><br />
- <br />
- <Directory /home/*><br />
- AllowOverride FileInfo<br />
- </Directory></code>
- </blockquote>
- for access to the document <code>/home/web/dir/doc.html</code>
- the steps are:
- <ul>
- <li>Apply directive <code>AllowOverride None</code>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ <Directory /><br>
+ AllowOverride None<br>
+ </Directory><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>
+ the steps are:</p>
+
+
+<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>
- <p>Regular expression directory sections are handled slightly
- differently by Apache 1.2 and 1.3. In Apache 1.2 they are
- interspersed with the normal directory sections and applied in
- the order they appear in the configuration file. They are
- applied only once, and apply when the shortest match possible
- occurs. In Apache 1.3 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>
+<li>Apply any FileInfo directives in
+ <code>/home/web/.htaccess</code>
+</li>
- <blockquote>
- <code><Directory ~ abc$><br />
- ... directives here ...<br />
- </Directory><br />
- </code>
- </blockquote>
- Suppose that the filename being accessed is
- <code>/home/abc/public_html/abc/index.html</code>. The server
- considers each of <code>/</code>, <code>/home</code>,
- <code>/home/abc</code>, <code>/home/abc/public_html</code>, and
- <code>/home/abc/public_html/abc</code> in that order. In Apache
- 1.2, when <code>/home/abc</code> is considered, the regular
- expression will match and be applied. In Apache 1.3 the regular
- expression isn't considered at all at that point in the tree.
- It 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.
+</ul>
- <p><strong>Note that the default Apache access for
+
+<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>
+ ... directives here ...<br>
+ </Directory><br>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<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
<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>
-<pre>
- <Directory />
- Order Deny,Allow
- Deny from All
+ as</strong>
+</p>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ <Directory /><br>
+ Order Deny,Allow<br>
+ Deny from All<br>
</Directory>
-</pre>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <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>
- The directory sections typically occur in the access.conf file,
- but they may appear in any configuration file.
- <Directory> directives cannot nest, and cannot appear in
- a <a href="#limit"><Limit></a> or <a
- href="#limitexcept"><LimitExcept></a> section.
- <p><strong>See also</strong>: <a href="../sections.html">How
+<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>
+
+
+<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
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</p>
- <hr />
-
- <h2><a id="directorymatch"
- name="directorymatch"><DirectoryMatch></a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <DirectoryMatch
- <em>regex</em>> ... </DirectoryMatch> <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> Core.<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.3 and later
+ 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
+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><DirectoryMatch> and </DirectoryMatch> 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 <a href="#directory"><Directory></a>. However, it
+<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
takes as an argument a regular expression. For example:</p>
-<pre>
- <DirectoryMatch "^/www/.*/[0-9]{3}">
-</pre>
- <p>would match directories in /www/ that consisted of three
- numbers.</p>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ <DirectoryMatch "^/www/.*/[0-9]{3}">
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p><strong>See Also:</strong> <a
- href="#directory"><Directory></a> for a description of
- how regular expressions are mixed in with normal
- <Directory>s.<br />
- <strong>See also</strong>: <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</p>
- <hr />
- <h2><a id="documentroot" name="documentroot">DocumentRoot
- directive</a></h2>
+<p>would match directories in <code>/www/</code> that consisted of three
+ numbers.</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DocumentRoot
- <em>directory-path</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>DocumentRoot
- /usr/local/apache/htdocs</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> core
+</usage>
+<p>
+<strong>See also:</strong>
+</p>
+<ul>
+<li>
+<code class="directive"><a href="#directory" class="directive"><Directory></a></code> 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
+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
+<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>
- <code>DocumentRoot /usr/web</code>
- </blockquote>
- then an access to
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ DocumentRoot /usr/web
+</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>.
+ <code>/usr/web/index.html</code>.</p>
- <p>There appears to be a bug in mod_dir which causes problems
- when the DocumentRoot has a trailing slash (<em>i.e.</em>,
- "DocumentRoot /usr/web/") so please avoid that.</p>
- <hr />
- <h2><a id="errordocument" name="errordocument">ErrorDocument
- directive</a></h2>
+<p>The <code class="directive">DocumentRoot</code> should be specified without
+ a trailing slash.</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ErrorDocument
- <em>error-code document</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#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> FileInfo<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> The directory
- and .htaccess contexts are only available in Apache 1.1 and
- later. The quoting syntax prior to Apache 2.0 was different.
+</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
+<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>
- <li>output a customized message</li>
+<ol>
- <li>redirect to a local <em>URL-path</em> to handle the
+<li>output a simple hardcoded error message</li>
+
+
+<li>output a customized message</li>
+
+
+<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>
- <p>The first option is the default, while options 2-4 are
- configured using the <code>ErrorDocument</code> directive,
- which is followed by the HTTP response code and a URL or a
- message. Apache will sometimes offer additional information
+</ol>
+
+
+<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>
- <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 />
+
+<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>
- </blockquote>
+ today"
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p>Note that when you specify an <code>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
@@ -850,254 +1346,433 @@
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
- them with a single unmatched double quote character.</p>
- <p>See Also: <a href="../custom-error.html">documentation of
- customizable responses.</a></p>
- <hr />
+<p>Prior to version 2.0, messages were indicated by prefixing
+ them with a single unmatched double quote character.</p>
- <h2><a id="errorlog" name="errorlog">ErrorLog
- directive</a></h2>
+</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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ErrorLog
- <em>file-path</em>|syslog[:<em>facility</em>] <br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>ErrorLog
- logs/error_log</code> (Unix)<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>ErrorLog
- logs/error.log</code> (Windows and OS/2)<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> core
+<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>
+ begins with a pipe (|) then it is assumed to be a command to spawn
+ to handle the error log.</p>
- <p>The error log 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 <a
- href="#serverroot">ServerRoot</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><strong>Apache 1.3 and above:</strong> 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
+<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>
- <p><strong>See also:</strong> <a href="#loglevel">LogLevel</a>
- and <a href="../logs.html">Apache Log Files</a></p>
- <hr />
-
- <h2><a id="fileetag" name="fileetag">FileETag directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> FileETag
- <i>component</i> ...<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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> only available
- in Apache 1.3.23 versions and later.
+</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>
- The FileETag 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 value is used in cache management to save network
- bandwidth.) In Apache 1.3.22 and earlier, the ETag value was
- <i>always</i> formed from the file's inode, size, and last-modified
- time (mtime). The FileETag directive allows you to choose
- which of these -- if any -- should be used. The recognised
- keywords are:
+<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
+ value is used in cache management to save network bandwidth.) In
+ Apache 1.3.22 and earlier, the ETag value was <em>always</em> formed
+ from the file's inode, size, and last-modified time (mtime). The
+ 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>',
the setting for that subdirectory (which will be inherited by
any sub-subdirectories that don't override it) will be equivalent to
- '<code>FileETag MTime Size</code>'.
+ '<code>FileETag MTime Size</code>'.
</p>
- <hr />
- <h2><a id="files" name="files"><Files> directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <Files
- <em>filename</em>> ... </Files><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, .htaccess<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> only available
- in Apache 1.2 and above.
+</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 <Files> directive provides for access control by
- filename. It is comparable to the <a
- href="#directory"><Directory></a> directive and <a
- href="#location"><Location></a> directives. It should be
- matched with a </Files> 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><Files></code> sections are processed in
- the order they appear in the configuration file, after the
- <Directory> sections and <code>.htaccess</code> files are
- read, but before <Location> sections. Note that
- <Files> can be nested inside <Directory> sections
- to restrict the portion of the filesystem they apply to.</p>
+<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
+ 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
+ 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
+ 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>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
<Files ~ "\.(gif|jpe?g|png)$">
-</pre>
- would match most common Internet graphics formats. In Apache
- 1.3 and later, <a href="#filesmatch"><FilesMatch></a> is
- preferred, however.
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p>Note that unlike <a
- href="#directory"><code><Directory></code></a> and <a
- href="#location"><code><Location></code></a> sections,
- <code><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>
+<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>
- <p><strong>See also</strong>: <a href="../sections.html">How
+
+<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
+ .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
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</p>
- <hr />
+ 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>
- <h2><a id="filesmatch"
- name="filesmatch"><FilesMatch></a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <FilesMatch
- <em>regex</em>> ... </FilesMatch><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, .htaccess<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> only available
- in Apache 1.3 and above.
+<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
+ does. However, it accepts a regular expression. For example:</p>
- <p>The <FilesMatch> directive provides for access control
- by filename, just as the <a href="#files"><Files></a>
- directive does. However, it accepts a regular expression. For
- example:</p>
-<pre>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
<FilesMatch "\.(gif|jpe?g|png)$">
-</pre>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p>would match most common Internet graphics formats.</p>
- <strong>See also</strong>: <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
- <hr />
-
- <h2><a id="forcetype" name="forcetype">ForceType</a>
- directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ForceType
- <em>mime-type</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> 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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ForceType was
- introduced in mod_mime with Apache 1.1, and moved to the core
- in Apache 2.0.
+ 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><Directory></code>, or
- <code><Location></code> or or <code><Files></code>
+<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>
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>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
ForceType image/gif
-</pre>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p>Note that unlike <a href="#defaulttype">DefaultType</a>,
+
+<p>Note that unlike <code class="directive"><a href="#defaulttype" class="directive">DefaultType</a></code>,
this directive overrides all mime-type associations, including
filename extensions, that might identify the media type.</p>
- <hr />
-
- <h2><a id="hostnamelookups"
- name="hostnamelookups">HostnameLookups directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> HostnameLookups
- on|off|double<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>HostnameLookups
- off</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- <code>double</code> available only in Apache 1.3 and
- above.<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Default was
- <code>on</code> prior to Apache 1.3.
+</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
+<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
@@ -1106,108 +1781,163 @@
address. (In "tcpwrappers" terminology this is called
<code>PARANOID</code>.)</p>
- <p>Regardless of the setting, when <a
- href="mod_access.html">mod_access</a> 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 set
- <code>HostnameLookups double</code>. For example, if only
- <code>HostnameLookups on</code> and a request is made to an
- object that is protected by hostname restrictions, regardless
- of whether the double-reverse fails or not, CGIs will still be
- passed the single-reverse result in
- <code>REMOTE_HOST</code>.</p>
- <p>The default for this directive was previously
- <code>on</code> in versions of Apache prior to 1.3. It was
- changed to <code>off</code> in order to save the network
+<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
+ set <code>HostnameLookups double</code>. For example, if only
+ <code>HostnameLookups on</code> and a request is made to an object
+ that is protected by hostname restrictions, regardless of whether
+ 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
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.
Heavily loaded sites should leave this directive
<code>off</code>, since DNS lookups can take considerable
- amounts of time. The utility <a
- href="../programs/logresolve.html">logresolve</a>, provided in
+ 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>
- <hr />
- <h2><a id="identitycheck" name="identitycheck">IdentityCheck
- directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> IdentityCheck
- on|off<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>IdentityCheck
- off</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core
+</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
+<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. <em>Boolean</em> is either <code>on</code> or
- <code>off</code>.</p>
+ 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>
- <hr />
- <h2><a id="ifdefine" name="ifdefine"><IfDefine>
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <IfDefine
- [!]<em>parameter-name</em>> <em>...</em>
- </IfDefine><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> all<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> <IfDefine>
- is only available in 1.3.1 and later.
+</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 <IfDefine <em>test</em>>...</IfDefine>
- section is used to mark directives that are conditional. The
- directives within an IfDefine 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 <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 <IfDefine> section directive
- can be one of two forms:</p>
- <ul>
- <li><em>parameter-name</em></li>
+<p>The <em>test</em> in the <code class="directive"><IfDefine></code> section directive can be one
+ of two forms:</p>
- <li><code>!</code><em>parameter-name</em></li>
- </ul>
- <p>In the former case, the directives between the start and end
+<ul>
+
+<li>
+<em>parameter-name</em>
+</li>
+
+
+<li>
+<code>!</code><em>parameter-name</em>
+</li>
+
+</ul>
+
+
+<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><IfDefine> sections are nest-able, which can be used
- to implement simple multiple-parameter tests. Example:</p>
+
+<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>
$ httpd -DReverseProxy ...
@@ -1217,132 +1947,241 @@
LoadModule proxy_module modules/libproxy.so
</IfDefine>
</pre>
- <hr />
+</code></td>
+</tr>
+</table>
+</blockquote>
- <h2><a id="ifmodule" name="ifmodule"><IfModule>
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <IfModule
- [!]<em>module-name</em>> <em>...</em>
- </IfModule><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> all<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> IfModule is only
- available in 1.2 and later.
- <p>The <IfModule <em>test</em>>...</IfModule>
- section is used to mark directives that are conditional. The
- directives within an IfModule 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>
+</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>
- <p>The <em>test</em> in the <IfModule> section directive
- can be one of two forms:</p>
+<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>
- <ul>
- <li><em>module name</em></li>
- <li>!<em>module name</em></li>
- </ul>
+<p>The <em>test</em> in the <code class="directive"><IfModule></code> section directive can be one
+ of two forms:</p>
- <p>In the former case, the directives between the start and end
+
+<ul>
+
+<li>
+<em>module name</em>
+</li>
+
+
+<li>!<em>module name</em>
+</li>
+
+</ul>
+
+
+<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 <a
- href="mod_so.html#loadmodule">LoadModule</a>. The second format
+ dynamically loaded using <code class="directive"><a href="mod_so.html#loadmodule" class="directive">LoadModule</a></code>. 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><IfModule> sections are nest-able, which can be used
- to implement simple multiple-module tests.</p>
- <hr />
- <h2><a id="include" name="include">Include directive</a></h2>
- <strong>Syntax:</strong> Include
- <em>file-path</em>|<em>directory-path</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> Core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Include is only
- available in Apache 1.3 and later.
+<p>
+<code class="directive"><IfModule></code> sections are
+ nest-able, which can be used to implement simple multiple-module
+ tests.</p>
- <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 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
from within the server configuration files.</p>
- <p>If <code>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>ServerRoot</code> directory.</p>
+ <code class="directive"><a href="#serverroot" class="directive">ServerRoot</a></code> directory.</p>
- <p>Examples:</p>
- <blockquote>
- <code>Include /usr/local/apache/conf/ssl.conf<br />
+<p>Examples:</p>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ Include /usr/local/apache/conf/ssl.conf<br>
Include /usr/local/apache/conf/vhosts/
- </code>
- </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>
- <code>Include conf/ssl.conf<br />
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ Include conf/ssl.conf<br>
Include conf/vhosts/
- </code>
- </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.
Running <code>apachectl configtest</code> will give you a list of
the files that are being processed during the configuration
- check:<p>
+ check:</p>
- <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>
-
- <p>This will help in verifying that you are getting only the files
- that you intended as part of your configuration.</p>
-
- <p><strong>See also</strong>: <a
- href="../programs/apachectl.html">apachectl</a></p>
+</pre>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <hr />
+<p>This will help in verifying that you are getting only the files
+ that you intended as part of your configuration.</p>
- <h2><a id="keepalive" name="keepalive">KeepAlive
- directive</a></h2>
- <strong>Syntax:</strong> KeepAlive on/off<br />
- <strong>Default:</strong> <code>KeepAlive On</code><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> Core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> KeepAlive is
- only available in Apache 1.1 and later.
+</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
+<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
@@ -1350,7 +2189,8 @@
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
@@ -1362,853 +2202,1386 @@
encoding will be used in order to send content of unknown
length over persistent connections.</p>
- <p>See also <a
- href="#maxkeepaliverequests">MaxKeepAliveRequests</a>.</p>
- <hr />
-
- <h2><a id="keepalivetimeout"
- name="keepalivetimeout">KeepAliveTimeout directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> KeepAliveTimeout
- <em>seconds</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>KeepAliveTimeout
- 15</code><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> Core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> KeepAliveTimeout
- is only available in Apache 1.1 and later.
+</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
+<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 <a
- href="#timeout"><code>Timeout</code></a> directive applies.</p>
+ received, the timeout value specified by the
+ <code class="directive"><a href="#timeout" class="directive">Timeout</a></code> directive applies.</p>
- <p>Setting <code>KeepAliveTimeout</code> to a high value may
- cause performance problems in heavily loaded servers. The
+
+<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>
- <hr />
- <h2><a id="limit" name="limit"><Limit> directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <Limit
- <em>method</em> [<em>method</em>] ... > ...
- </Limit><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> any<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core
+</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
+<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><limit></code> section.</strong></p>
+ <code class="directive"><limit></code> section.</strong>
+</p>
- <p>The purpose of the <Limit> 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 <Limit> bracket <strong>will have no
- effect</strong>. The following example applies the access
- control only to the methods POST, PUT, and DELETE, leaving all
- other methods unprotected:</p>
- <blockquote>
- <code><Limit POST PUT DELETE><br />
- Require valid-user<br />
+<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>
+ bracket <strong>will have no effect</strong>. The following
+ 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>
+ <code><Limit POST PUT DELETE><br>
+ Require valid-user<br>
</Limit></code>
- </blockquote>
- 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.
- <hr />
-
- <h2><a id="limitexcept" name="limitexcept"><LimitExcept>
- directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <LimitExcept
- <em>method</em> [<em>method</em>] ... > ...
- </LimitExcept><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> any<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.3.5 and later
+ HEAD requests.</p>
- <p><LimitExcept> and </LimitExcept> 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 <a
- href="#limit"><Limit></a> section and can be used to
- control both standard and nonstandard/unrecognized methods. See
- the documentation for <a href="#limit"><Limit></a> for
- more details.</p>
- <hr />
+</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>
- <h2><a id="limitrequestbody"
- name="limitrequestbody">LimitRequestBody directive</a></h2>
+<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
+ 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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LimitRequestBody
- <em>bytes</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>LimitRequestBody
- 0</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> LimitRequestBody
- is only available in Apache 1.3.2 and later.
+</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
+<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 LimitRequestBody 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 request
- exceeds that limit, the server will return an error response
- instead of servicing the request. The size of a normal request
- message body will vary greatly depending on the nature of the
- resource and the methods allowed on that resource. CGI scripts
- typically use the message body for passing form information to
- the server. Implementations of the PUT method will require a
- value at 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>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
+ request exceeds that limit, the server will return an error
+ response instead of servicing the request. The size of a normal
+ request message body will vary greatly depending on the nature of
+ the resource and the methods allowed on that resource. CGI scripts
+ typically use the message body for passing form information to the
+ server. Implementations of the PUT method will require a value at
+ least as large as any representation that the server wishes to
+ accept for that resource.</p>
+
+
+<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>
- <hr />
-
- <h2><a id="limitrequestfields"
- name="limitrequestfields">LimitRequestFields directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LimitRequestFields
- <em>number</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>LimitRequestFields 100</code><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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- LimitRequestFields is only available in Apache 1.3.2 and later.
+</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
+<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 LimitRequestFields 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
- client request might include. The number of request header
- fields used by a client rarely exceeds 20, but this may vary
- among different client implementations, often depending upon
- the extent to which a user has configured their browser to
- support detailed content negotiation. Optional HTTP extensions
- are often expressed using request header fields.</p>
- <p>This directive gives the server administrator greater
+<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
+ client request might include. The number of request header fields
+ used by a client rarely exceeds 20, but this may vary among
+ different client implementations, often depending upon the extent
+ to which a user has configured their browser to support detailed
+ content negotiation. Optional HTTP extensions are often expressed
+ using request header fields.</p>
+
+
+<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>
- <hr />
- <h2><a id="limitrequestfieldsize"
- name="limitrequestfieldsize">LimitRequestFieldsize
- directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LimitRequestFieldsize
- <em>bytes</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>LimitRequestFieldsize 8190</code><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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- LimitRequestFieldsize is only available in Apache 1.3.2 and
- later.
+</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
+<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 LimitRequestFieldsize 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 large
- enough to hold any one header field from a normal client
+
+<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
+ large enough to hold any one header field from a normal client
request. The size of a normal request header field will vary
greatly among different client implementations, often depending
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>
- <hr />
-
- <h2><a id="limitrequestline"
- name="limitrequestline">LimitRequestLine directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LimitRequestLine
- <em>bytes</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>LimitRequestLine
- 8190</code><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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> LimitRequestLine
- is only available in Apache 1.3.2 and later.
+</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
+<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 LimitRequestLine 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 HTTP method, URI, and protocol version, the
- LimitRequestLine directive places a restriction on the length
- of a request-URI allowed for a request on the server. A server
- needs this value to be large enough to 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>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
+ HTTP method, URI, and protocol version, the
+ <code class="directive">LimitRequestLine</code> directive places a
+ restriction on the length of a request-URI allowed for a request
+ on the server. A server needs this value to be large enough to
+ 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
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>
- <hr />
-
- <h2><a id="limitxmlrequestbody"
- name="limitxmlrequestbody">LimitXMLRequestBody
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LimitXMLRequestBody
- <em>number</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>LimitXMLRequestBody 1000000</code><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> core<br />
+</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
+<p>Limit (in bytes) on maximum size of an XML-based request
body. A value of <code>0</code> will disable any checking.</p>
- <hr />
- <h2><a id="location" name="location"><Location>
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <Location
- <em>URL-path</em>|<em>URL</em>> ... </Location><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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Location is only
- available in Apache 1.1 and later.
+</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 <Location> directive provides for access control
- by URL. It is similar to the <a
- href="#directory"><Directory></a> directive, and starts a
- subsection which is terminated with a </Location>
- directive. <code><Location></code> sections are processed
- in the order they appear in the configuration file, after the
- <Directory> sections and <code>.htaccess</code> files are
- read, and after the <Files> sections.</p>
+<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>
+ 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>
- <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><strong>Apache 1.2 and above:</strong> Extended regular
+
+<p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
<Location ~ "/(extra|special)/data">
-</pre>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p>would match URLs that contained the substring "/extra/data"
- or "/special/data". In Apache 1.3 and above, a new directive <a
- href="#locationmatch"><LocationMatch></a> exists which
- behaves identical to the regex version of
- <code><Location></code>.</p>
- <p>The <code>Location</code> functionality is especially useful
- when combined with the <code><a
- href="mod_mime.html#sethandler">SetHandler</a></code>
- directive. For example, to enable status requests, but allow
- them only from browsers at foo.com, you might use:</p>
-<pre>
- <Location /status>
- SetHandler server-status
- Order Deny,Allow
- Deny from all
- Allow from .foo.com
+<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>
+ exists which behaves identical to the regex version of
+ <code class="directive"><Location></code>.</p>
+
+
+<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>
+ 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>
+ <Location /status><br>
+ SetHandler server-status<br>
+ Order Deny,Allow<br>
+ Deny from all<br>
+ Allow from .foo.com<br>
</Location>
-</pre>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p><strong>Apache 1.3 and above note about / (slash)</strong>:
- 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><LocationMatch></code> directive and the
- regex version of <code><Location></code> require you to
- explicitly specify multiple slashes if that is your intention.
- For example, <code><LocationMatch ^/abc></code> would
- match the request URL <code>/abc</code> but not the request URL
- <code>//abc</code>. The (non-regex)
- <code><Location></code> directive behaves similarly when
- used for proxy requests. But when (non-regex)
- <code><Location></code> is used for non-proxy requests it
- 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>
- <p><strong>See also</strong>: <a href="../sections.html">How
+<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
+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
+request URL <code>/abc</code> but not the request URL
+<code>//abc</code>. The (non-regex) <code class="directive"><Location></code> directive behaves similarly when
+used for proxy requests. But when (non-regex) <code class="directive"><Location></code> is used for non-proxy requests it
+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
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</p>
- <hr />
+ 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>
- <h2><a id="locationmatch"
- name="locationmatch"><LocationMatch></a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <LocationMatch
- <em>regex</em>> ... </LocationMatch><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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> LocationMatch is
- only available in Apache 1.3 and later.
+<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
+ expression as an argument instead of a simple string. For
+ example:</p>
- <p>The <LocationMatch> directive provides for access
- control by URL, in an identical manner to <a
- href="#location"><Location></a>. However, it takes a
- regular expression as an argument instead of a simple string.
- For example:</p>
-<pre>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
<LocationMatch "/(extra|special)/data">
-</pre>
+</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>
- <strong>See also</strong>: <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
- <hr />
+ 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>
- <h2><a id="loglevel" name="loglevel">LogLevel
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> LogLevel
- <em>level</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>LogLevel
- warn</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> LogLevel is only
- available in 1.3 or later.
+<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
+ <em>level</em>s are available, in order of decreasing
+ significance:</p>
- <p>LogLevel adjusts the verbosity of the messages recorded in
- the error logs (see <a href="#errorlog">ErrorLog</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>
- <th>
+</tr>
+
+
+<tr>
+
+<th>
</th>
<th align="LEFT"><strong>Example</strong> </th>
- </tr>
- <tr>
- <td><code>emerg</code> </td>
+</tr>
+
+
+<tr>
+
+<td><code>emerg</code> </td>
<td>Emergencies - system is unusable.</td>
- </tr>
- <tr>
- <td>
+</tr>
+
+
+<tr>
+
+<td>
</td>
<td>"Child cannot open lock file. Exiting"</td>
- </tr>
- <tr>
- <td><code>alert</code> </td>
+</tr>
+
+
+<tr>
+
+<td><code>alert</code> </td>
<td>Action must be taken immediately.</td>
- </tr>
- <tr>
- <td>
+</tr>
+
+
+<tr>
+
+<td>
</td>
<td>"getpwuid: couldn't determine user name from uid"</td>
- </tr>
- <tr>
- <td><code>crit</code> </td>
+</tr>
+
+
+<tr>
+
+<td><code>crit</code> </td>
<td>Critical Conditions.</td>
- </tr>
- <tr>
- <td>
+</tr>
+
+
+<tr>
+
+<td>
</td>
<td>"socket: Failed to get a socket, exiting child"</td>
- </tr>
- <tr>
- <td><code>error</code> </td>
+</tr>
+
+
+<tr>
+
+<td><code>error</code> </td>
<td>Error conditions.</td>
- </tr>
- <tr>
- <td>
+</tr>
+
+
+<tr>
+
+<td>
</td>
<td>"Premature end of script headers"</td>
- </tr>
- <tr>
- <td><code>warn</code> </td>
+</tr>
+
+
+<tr>
+
+<td><code>warn</code> </td>
<td>Warning conditions.</td>
- </tr>
- <tr>
- <td>
+</tr>
+
+
+<tr>
+
+<td>
</td>
<td>"child process 1234 did not exit, sending another
SIGHUP"</td>
- </tr>
- <tr>
- <td><code>notice</code> </td>
+</tr>
+
+
+<tr>
+
+<td><code>notice</code> </td>
<td>Normal but significant condition.</td>
- </tr>
- <tr>
- <td>
+</tr>
+
+
+<tr>
+
+<td>
</td>
<td>"httpd: caught SIGBUS, attempting to dump core in
..."</td>
- </tr>
- <tr>
- <td><code>info</code> </td>
+</tr>
+
+
+<tr>
+
+<td><code>info</code> </td>
<td>Informational.</td>
- </tr>
- <tr>
- <td>
+</tr>
+
+
+<tr>
+
+<td>
</td>
<td>"Server seems busy, (you may need to increase
StartServers, or Min/MaxSpareServers)..."</td>
- </tr>
- <tr>
- <td><code>debug</code> </td>
+</tr>
+
+
+<tr>
+
+<td><code>debug</code> </td>
<td>Debug-level messages</td>
- </tr>
- <tr>
- <td>
+</tr>
+
+
+<tr>
+
+<td>
</td>
<td>"Opening config file ..."</td>
- </tr>
- </table>
- <p>When a particular level is specified, messages from all
+</tr>
+
+</table>
+
+
+<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>
- <hr />
- <h2><a id="maxkeepaliverequests"
- name="maxkeepaliverequests">MaxKeepAliveRequests
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> MaxKeepAliveRequests
- <em>number</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>MaxKeepAliveRequests 100</code><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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Only available
- in Apache 1.2 and later.
+</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 MaxKeepAliveRequests directive limits the number of
- requests allowed per connection when <a
- href="#keepalive">KeepAlive</a> is on. If it is set to
- "<code>0</code>", unlimited requests will be allowed. We
+<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
+ 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>
- <hr />
- <h2><a id="namevirtualhost"
- name="namevirtualhost">NameVirtualHost directive</a></h2>
+</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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> NameVirtualHost
- <em>addr</em>[:<em>port</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> NameVirtualHost
- is only available in Apache 1.3 and later
+<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>The NameVirtualHost 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>
- <code>NameVirtualHost 111.22.33.44</code>
- </blockquote>
- With the NameVirtualHost 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 where a
- firewall or other proxy receives the requests and forwards them
- on a different IP address to the server, you must specify the
- IP address of the physical interface on the machine which will
- be servicing the requests. If you have multiple name-based
- hosts on multiple addresses, repeat the directive for each
- address.
- <p>Note: the "main server" and any _default_ servers will
+<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
+ 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
+ where a firewall or other proxy receives the requests and forwards
+ them on a different IP address to the server, you must specify the
+ IP address of the physical interface on the machine which will be
+ 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
<strong>never</strong> be served for a request to a
- NameVirtualHost IP Address (unless for some reason you specify
- NameVirtualHost but then don't define any VirtualHosts for that
- address).</p>
+ <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>
- <blockquote>
- <code>NameVirtualHost 111.22.33.44:8080</code>
- </blockquote>
+<p>Optionally you can specify a port number on which the
+ name-based virtual hosts should be used, <em>e.g.</em>
+</p>
- <p>IPv6 addresses must be enclosed in square brackets, as shown
+
+<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
in the following example:</p>
- <blockquote>
- <code>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</code>
- </blockquote>
- <strong>See also:</strong> <a href="../vhosts/">Apache Virtual
- Host documentation</a>
- <hr />
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</code></td>
+</tr>
+</table>
+</blockquote>
- <h2><a id="options" name="options">Options directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Options
- [+|-]<em>option</em> [[+|-]<em>option</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> Options<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core
+</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 Options directive controls which server features are
- available in a particular directory.</p>
+<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>
- <dd>All options except for MultiViews. This is the default
+<dl>
+
+<dt>All</dt>
+
+
+<dd>All options except for MultiViews. This is the default
setting.</dd>
- <dt>ExecCGI</dt>
- <dd>
+<dt>ExecCGI</dt>
+
+
+<dd>
Execution of CGI scripts is permitted.</dd>
- <dt>FollowSymLinks</dt>
- <dd>
+<dt>FollowSymLinks</dt>
- The server will follow symbolic links in this
- directory.<br />
- <strong>Note</strong>: even though the server follows the
- symlink it does <em>not</em> change the pathname used to
- match against <code><Directory></code> sections.<br />
- <strong>Note</strong>: this option gets ignored if set
- inside a <Location> section.</dd>
- <dt>Includes</dt>
+<dd>
- <dd>
+ The server will follow symbolic links in this directory.<br>
+
+<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>
+ section.</dd>
+
+
+<dt>Includes</dt>
+
+
+<dd>
Server-side includes are permitted.</dd>
- <dt>IncludesNOEXEC</dt>
- <dd>
+<dt>IncludesNOEXEC</dt>
+
+
+<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>
- <dd>
+<dt>Indexes</dt>
+
+
+<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>
- <dd>
- <a href="../content-negotiation.html">Content negotiated</a>
+<dt>MultiViews</dt>
+
+
+<dd>
+
+<a href="../content-negotiation.html">Content negotiated</a>
MultiViews are allowed.</dd>
- <dt>SymLinksIfOwnerMatch</dt>
- <dd>
+<dt>SymLinksIfOwnerMatch</dt>
- 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 <Location> section.</dd>
- </dl>
- Normally, if multiple <code>Options</code> could apply to a
+
+<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>
+ section.</dd>
+
+</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>Options</code> directive are preceded by a + or -
+ the <code class="directive">Options</code> directive are preceded by a + or -
symbol, the options are merged. Any options preceded by a + are
added to the options currently in force, and any options
preceded by a - are removed from the options currently in
- force.
+ force. </p>
- <p>For example, without any + and - symbols:</p>
- <blockquote>
- <code><Directory /web/docs><br />
- Options Indexes FollowSymLinks<br />
- </Directory><br />
- <Directory /web/docs/spec><br />
- Options Includes<br />
- </Directory></code>
- </blockquote>
- then only <code>Includes</code> will be set for the
+<p>For example, without any + and - symbols:</p>
+
+
+
+<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
/web/docs/spec directory. However if the second
- <code>Options</code> directive uses the + and - symbols:
+ <code class="directive">Options</code> directive uses the + and - symbols:</p>
- <blockquote>
- <code><Directory /web/docs><br />
- Options Indexes FollowSymLinks<br />
- </Directory><br />
- <Directory /web/docs/spec><br />
- Options +Includes -Indexes<br />
- </Directory></code>
- </blockquote>
- then the options <code>FollowSymLinks</code> and
- <code>Includes</code> are set for the /web/docs/spec directory.
+
+<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>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
- <code>All</code>.</p>
- <hr />
- <h2><a id="require" name="require">Require directive</a></h2>
+<p>The default in the absence of any other settings is
+ <code>All</code>.</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Require
- <em>entity-name</em> [<em>entity-name</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> AuthConfig<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core
+</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
+<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>
- <p>Require must be accompanied by <a
- href="#authname">AuthName</a> and <a
- href="#authtype">AuthType</a> directives, and directives such
- as <a href="mod_auth.html#authuserfile">AuthUserFile</a> and <a
- href="mod_auth.html#authgroupfile">AuthGroupFile</a> (to define
- users and groups) in order to work correctly. Example:</p>
+</li>
- <blockquote>
- <code>AuthType Basic<br />
- AuthName "Restricted Directory"<br />
- AuthUserFile /web/users<br />
- AuthGroupFile /web/groups<br />
- Require group admin<br />
- </code>
- </blockquote>
- Access controls which are applied in this way are effective for
+</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
+ define users and groups) in order to work correctly. Example:</p>
+
+
+<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>
+
+
+<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>Require</code> statement into a <a
- href="#limit"><Limit></a> section
-
- <p>See also <a href="#satisfy">Satisfy</a> and <a
- href="mod_access.html">mod_access</a>.</p>
- <hr />
-
- <h2><a id="rlimit" name="rlimit">RLimitCPU</a> <a
- id="rlimitcpu" name="rlimitcpu">directive</a></h2>
+ place the <code class="directive">Require</code> statement into a
+ <code class="directive"><a href="#limit" class="directive"><Limit></a></code>
+ section.</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RLimitCPU
- <em>number</em>|max [<em>number</em>|max] <br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>Unset; uses
- operating system defaults</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> RLimitCPU is
- only available in Apache 1.2 and later. Moved in version 2.0 to
- the <a href="../mpm.html">MPMs</a>.
+</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
+<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
@@ -2217,39 +3590,68 @@
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
- process.</p>
-
- <p>See also <a href="#rlimitmem">RLimitMEM</a> or <a
- href="#rlimitnproc">RLimitNPROC</a>.</p>
- <hr />
- <h2><a id="rlimitmem" name="rlimitmem">RLimitMEM
- directive</a></h2>
+<p>CPU resource limits are expressed in seconds per
+ process.</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RLimitMEM
- <em>number</em>|max [<em>number</em>|max]<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>Unset; uses
- operating system defaults</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> RLimitMEM is
- only available in Apache 1.2 and later. Moved in version 2.0 to
- the <a href="../mpm.html">MPMs</a>.
+</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
+<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
@@ -2258,39 +3660,68 @@
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
- process.</p>
-
- <p>See also <a href="#rlimitcpu">RLimitCPU</a> or <a
- href="#rlimitnproc">RLimitNPROC</a>.</p>
- <hr />
- <h2><a id="rlimitnproc" name="rlimitnproc">RLimitNPROC
- directive</a></h2>
+<p>Memory resource limits are expressed in bytes per
+ process.</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RLimitNPROC
- <em>number</em>|max [<em>number</em>|max]<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>Unset; uses
- operating system defaults</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> RLimitNPROC is
- only available in Apache 1.2 and later. Moved in version 2.0 to
- the <a href="../mpm.html">MPMs</a>.
+</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
+<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
@@ -2299,155 +3730,282 @@
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>Note: If CGI processes are <strong>not</strong> running
+<p>Process limits control the number of processes per user.</p>
+
+
+<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>
- <p>See also <a href="#rlimitmem">RLimitMEM</a> or <a
- href="#rlimitcpu">RLimitCPU</a>.</p>
- <hr />
-
- <h2><a id="satisfy" name="satisfy">Satisfy directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Satisfy any|all<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> Satisfy all<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Satisfy is only
- available in Apache 1.2 and later
-
- <p>Access policy if both <code>Allow</code> and
- <code>Require</code> 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 the default behavior ("all") is to require that the client
- passes the address access restriction <em>and</em> enters a
- valid username and password. With the "any" option the client
- will be granted access if they either pass the host restriction
- or enter a 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>
-
- <p>See also <a href="#require">Require</a> and <a
- href="mod_access.html">mod_access</a>.</p>
- <hr />
+</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>
- <h2><a id="scriptinterpretersource"
- name="scriptinterpretersource">ScriptInterpreterSource
- directive</a></h2>
+<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
+ 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
+ the default behavior ("all") is to require that the client passes
+ the address access restriction <em>and</em> enters a valid
+ username and password. With the "any" option the client will be
+ granted access if they either pass the host restriction or enter a
+ 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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ScriptInterpreterSource
- registry|script<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>ScriptInterpreterSource script</code> <br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core (Windows only)
+</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 1.3.5 and later
- 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 ScriptInterpreterSource registry will
+<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>
- <hr />
-
- <h2><a id="serveradmin" name="serveradmin">ServerAdmin
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ServerAdmin
- <em>email-address</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> core
+</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 ServerAdmin sets the e-mail address that the server
- includes in any error messages it returns to the client.</p>
+<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>
- <code>ServerAdmin www-admin@foo.bar.com</code>
- </blockquote>
- as users do not always mention that they are talking about the
- server!
- <hr />
+<p>It may be worth setting up a dedicated address for this,
+ <em>e.g.</em>
+</p>
- <h2><a id="serveralias" name="serveralias">ServerAlias
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ServerAlias
- <em>hostname</em> [<em>hostname</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> virtual host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ServerAlias is
- only available in Apache 1.1 and later.
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>ServerAdmin www-admin@foo.bar.com</code></td>
+</tr>
+</table>
+</blockquote>
- <p>The ServerAlias directive sets the alternate names for a
- host, for use with <a
- href="../vhosts/name-based.html">name-based virtual
- hosts</a>.</p>
+<p>as users do not always mention that they are talking about the
+ server!</p>
- <p>Example:</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>
- <pre>
- <VirtualHost *>
- ServerName server.domain.com
- ServerAlias server server2.domain.com server2
- ...
- </VirtualHost>
- </pre>
+<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>
- <p><strong>See also:</strong> <a href="../vhosts/">Apache
- Virtual Host documentation</a></p>
- <hr />
- <h2><a id="servername" name="servername">ServerName
- directive</a></h2>
+<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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ServerName
- <em>fully-qualified-domain-name[:port]</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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> In version 2.0, this
- directive supercedes the functionality of the <code>Port</code>
- directive from version 1.3.
+</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
+ directive supersedes the functionality of the Port
+ directive from version 1.3.</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
- <p>The <code>ServerName</code> directive sets the hostname and
+<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>,
@@ -2455,348 +4013,606 @@
and you wish the webserver to be so identified, the following
directive should be used:</p>
- <blockquote>
- <code>ServerName www.example.com:80</code>
- </blockquote>
- <p>If no <code>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 request. For optimal
- reliability and predictability, you should specify an explict
- hostname and port using the <code>ServerName</code> directive.</p>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>ServerName www.example.com:80</code></td>
+</tr>
+</table>
+</blockquote>
- <p>If you are using <a
- href="../vhosts/name-based.html">name-based virtual hosts</a>,
- the <code>ServerName</code> inside a <a
- href="#virtualhost"><code><VirtualHost></code></a>
+
+<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
+ request. For optimal reliability and predictability, you should
+ 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>,
+ the <code class="directive">ServerName</code> inside a
+ <code class="directive"><a href="#virtualhost" class="directive"><VirtualHost></a></code>
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
- <a href="#usecanonicalname">UseCanonicalName</a> directive for
+
+<p>See the description of the
+ <code class="directive"><a href="#usecanonicalname" class="directive">UseCanonicalName</a></code> directive for
settings which determine whether self-referential URL's (e.g., by the
- <a href="mod_dir.html">mod_dir</a> module) will refer to 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>
- <p><strong>See Also</strong>:<br />
- <a href="../dns-caveats.html">DNS Issues</a><br />
- <a href="../vhosts/">Apache virtual host
- documentation</a><br />
- <a href="#usecanonicalname">UseCanonicalName</a><br />
- <a href="#namevirtualhost">NameVirtualHost</a><br />
- <a href="#serveralias">ServerAlias</a><br />
- </p>
- <hr />
-
- <h2><a id="serverpath" name="serverpath">ServerPath
- directive</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ServerPath
- <em>directory-path</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> virtual host<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ServerPath is
- only available in Apache 1.1 and later.
-
- <p>The ServerPath directive sets the legacy URL pathname for a
- host, for use with <a href="../vhosts/">name-based virtual
- hosts</a>.</p>
-
- <p><strong>See also:</strong> <a href="../vhosts/">Apache
- Virtual Host documentation</a></p>
- <hr />
+</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>
- <h2><a id="serverroot" name="serverroot">ServerRoot
- directive</a></h2>
+<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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ServerRoot
- <em>directory-path</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>ServerRoot
- /usr/local/apache</code><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> core
+</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 ServerRoot 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
+<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>
- <p>See also <a href="../invoking.html">the <code>-d</code>
- option to httpd</a>.</p>
-
- <p>See also <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.</p>
- <hr />
-
- <h2><a id="serversignature"
- name="serversignature">ServerSignature directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ServerSignature
- On|Off|EMail<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>ServerSignature
- 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#Status"
- rel="Help"><strong>Status:</strong></a> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ServerSignature
- is only available in Apache 1.3 and later.
+ 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 ServerSignature 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 such a footer
- line is that in a chain of proxies, the user often has no
- possibility to tell which of the chained servers actually
- produced a returned error message.<br />
- The <samp>Off</samp> 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 <a
- href="#servername">ServerName</a> of the serving virtual host,
+<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
+ such a footer line is that in a chain of proxies, the user often
+ has no possibility to tell which of the chained servers actually
+ produced a returned error message.<br> The <samp>Off</samp>
+ 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,
and the <samp>EMail</samp> setting additionally creates a
- "mailto:" reference to the <a
- href="#serveradmin">ServerAdmin</a> of the referenced
+ "mailto:" reference to the <code class="directive"><a href="#serveradmin" class="directive">ServerAdmin</a></code> of the referenced
document.</p>
- <hr />
- <h2><a id="servertokens" name="servertokens">ServerTokens
- directive</a></h2>
-
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ServerTokens
- Minimal|ProductOnly|OS|Full<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>ServerTokens
- Full</code><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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ServerTokens is
- only available in Apache 1.3 and later; the
- <code>ProductOnly</code> keyword is only available in versions
- later than 1.3.12
+</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
+<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>
- <dd>Server sends (<em>e.g.</em>): <samp>Server:
- Apache</samp></dd>
+<dl>
- <dt><code>ServerTokens Min[imal]</code></dt>
+<dt>
+<code>ServerTokens Prod[uctOnly]</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</samp>
+</dd>
- <dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0
- (Unix)</samp></dd>
- <dt><code>ServerTokens Full</code> (or not specified)</dt>
+<dt>
+<code>ServerTokens Min[imal]</code>
+</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
+<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>
+
+
+<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
enabled or disabled on a virtualhost-by-virtualhost basis.</p>
- <hr />
- <h2><a id="sethandler" name="sethandler">SetHandler</a>
- directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SetHandler
- <em>handler-name</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory, files,
- location, .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> core<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> SetHandler was
- introduced in mod_mime with Apache 1.1, and moved into the core
- with Apache 2.0
+</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><Directory></code> or <code><Location></code>
+<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>
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>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
SetHandler imap-file
-</pre>
+</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 access.conf:</p>
-<pre>
- <Location /status>
- SetHandler server-status
- </Location>
-</pre>
- <hr />
+ the following into httpd.conf:</p>
- <h2><a id="setinputfilter" name="setinputfilter">SetInputFilter
- directive</a></h2>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ <Location /status><br>
+ SetHandler server-status<br>
+ </Location>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SetInputFilter
- <em>filter</em>[<em>;filter</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> directory, files,
- location, .htaccess<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core</p>
+</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>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 <a
- href="mod_mime.html#addinputfilter">AddInputFilter</a>
+<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>
directive.</p>
- <p>If more than one filter is specified, they must be seperated
+
+<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>
- <p>See also the <a href="../filter.html">Filters</a>
- documentation.</p>
- <hr />
-
- <h2><a id="setoutputfilter"
- name="setoutputfilter">SetOutputFilter directive</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SetOutputFilter
- <em>filter</em> [<em>filter</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> directory, files,
- location, .htaccess<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> core</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>SetOutputFilter</code> directive sets the filters
+<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 <a
- href="mod_mime.html#addoutputfilter">AddOutputFilter</a>
+ elsewhere, including the
+ <code class="directive"><a href="mod_mime.html#addoutputfilter" class="directive">AddOutputFilter</a></code>
directive.</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.<br />
- <br />
+ includes.</p>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+<Directory /www/data/><br>
+ SetOutputFilter INCLUDES<br>
+</Directory>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <blockquote>
- <code><Directory /www/data/><br />
- SetOutputFilter INCLUDES<br />
- </Directory></code>
- </blockquote>
- <p>If more than one filter is specified, they must be seperated
+<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>
- <p>See also the <a href="../filter.html">Filters</a>
- documentation.</p>
- <hr />
+</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>
- <h2><a id="timeout" name="timeout">TimeOut directive</a></h2>
+<p>The <code class="directive">TimeOut</code> directive currently defines
+ the amount of time Apache will wait for three things:</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> TimeOut
- <em>number</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>TimeOut
- 300</code><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> core
- <p>The TimeOut directive currently defines the amount of time
- Apache will wait for three things:</p>
+<ol>
- <ol>
- <li>The total amount of time it takes to receive a GET
+<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>
- We plan on making these separately configurable at some point
+
+</ol>
+
+
+<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.
- <hr />
+ the timer is not reset when a packet is sent. </p>
- <h2><a id="usecanonicalname"
- name="usecanonicalname">UseCanonicalName directive</a></h2>
+</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>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> UseCanonicalName
- on|off|dns<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>UseCanonicalName
- on</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Options<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> UseCanonicalName
- is only available in Apache 1.3 and later
+<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
+ 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>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> (and
- in all versions prior to 1.3) Apache will use the hostname and
- port specified in the <a href="#servername">ServerName</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
@@ -2806,7 +4622,8 @@
<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
@@ -2816,135 +4633,195 @@
authentication enabled, this will cause the user to have to
reauthenticate twice (once for <code>www</code> and once again
for <code>www.domain.com</code>). But if
- <code>UseCanonicalName</code> is set off, then Apache will
+ <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>
- <p><strong>See also:</strong> <a
- href="#servername">ServerName</a>, <a
- href="mpm_common.html#listen">Listen</a></p>
- <hr />
+</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
+ <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>
- <h2><a id="virtualhost" name="virtualhost"><VirtualHost>
- directive</a></h2>
+<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
+ used. When the server receives a request for a document on a
+ particular virtual host, it uses the configuration directives
+ enclosed in the <code class="directive"><VirtualHost></code>
+ section. <em>Addr</em> can be</p>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> <VirtualHost
- <em>addr</em>[:<em>port</em>] [<em>addr</em>[:<em>port</em>]]
- ...> ... </VirtualHost> <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> Core.<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Non-IP
- address-based Virtual Hosting only available in Apache 1.1 and
- later.<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Multiple address
- support only available in Apache 1.2 and later.
- <p><VirtualHost> and </VirtualHost> 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 used. When the server receives a
- request for a document on a particular virtual host, it uses
- the configuration directives enclosed in the
- <VirtualHost> section. <em>Addr</em> can be</p>
+<ul>
- <ul>
- <li>The IP address of the virtual host</li>
+<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>
- <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>
- </blockquote>
+<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>
- <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>
- <code><VirtualHost [fe80::a00:20ff:fea7:ccea]><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>
- </blockquote>
- <p>Each VirtualHost must correspond to a different IP address,
+<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>
+ 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>
+
+
+<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
not have multiple network interfaces, then this can be
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>
+ 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 matched. If unspecified then it defaults to the same port as
- the most recent <code><a
- href="mpm_common.html#listen">Listen</a></code> statement
- of the main server. You may also specify <code>:*</code> to
- match all ports on that address. (This is recommended when used
+
+<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>
+ 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 <VirtualHost> does
- <strong>not</strong> affect what addresses Apache listens on.
- You may need to ensure that Apache is listening on the correct
- addresses using <a
- href="mpm_common.html#listen">Listen</a>.</p>
- <p><strong>See also:</strong> <a href="../vhosts/">Apache
- Virtual Host documentation</a><br />
- <strong>See also:</strong> <a
- href="../dns-caveats.html">Warnings about DNS and
- Apache</a><br />
- <strong>See also:</strong> <a href="../bind.html">Setting
- which addresses and ports Apache uses</a><br />
- <strong>See also</strong>: <a href="../sections.html">How
+<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
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
- request is received</p>
- <!--#include virtual="footer.html" -->
- </body>
+ 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>
-
1.30 +402 -267 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.29
retrieving revision 1.30
diff -u -d -b -u -r1.29 -r1.30
--- mod_access.html 19 Feb 2002 14:29:51 -0000 1.29
+++ mod_access.html 19 Feb 2002 18:37:19 -0000 1.30
@@ -1,303 +1,429 @@
-<!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_access</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_access</h1>
-
- <p>This module provides access control based on client
- hostname, IP address, or other characteristics of the client
- request.</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_access.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- access_module</p>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
- <h2>Summary</h2>
+<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
+ <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
+ 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>
+ 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
+ other.</p>
- <p>The directives provided by mod_access are used in <code><a
- href="core.html#directory"><Directory></a>, <a
- href="core.html#files"><Files></a>,</code> and <code><a
- href="core.html#location"><Location></a></code> 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>Allow</code> and <code>Deny</code> directives are used to
- specify which clients are or are not allowed access to the
- server, while the <code>Order</code> directive sets the default
- access state, and configures how the <code>Allow</code> and
- <code>Deny</code> 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 <a href="core.html#satsify">Satisfy</a> directive is used
+ the <code class="directive"><a href="core.html#satisfy" class="directive">Satisfy</a></code> 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 <a href="core.html#limit"><Limit></a> section.</p>
-
- <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>
-
- <p>See also <a href="core.html#satisfy">Satisfy</a> and <a
- href="core.html#require">Require</a>.</p>
- <hr />
-
- <h2><a id="allow" name="allow">Allow</a> <a id="allowfromenv"
- name="allowfromenv">directive</a></h2>
+ in a <code class="directive"><a href="core.html#<limit>" class="directive"><Limit></a></code> section.</p>
- <p><!--%plaintext <?INDEX {\tt Allow} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Allow from
+</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
all|<em>host</em>|env=<em>env-variable</em>
- [<em>host</em>|env=<em>env-variable</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Limit<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_access</p>
+ [<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>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>Deny</code> and <code>Order</code> 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>
+ 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
+ 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>
- <dd>Example: <code>Allow from apache.org</code><br />
+<dl>
+
+<dt>A (partial) domain-name</dt>
+
+
+<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 <a
- href="core.html#hostnamelookups">HostnameLookups</a>
+ client IP address, regardless of the setting of the <code class="directive"><a href="core.html#hostnamelookups" class="directive">HostnameLookups</a></code>
directive.</dd>
- <dt>A full IP address</dt>
- <dd>Example: <code>Allow from 10.1.2.3</code><br />
+<dt>A full IP address</dt>
+
+
+<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>
- <dd>Example: <code>Allow from 10.1</code><br />
+<dt>A partial IP address</dt>
+
+
+<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>
- <dd>Example: <code>Allow from
- 10.1.0.0/255.255.0.0</code><br />
+<dt>A network/netmask pair</dt>
+
+
+<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>
- <dd>Example: <code>Allow from 10.1.0.0/16</code><br />
+<dt>A network/nnn CIDR specification</dt>
+
+
+<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>
- <p>Note that the last three examples above match exactly the
+</dl>
+
+
+<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>
- <pre>
- Allow from fe80::a00:20ff:fea7:ccea
+
+<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
- </pre>
+ </code></td>
+</tr>
+</table>
+</blockquote>
- <p>The third format of the arguments to the <code>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 allowed access if the environment variable
- <em>env-variable</em> exists. The server provides the ability
- to set environment variables in a flexible way based on
- characteristics of the client request using the directives
- provided by <a href="mod_setenvif.html">mod_setenvif</a>.
- Therefore, this directive can be used to allow access based on
- such factors as the clients <code>User-Agent</code> (browser
- type), <code>Referer</code>, or other HTTP request header
- fields.</p>
- <p>Example:</p>
+<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
+ allowed access if the environment variable <em>env-variable</em>
+ exists. The server provides the ability to set environment
+ variables in a flexible way based on characteristics of the client
+ request using the directives provided by
+ <code><a href="mod_setenvif.html">mod_setenvif</a></code>. Therefore, this directive can be
+ used to allow access based on such factors as the clients
+ <code>User-Agent</code> (browser type), <code>Referer</code>, or
+ other HTTP request header fields.</p>
- <blockquote>
-<pre>
-SetEnvIf User-Agent ^KnockKnock/2.0 let_me_in
-<Directory /docroot>
- Order Deny,Allow
- Deny from all
- Allow from env=let_me_in
-</Directory>
-</pre>
- </blockquote>
- <p>In this case, browsers with a user-agent string beginning
- with <tt>KnockKnock/2.0</tt> will be allowed access, and all
- others will be denied.</p>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee">
+<p align="center">
+<strong>Example:</strong>
+</p>
+<code>
- <p>See also <a href="#deny">Deny</a>, <a
- href="#order">Order</a> and <a
- href="mod_setenvif.html#SetEnvIf">SetEnvIf</a>.</p>
- <hr />
+SetEnvIf User-Agent ^KnockKnock/2.0 let_me_in<br>
+<Directory /docroot><br>
+ Order Deny,Allow<br>
+ Deny from all<br>
+ Allow from env=let_me_in<br>
+</Directory>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <h2><a id="deny" name="deny">Deny</a> <a id="denyfromenv"
- name="denyfromenv">directive</a></h2>
- <p><!--%plaintext <?INDEX {\tt Deny} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Deny from
+<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
all|<em>host</em>|env=<em>env-variable</em>
- [<em>host</em>|env=<em>env-variable</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Limit<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_access</p>
+ [<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
+<p>This directive allows access to the server to be restricted
based on hostname, IP address, or environment variables. The
- arguments for the <code>Deny</code> directive are identical to
- the arguments for the <a href="#allow">Allow</a> directive.</p>
-
- <p>See also <a href="#allow">Allow</a>, <a
- href="#order">Order</a> and <a
- href="mod_setenvif.html#SetEnvIf">SetEnvIf</a>.</p>
- <hr />
+ 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>
- <h2><a id="order" name="order">Order directive</a></h2>
+</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
+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>
- <p><!--%plaintext <?INDEX {\tt Order} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Order
- <em>ordering</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>Order
- Deny,Allow</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Limit<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_access</p>
- <p>The <code>Order</code> directive controls the default access
- state and the order in which <a href="#allow">Allow</a> and <a
- href="#deny">Deny</a> directives are evaluated.
+<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.
<em>Ordering</em> is one of</p>
- <dl>
- <dt>Deny,Allow</dt>
- <dd>The <code>Deny</code> directives are evaluated before the
- <code>Allow</code> directives. Access is allowed by default.
- Any client which does not match a <code>Deny</code> directive
- or does match an <code>Allow</code> directive will be allowed
- access to the server.</dd>
+<dl>
- <dt>Allow,Deny</dt>
+<dt>Deny,Allow</dt>
- <dd>The <code>Allow</code> directives are evaluated before
- the <code>Deny</code> directives. Access is denied by
- default. Any client which does not match an
- <code>Allow</code> directive or does match a
- <code>Deny</code> directive will be denied access to the
- server.</dd>
- <dt>Mutual-failure</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
+ 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>
+ directive will be allowed access to the server.</dd>
- <dd>Only those hosts which appear on the <code>Allow</code>
- list and do not appear on the <code>Deny</code> 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>
- <p>Keywords may only be separated by a comma; no whitespace is
- allowed between them. Note that in all cases every
- <code>Allow</code> and <code>Deny</code> statement is
- evaluated.</p>
+<dt>Allow,Deny</dt>
- <p>In the following example, all hosts in the apache.org domain
+
+<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
+ denied access to the server.</dd>
+
+
+<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
+ granted access. This ordering has the same effect as <code>Order
+ Allow,Deny</code> and is deprecated in favor of that
+ configuration.</dd>
+
+</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>In the following example, all hosts in the apache.org domain
are allowed access; all other hosts are denied access.</p>
- <blockquote>
- <code>Order Deny,Allow<br />
- Deny from all<br />
- Allow from apache.org<br />
- </code>
- </blockquote>
- <p>In the next example, all hosts in the apache.org domain are
+<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>
+
+
+<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>
- <code>Order Allow,Deny<br />
- Allow from apache.org<br />
- Deny from foo.apache.org<br />
- </code>
- </blockquote>
- <p>On the other hand, if the <code>Order</code> in the last
+<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>
+
+
+<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,
@@ -307,38 +433,47 @@
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
- access to a part of the server even in the absence of
- accompanying <code>Allow</code> and <code>Deny</code>
- directives because of its effect on the default access state.
- For example,</p>
- <blockquote>
- <code><Directory /www><br />
- Order Allow,Deny<br />
- </Directory></code>
- </blockquote>
+<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
+ on the default access state. For example,</p>
- <p>will deny all access to the <code>/www</code> directory
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ <Directory /www><br>
+ Order Allow,Deny<br>
+ </Directory>
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<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>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>Allow</code> or <code>Deny</code> directive
- occurring in a <Location> section will always be
- evaluated after an <code>Allow</code> or <code>Deny</code>
- directive occurring in a <Directory> section or
+
+<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
<code>.htaccess</code> file, regardless of the setting of the
- <code>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>
+ <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>
- <p>See also: <a href="#deny">Deny</a> and <a
- href="#allow">Allow</a>. <!--#include virtual="footer.html" -->
- </p>
- </body>
+</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>
-
1.18 +206 -111 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.17
retrieving revision 1.18
diff -u -d -b -u -r1.17 -r1.18
--- mod_actions.html 11 Nov 2001 02:09:07 -0000 1.17
+++ mod_actions.html 19 Feb 2002 18:37:19 -0000 1.18
@@ -1,122 +1,201 @@
-<!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>Module mod_actions</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_actions</h1>
-
- <p>This module provides for executing CGI scripts based on
- media type or request method.</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_actions.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- actions_module</p>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
- <h2>Summary</h2>
+<p>This module has two directives. The <code class="directive"><a href="#action" class="directive">Action</a></code> 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
+ 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>
- <p>This module has two directives. The Action directive lets
- you run CGI scripts whenever a file of a certain type is
- requested. The Script 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>
- <h2>Directives</h2>
+<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>
- <ul>
- <li><a href="#action">Action</a></li>
- <li><a href="#script">Script</a></li>
- </ul>
- <hr />
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee">
+<p align="center">
+<strong>Examples</strong>
+</p>
+<code>
- <h2><a id="action" name="action">Action directive</a></h2>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Action <em>action-type
- cgi-script</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_actions</p>
+ # Requests for files of a particular type:<br>
+ Action image/gif /cgi-bin/images.cgi<br>
- <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>
+<br>
+ # Files of a particular file extension<br>
+ AddHandler my-file-type .xyz<br>
+ Action my-file-type /cgi-bin/program.cgi<br>
- <p>Examples:</p>
- <pre>
- # Requests for files of a particular type:
- Action image/gif /cgi-bin/images.cgi
+</code></td>
+</tr>
+</table>
+</blockquote>
- # Files of a particular file extension
- AddHandler my-file-type .xyz
- Action my-file-type /cgi-bin/program.cgi
- </pre>
- <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>
- <p><strong>See also</strong>: <a
- href="mod_mime.html#addhandler">AddHandler</a></p>
-
- <hr />
-
- <h2><a id="script" name="script">Script directive</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Script <em>method
- cgi-script</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory<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_actions</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
- <i>cgi-script</i> when a file is requested using the method of
- <i>method</i>. It sends the URL and file path of the requested
+<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>
- Any arbitrary method name may be used. <b>Method names are
- case-sensitive</b>, so <code>Script PUT</code> and
+
+<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.
- </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>
@@ -124,14 +203,30 @@
(<em>e.g.</em>, foo.html?hi). Otherwise, the request will
proceed normally.</p>
- <p>Examples:</p>
-<pre>
- # For <ISINDEX>-style searching
- Script GET /cgi-bin/search
- # A CGI PUT handler
- Script PUT /~bob/put.cgi
-</pre>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
+<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>
1.33 +529 -298 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.32
retrieving revision 1.33
diff -u -d -b -u -r1.32 -r1.33
--- mod_alias.html 29 Jan 2002 15:46:58 -0000 1.32
+++ mod_alias.html 19 Feb 2002 18:37:19 -0000 1.33
@@ -1,367 +1,598 @@
-<!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_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_alias</h1>
-
- <p>This module provides for mapping different parts of the host
- filesystem in the document tree, and for URL redirection.</p>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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><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_alias.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- alias_module</p>
+<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
+ 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
+ additional effect of marking the target directory as containing
+ only CGI scripts.</p>
- <h2>Summary</h2>
- <p>The directives contained in this module allow for
- manipulation and control of URLs as requests arrive at the
- server. The <code>Alias</code> and <code>ScriptAlias</code>
- directives are used to map between URLs and filesystem paths.
- This allows for content which is not directly under the <a
- href="core.html#documentroot"><code>DocumentRoot</code></a> to
- be served as part of the web document tree. The
- <code>ScriptAlias</code> 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>
+ 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>The <code>Redirect</code> 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
- manipulating URLs is contained in the <a
- href="mod_rewrite.html"><code>mod_rewrite</code></a>
+<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>
- <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="#redirectperm">RedirectPermanent</a></li>
+</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>
- <li><a href="#scriptalias">ScriptAlias</a></li>
- <li><a href="#scriptaliasmatch">ScriptAliasMatch</a></li>
- </ul>
- <hr />
+<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
+ (%-decoded) path beginning with <em>url-path</em> will be mapped
+ to local files beginning with <em>directory-filename</em>.</p>
- <h2><a id="alias" name="alias">Alias directive</a></h2>
- <p><!--%plaintext <?INDEX {\tt Alias} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Alias <em>URL-path
- file-path</em>|<em>directory-path</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#Module"
- rel="Help"><strong>Module:</strong></a> mod_alias</p>
+<p>Example:</p>
- <p>The Alias directive allows documents to be stored in the
- local filesystem other than under the <a
- href="core.html#documentroot">DocumentRoot</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>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>Alias /image /ftp/pub/image</code></td>
+</tr>
+</table>
+</blockquote>
- <blockquote>
- <code>Alias /image /ftp/pub/image</code>
- </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 <a
- href="core.html#directory"><code><Directory></code></a>
- sections which cover the <em>destination</em> of aliases.
- Aliasing occurs before <code><Directory></code> sections
+
+<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
+ the <em>destination</em> of aliases. Aliasing occurs before
+ <code class="directive"><a href="core.html#<directory>" class="directive"><Directory></a></code> sections
are checked, so only the destination of aliases are affected.
- (Note however <a
- href="core.html#location"><code><Location></code></a>
+ (Note however <code class="directive"><a href="core.html#<location>" class="directive"><Location></a></code>
sections are run through once before aliases are performed, so
they will apply.)</p>
- <p>See also <a href="#scriptalias">ScriptAlias</a>.</p>
- <hr />
- <h2><a id="aliasmatch" name="aliasmatch">AliasMatch</a></h2>
+</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><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AliasMatch <em>regex
- file-path</em>|<em>directory-path</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#Module"
- rel="Help"><strong>Module:</strong></a> mod_alias</p>
+<p>This directive is equivalent to <code class="directive"><a href="#alias" class="directive">Alias</a></code>, 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>
- <p>This directive is equivalent to <a href="#alias">Alias</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>
-<pre>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
AliasMatch ^/icons(.*) /usr/local/apache/icons$1
-</pre>
- <br />
- <br />
-
- <hr />
-
- <h2><a id="redirect" name="redirect">Redirect
- directive</a></h2>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p><!--%plaintext <?INDEX {\tt Redirect} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Redirect
- [<em>status</em>] <em>URL-path URL</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_alias</p>
+</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
+<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>
- <blockquote>
- <code>Redirect /service http://foo2.bar.com/service</code>
- </blockquote>
+<p>Example:</p>
- <p>If the client requests http://myserver/service/foo.txt, it
+
+<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
will be told to access http://foo2.bar.com/service/foo.txt
instead.</p>
- <p><strong>Note:</strong> 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 <Directory>
- sections.</p>
- <p>If no <em>status</em> argument is given, the redirect will
+<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>
+
+
+<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>
- <dd>Returns a permanent redirect status (301) indicating that
+<dl>
+
+<dt>permanent</dt>
+
+
+<dd>Returns a permanent redirect status (301) indicating that
the resource has moved permanently.</dd>
- <dt>temp</dt>
- <dd>Returns a temporary redirect status (302). This is the
+<dt>temp</dt>
+
+
+<dd>Returns a temporary redirect status (302). This is the
default.</dd>
- <dt>seeother</dt>
- <dd>Returns a "See Other" status (303) indicating that the
+<dt>seeother</dt>
+
+
+<dd>Returns a "See Other" status (303) indicating that the
resource has been replaced.</dd>
- <dt>gone</dt>
- <dd>Returns a "Gone" status (410) indicating that the
+<dt>gone</dt>
+
+
+<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>
- <p>Other status codes can be returned by giving the numeric
+</dl>
+
+
+<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>
- <hr />
-
- <h2><a id="redirectmatch"
- name="redirectmatch">RedirectMatch</a></h2>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RedirectMatch
- [<em>status</em>] <em>regex URL</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_alias</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
+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 <a
- href="#redirect">Redirect</a>, but makes use of standard
+<p>This directive is equivalent to <code class="directive"><a href="#redirect" class="directive">Redirect</a></code>, 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
+ 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>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
RedirectMatch (.*)\.gif$ http://www.anotherserver.com$1.jpg
-</pre>
- <br />
- <br />
+</code></td>
+</tr>
+</table>
+</blockquote>
- <hr />
+</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>
- <h2><a id="redirecttemp" name="redirecttemp">RedirectTemp
- directive</a></h2>
+<p>This directive makes the client know that the Redirect is
+ permanent (status 301). Exactly equivalent to <code>Redirect
+ permanent</code>.</p>
- <p><!--%plaintext <?INDEX {\tt Redirect} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RedirectTemp
- <em>URL-path URL</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_alias</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
+<p>This directive makes the client know that the Redirect is
only temporary (status 302). Exactly equivalent to
<code>Redirect temp</code>.</p>
- <hr />
-
- <h2><a id="redirectperm" name="redirectperm">RedirectPermanent
- directive</a></h2>
-
- <p><!--%plaintext <?INDEX {\tt Redirect} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RedirectPermanent
- <em>URL-path URL</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_alias</p>
- <p>This directive makes the client know that the Redirect is
- permanent (status 301). Exactly equivalent to <code>Redirect
- permanent</code>.</p>
- <hr />
+</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>
- <h2><a id="scriptalias" name="scriptalias">ScriptAlias
- directive</a></h2>
+<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>
+ 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>
- <!--%plaintext <?INDEX {\tt ScriptAlias} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ScriptAlias
- <em>URL-path file-path</em>|<em>directory-path</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#Module"
- rel="Help"><strong>Module:</strong></a> mod_alias</p>
- <p>The ScriptAlias directive has the same behavior as the <a
- href="#alias">Alias</a> directive, except that in addition it
- marks the target directory as containing CGI scripts that will be
- processed by <a href="mod_cgi.html">mod_cgi</a>'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>
- <code>ScriptAlias /cgi-bin/ /web/cgi-bin/</code>
- </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 http://myserver/cgi-bin/foo would cause the
- server to run the script /web/cgi-bin/foo.</p>
- <hr />
- <h2><a id="scriptaliasmatch"
- name="scriptaliasmatch">ScriptAliasMatch</a></h2>
+<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>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ScriptAliasMatch
- <em>regex file-path</em>|<em>directory-path</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#Module"
- rel="Help"><strong>Module:</strong></a> mod_alias</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 <a
- href="#scriptalias">ScriptAlias</a>, but makes use of standard
+<p>This directive is equivalent to <code class="directive"><a href="#scriptalias" class="directive">ScriptAlias</a></code>, 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>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
ScriptAliasMatch ^/cgi-bin(.*) /usr/local/apache/cgi-bin$1
-</pre>
- <br />
- <br />
- <!--#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>
1.13 +101 -69 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.12
retrieving revision 1.13
diff -u -d -b -u -r1.12 -r1.13
--- mod_asis.html 7 Sep 2001 01:49:03 -0000 1.12
+++ mod_asis.html 19 Feb 2002 18:37:19 -0000 1.13
@@ -1,93 +1,125 @@
-<!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_asis</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_asis</h1>
-
- <p>This module provides for sending files which contain their
- own HTTP headers.</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_asis.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- asis_module</p>
-
- <h2>Summary</h2>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
+<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>
- <h2>Directives</h2>
+</summary>
+<h2>Directives</h2>
+<p>This module provides no directives.</p>
+<h2>Usage</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>
- <p>In the server configuration file, associate files with the
- <code>send-as-is</code> handler <em>e.g.</em></p>
- <blockquote>
- <code>AddHandler send-as-is asis</code>
- </blockquote>
- The contents of any file with a <code>.asis</code> extension
+<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
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.
+ 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>
- <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 />
- <HTML><br />
- <HEAD><br />
- <TITLE>Lame excuses'R'us</TITLE><br />
- </HEAD><br />
- <BODY><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>
+ <HTML><br>
+ <HEAD><br>
+ <TITLE>Lame excuses'R'us</TITLE><br>
+ </HEAD><br>
+ <BODY><br>
<H1>Fred's exceptionally wonderful page has moved
- to<br />
+ to<br>
<A
HREF="http://xyz.abc.com/foo/bar.html">Joe's</A>
- site.<br />
- </H1><br />
- </BODY><br />
- </HTML></code>
- </blockquote>
+ site.<br>
+ </H1><br>
+ </BODY><br>
+ </HTML>
+</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.
- <!--#include virtual="footer.html" -->
- </p>
- </body>
-</html>
+ 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>
1.25 +351 -201 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.24
retrieving revision 1.25
diff -u -d -b -u -r1.24 -r1.25
--- mod_auth.html 24 Jan 2002 23:47:31 -0000 1.24
+++ mod_auth.html 19 Feb 2002 18:37:19 -0000 1.25
@@ -1,218 +1,368 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
- <title>Apache module mod_auth</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
+<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>
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
- <h1 align="CENTER">Module mod_auth</h1>
+</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>
- <p>This module provides for user authentication using text
- 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_auth.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- auth_module</p>
+<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>
- <h2>Summary</h2>
- <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 <a href="mod_auth_dbm.html">mod_auth_dbm</a>.
- HTTP Digest Authentication is provided by <a
- href="mod_auth_digest.html">mod_auth_digest</a>.</p>
+<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
+ <code>modules.c</code> files) if there is <strong>no
+ userID</strong> or <strong>rule</strong> matching the supplied
+ userID. If there is a userID and/or rule specified; the usual
+ password and access checks will be applied and a failure will give
+ an Authorization Required reply.</p>
- <h2>Directives</h2>
- <ul>
- <li><a href="#authgroupfile">AuthGroupFile</a></li>
+<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>
+ 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>
- <li><a href="#authuserfile">AuthUserFile</a></li>
- <li><a href="#authauthoritative">AuthAuthoritative</a></li>
- </ul>
+<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>
- <p>See also: <a href="core.html#require">require</a> and <a
- href="core.html#satisfy">satisfy</a>.</p>
- <hr />
- <h2><a id="authgroupfile"
- name="authgroupfile">AuthGroupFile</a> directive</h2>
- <!--%plaintext <?INDEX {\tt AuthGroupFile} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AuthGroupFile
- <em>file-path</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> AuthConfig<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_auth
+<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>The AuthGroupFile 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 ServerRoot.</p>
- <p>Each line of the group file contains a groupname followed by
- a colon, followed by the member usernames separated by spaces.
+<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
+ 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
+ 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>
+
+
+<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>
- <code>mygroup: bob joe anne</code>
- </blockquote>
- Note that searching large text files is <em>very</em>
- inefficient; <a
- href="mod_auth_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a>
- should be used instead.
- <p>Security: make sure that the AuthGroupFile is stored outside
+<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
+ instead.</p>
+
+
+<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>
- <p>See also <a href="core.html#authname">AuthName</a>, <a
- href="core.html#authtype">AuthType</a> and <a
- href="#authuserfile">AuthUserFile</a>.</p>
- <hr />
+</td>
+</tr>
+</table>
+</blockquote>
- <h2><a id="authuserfile" name="authuserfile">AuthUserFile</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt AuthUserFile} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AuthUserFile
- <em>file-path</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> AuthConfig<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_auth
+</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 AuthUserFile 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
+<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 ServerRoot.</p>
+ with a slash), it is treated as relative to the <code class="directive"><a href="core.html#serverroot" class="directive">ServerRoot</a></code>.</p>
- <p>Each line of the user file file contains a username followed
- by a colon, followed by the crypt() encrypted password. The
- behavior of multiple occurrences of the same user is
+
+<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>
+ details. In short:</p>
- <blockquote>
- <code>htpasswd -c Filename username</code><br />
- Create a password file 'Filename' with 'username' as the
- initial ID. It will prompt for the password. <code>htpasswd
- Filename username2</code><br />
- Adds or modifies in password file 'Filename' the 'username'.
- </blockquote>
- <p>Note that searching large text files is <em>very</em>
- inefficient; <a
- href="mod_auth_dbm.html#authdbmuserfile">AuthDBMUserFile</a>
- should be used instead.</p>
+<p>Create a password file 'Filename' with 'username' as the
+ initial ID. It will prompt for the password:</p>
- <p>Security: 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>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>htpasswd -c Filename username</code></td>
+</tr>
+</table>
+</blockquote>
- <p>See also <a href="core.html#authname">AuthName</a>, <a
- href="core.html#authtype">AuthType</a> and <a
- href="#authgroupfile">AuthGroupFile</a>.</p>
- <hr />
- <h2><a id="authauthoritative"
- name="authauthoritative">AuthAuthoritative</a> directive</h2>
- <!--%plaintext <?INDEX {\tt AuthAuthoritative} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AuthAuthoritative
- on|off<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>AuthAuthoritative on</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> AuthConfig<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_auth
+<p>Adds or modifies in password file 'Filename' the 'username':</p>
- <p>Setting the AuthAuthoritative 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
- <code>modules.c</code> files) if there is <strong>no
- userID</strong> or <strong>rule</strong> matching the supplied
- userID. If there is a userID and/or rule specified; the usual
- password and access checks will be applied and a failure will
- give an Authorization Required reply.</p>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>htpasswd Filename username2</code></td>
+</tr>
+</table>
+</blockquote>
- <p>So if a userID appears in the database of more than one
- module; or if a valid <code>Require</code> 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
- database modules; such as <a href="mod_auth_dbm.html"><code
- >mod_auth_dbm.c</code></a>, <code>mod_auth_msql.c</code>, and <a
- href="mod_auth_anon.html"><code>mod_auth_anon.c</code></a>.
- 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 AuthUserFile.</p>
+<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
+ instead.</p>
- <p><a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> 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
- 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 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>
+<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>
- <p>See also <a href="core.html#authname">AuthName</a>, <a
- href="core.html#authtype">AuthType</a> and <a
- href="#authgroupfile">AuthGroupFile</a>.</p>
- <p><!--#include virtual="footer.html" -->
- </p>
- </body>
+</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>
-
1.47 +1 -3 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.46
retrieving revision 1.47
diff -u -d -b -u -r1.46 -r1.47
--- mod_include.html 21 Jan 2002 03:21:26 -0000 1.46
+++ mod_include.html 19 Feb 2002 18:37:19 -0000 1.47
@@ -709,10 +709,8 @@
potentially change on subsequent requests).</p>
</dd>
</dl>
- <hr />
- <p><!--#include virtual="footer.html" -->
- </p>
+ <!--#include virtual="footer.html" -->
</body>
</html>
1.14 +154 -84 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.13
retrieving revision 1.14
diff -u -d -b -u -r1.13 -r1.14
--- mod_info.html 14 Oct 2001 15:35:04 -0000 1.13
+++ mod_info.html 19 Feb 2002 18:37:19 -0000 1.14
@@ -1,103 +1,173 @@
-<!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_info</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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
+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>
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
- <h1 align="CENTER">Module mod_info</h1>
+<h2>Using mod_info</h2>
- <p>This module provides a comprehensive overview of the server
- configuration including all installed modules and directives in
- the configuration files.</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_info.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- info_module<br />
- <a href="module-dict.html#compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.1 and later.</p>
+<p>To configure it, add the following to your
+ <code>httpd.conf</code> file.</p>
- <h2>Directives</h2>
- <ul>
- <li><a href="#addmoduleinfo">AddModuleInfo</a></li>
- </ul>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+<Location /server-info><br>
+SetHandler server-info<br>
+</Location><br>
- <h2>Using mod_info</h2>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p>To configure it, add the following to your
- <code>httpd.conf</code> file.</p>
-<pre>
-<Location /server-info>
-SetHandler server-info
-</Location>
-</pre>
- 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 your server configuration information.
+ You may wish to add a
+ <code class="directive"><a href="core.html#<limit>" class="directive"><Limit></a></code>
+ clause inside the
+ <code class="directive"><a href="core.html#<location>" class="directive"><location></a></code>
+ directive to limit access to your server configuration
+ information.
<p>Once configured, the server information is obtained by
- accessing <tt>http://your.host.dom/server-info</tt></p>
+ accessing <code>http://your.host.dom/server-info</code>
+</p>
- <blockquote>
- <strong>Note that the configuration files are read by the
+
+<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
- <a href="mpm_common.html#user"><samp>User</samp></a> directive), or
- else the directive settings will not be listed.</strong>
+ <code class="directive"><a href="mpm_common.html#user" class="directive">User</a></code> directive), or
+ else the directive settings will not be listed.
- <p><strong>It should also be noted that if
- <samp>mod_info</samp> is compiled into the server, its
+ <p>It should also be noted that if
+ <code><a href="mod_info.html">mod_info</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>,
- <samp>.htaccess</samp>). This may have security-related
- ramifications for your site.</strong></p>
- </blockquote>
- <hr />
+ <code>.htaccess</code>). This may have security-related
+ ramifications for your site.</p>
- <h2><a id="addmoduleinfo"
- name="addmoduleinfo">AddModuleInfo</a></h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddModuleInfo
- <em>module-name string</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_info<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.3 and
- above
+</td>
+</tr>
+</table>
+</blockquote>
- <p>This allows the content of <em>string</em> to be shown as
+</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
HTML interpreted, <strong>Additional Information</strong> for
the module <em>module-name</em>. Example:</p>
- <blockquote>
-<pre>
+
+<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>'
-</pre>
- </blockquote>
- <!--#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>
1.62 +1969 -1384httpd-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.61
retrieving revision 1.62
diff -u -d -b -u -r1.61 -r1.62
--- mod_rewrite.html 6 Feb 2002 18:59:20 -0000 1.61
+++ mod_rewrite.html 19 Feb 2002 18:37:19 -0000 1.62
@@ -1,83 +1,86 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--%hypertext -->
-<!-- mod_rewrite.html -->
-<!-- Documentation for the mod_rewrite Apache module -->
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Apache module mod_rewrite</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <blockquote>
- <!-- page indentation -->
- <!--#include virtual="header.html" -->
- <br />
-
-
- <h1 align="CENTER">Module mod_rewrite<br />
- URL Rewriting Engine</h1>
-
- <p>This module provides a rule-based rewriting engine to
- rewrite requested URLs on the fly.</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_rewrite.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- rewrite_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.2 and later.</p>
- <hr noshade="noshade" size="1" />
- <br />
-
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
- <h2>Summary</h2>
+<blockquote>
- <blockquote>
- <blockquote>
- <blockquote>
- <em>``The great thing about mod_rewrite is it gives you
+<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">
- -- Brian Behlendorf<br />
+
+<div align="RIGHT">
+ -- Brian Behlendorf<br>
Apache Group
</div>
- </blockquote>
- </blockquote>
- </blockquote>
- <blockquote>
- <blockquote>
- <blockquote>
- <em>`` Despite the tons of examples and docs,
+</blockquote>
+
+
+<blockquote>
+
+<em>`` Despite the tons of examples and docs,
mod_rewrite is voodoo. Damned cool voodoo, but still
voodoo. ''</em>
- <div align="RIGHT">
- -- Brian Moore<br />
+
+<div align="RIGHT">
+ -- Brian Moore<br>
bem@news.cmc.net
</div>
- </blockquote>
- </blockquote>
- </blockquote>
- Welcome to mod_rewrite, the Swiss Army Knife of URL
- manipulation!
- <p>This module uses a rule-based rewriting engine (based on a
+</blockquote>
+
+
+
+<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
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
@@ -88,7 +91,8 @@
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
@@ -96,83 +100,78 @@
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
- 1996<br />
- 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>
- <hr noshade="noshade" size="1" />
-
- <h2>Table Of Contents</h2>
-
- <p><strong>Internal Processing</strong></p>
-
- <ul>
- <li><a href="#InternalAPI">API Phases</a></li>
-
- <li><a href="#InternalRuleset">Ruleset Processing</a></li>
-
- <li><a href="#InternalBackRefs">Regex Back-Reference
- Availability</a></li>
- </ul>
-
- <p><strong>Configuration Directives</strong></p>
-
- <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>
+<p>This module was invented and originally written in April
+ 1996 and gifted exclusively to the The Apache Group in July 1997
+ by</p>
- <li><a href="#RewriteLock">RewriteLock</a></li>
- <li><a href="#RewriteMap">RewriteMap</a></li>
+<blockquote>
- <li><a href="#RewriteBase">RewriteBase</a></li>
+<a href="http://www.engelschall.com/"><code>Ralf S.
+ Engelschall</code></a>
+<br>
- <li><a href="#RewriteCond">RewriteCond</a></li>
+<a href="mailto:rse@engelschall.com"><code>rse@engelschall.com</code></a>
+<br>
- <li><a href="#RewriteRule">RewriteRule</a></li>
- </ul>
- <strong>Miscellaneous</strong>
+<a href="http://www.engelschall.com/"><code>www.engelschall.com</code></a>
- <ul>
- <li><a href="#EnvVar">Environment Variables</a></li>
+</blockquote>
- <li><a href="#Solutions">Practical Solutions</a></li>
- </ul>
- <hr noshade="noshade" size="1" />
+</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>
- <center>
- <h1><a id="Internal" name="Internal">Internal
- Processing</a></h1>
- </center>
- <hr noshade="noshade" size="1" />
- <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>
- <h2><a id="InternalAPI" name="InternalAPI">API
- Phases</a></h2>
- <p>First you have to understand that when Apache processes a
+<h3>
+<a name="InternalAPI">API Phases</a>
+</h3>
+
+
+<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
@@ -182,7 +181,8 @@
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,8 +196,10 @@
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
@@ -206,7 +208,8 @@
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
@@ -233,14 +236,22 @@
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>
- <p>Don't forget these two points!</p>
+</li>
- <h2><a id="InternalRuleset" name="InternalRuleset">Ruleset
- Processing</a></h2>
- Now when mod_rewrite is triggered in these two API phases, it
+</ol>
+
+
+<p>Don't forget these two points!</p>
+
+
+
+<h3>
+<a name="InternalRuleset">Ruleset Processing</a>
+</h3>
+
+
+<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
@@ -249,35 +260,44 @@
rules together with their conditions). The operation of the
URL rewriting engine itself is exactly the same for both
configuration contexts. Only the final result processing is
- different.
+ 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>RewriteRule</code>
- 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>
+ through the ruleset rule by rule (<code class="directive"><a href="#rewriterule" class="directive">RewriteRule</a></code> 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>
- <tr>
- <td align="CENTER"><strong>Figure 1:</strong> The
+<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
control flow through the rewriting ruleset</td>
- </tr>
- </table>
- </div>
- <p>As you can see, first the URL is matched against the
+</tr>
+
+</table>
+
+</div>
+
+
+<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
@@ -298,10 +318,15 @@
with the substitution of the URL with
<em>Substitution</em>.</p>
- <h2><a id="quoting" name="quoting">Quoting Special
- Characters</a></h2>
- <p>As of Apache 1.3.20, special characters in
+
+
+<h3>
+<a name="quoting">Quoting Special Characters</a>
+</h3>
+
+
+<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 ('\')
@@ -310,599 +335,158 @@
using '<code>\$</code>'; this keeps mod_rewrite from trying
to treat it as a backreference.</p>
- <h2><a id="InternalBackRefs" name="InternalBackRefs">Regex
- Back-Reference Availability</a></h2>
- One important thing here has to be remembered: Whenever you
+
+
+<h3>
+<a name="InternalBackRefs">Regex Back-Reference Availability</a>
+</h3>
+
+
+<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
<code>%N</code> (see below). These are available for creating
the strings <em>Substitution</em> and <em>TestString</em>.
Figure 2 shows to which locations the back-references are
- transfered for expansion.
-
- <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
- back-reference flow through a rule</td>
- </tr>
- </table>
- </div>
-
- <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>
- <hr noshade="noshade" size="1" />
-
- <center>
- <h1><a id="Configuration"
- name="Configuration">Configuration Directives</a></h1>
- </center>
- <hr noshade="noshade" size="1" />
-
- <h3><a id="RewriteEngine"
- name="RewriteEngine">RewriteEngine</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteEngine
- on|off<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>RewriteEngine
- 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> FileInfo<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_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache
- 1.2<br />
-
-
- <p>The <code>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 <code>RewriteRule</code>
- directives!</p>
-
- <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>
- <hr noshade="noshade" size="1" />
-
- <h3><a id="RewriteOptions"
- name="RewriteOptions">RewriteOptions</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteOptions
- <em>Option</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, 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> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache
- 1.2<br />
-
-
- <p>The <code>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 />
- 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>
- <hr noshade="noshade" size="1" />
-
- <h3><a id="RewriteLog" name="RewriteLog">RewriteLog</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteLog
- <em>file-path</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#Override"
- rel="Help"><strong>Override:</strong></a> <em>Not
- applicable</em><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_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache
- 1.2<br />
-
-
- <p>The <code>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>
-
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Note</strong>: 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
- logfile it still creates the logfile output internally.
- <strong>This will slow down the server with no advantage
- to the administrator!</strong> To disable logging either
- remove or comment out the <code>RewriteLog</code>
- directive or use <code>RewriteLogLevel 0</code>!</td>
- </tr>
- </table>
-
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Security</strong>: 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>
-
- <p><strong>Example:</strong></p>
-
- <blockquote>
-<pre>
-RewriteLog "/usr/local/var/apache/logs/rewrite.log"
-</pre>
- </blockquote>
- <hr noshade="noshade" size="1" />
-
- <h3><a id="RewriteLogLevel"
- name="RewriteLogLevel">RewriteLogLevel</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteLogLevel
- <em>Level</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a>
- <code>RewriteLogLevel 0</code><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config,
- virtual host<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> <em>Not
- applicable</em><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_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache
- 1.2<br />
-
-
- <p>The <code>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
- <em>Level</em> to 0. This disables all rewrite action
- logs.</p>
-
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Notice:</strong> 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>
-
- <p><strong>Example:</strong></p>
-
- <blockquote>
-<pre>
-RewriteLogLevel 3
-</pre>
- </blockquote>
- <hr noshade="noshade" size="1" />
-
- <h3><a id="RewriteLock"
- name="RewriteLock">RewriteLock</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteLock
- <em>file-path</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> <em>Not
- applicable</em><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_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache
- 1.3<br />
-
-
- <p>This directive sets the filename for a synchronization
- lockfile which mod_rewrite needs to communicate with
- <samp>RewriteMap</samp> <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>
- <hr noshade="noshade" size="1" />
-
- <h3><a id="RewriteMap" name="RewriteMap">RewriteMap</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteMap
- <em>MapName</em> <em>MapType</em>:<em>MapSource</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> not used per
- default<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config,
- virtual host<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> <em>Not
- applicable</em><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_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.2
- (partially), Apache 1.3<br />
-
-
- <p>The <code>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
- 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>
- <em>LookupKey</em> <code>|</code> <em>DefaultValue</em>
- <code>}</code></strong>
- </blockquote>
- 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>The following combinations for <em>MapType</em> and
- <em>MapSource</em> can be used:</p>
-
- <ul>
- <li>
- <strong>Standard Plain Text</strong><br />
- MapType: <code>txt</code>, MapSource: Unix filesystem
- path to valid regular file
-
- <p>This is the standard rewriting map feature where the
- <em>MapSource</em> is a plain ASCII file containing
- either blank lines, comment lines (starting with a '#'
- character) or pairs like the following - one per
- line.</p>
-
- <blockquote>
- <strong><em>MatchingKey</em>
- <em>SubstValue</em></strong>
- </blockquote>
+ transfered for expansion.</p>
- <p>Example:</p>
- <table border="0" cellspacing="1" cellpadding="5"
- bgcolor="#F0F0F0">
- <tr>
- <td>
-<pre>
-##
-## map.txt -- rewriting map
-##
-
-Ralf.S.Engelschall rse # Bastard Operator From Hell
-Mr.Joe.Average joe # Mr. Average
-</pre>
- </td>
- </tr>
- </table>
+<div align="CENTER">
- <table border="0" cellspacing="1" cellpadding="5"
- bgcolor="#F0F0F0">
- <tr>
- <td>
-<pre>
-RewriteMap real-to-user txt:/path/to/file/map.txt
-</pre>
- </td>
- </tr>
- </table>
- </li>
+<table cellspacing="0" cellpadding="2" border="0">
- <li>
- <strong>Randomized Plain Text</strong><br />
- MapType: <code>rnd</code>, MapSource: Unix filesystem
- path to valid regular file
+<tr>
- <p>This is identical to the Standard Plain Text variant
- above but with a special post-processing feature: After
- looking up a value it is parsed according to contained
- ``<code>|</code>'' characters which have the meaning of
- ``or''. In other words they indicate a set of
- alternatives from which the actual returned value is
- chosen randomly. Although this sounds crazy and useless,
- it was actually designed for load balancing in a reverse
- proxy situation where the looked up values are server
- names. Example:</p>
+<td bgcolor="#CCCCCC"><img src="../images/mod_rewrite_fig2.gif" width="381" height="179" alt="[Needs graphics capability to display]"></td>
- <table border="0" cellspacing="1" cellpadding="5"
- bgcolor="#F0F0F0">
- <tr>
- <td>
-<pre>
-##
-## map.txt -- rewriting map
-##
+</tr>
-static www1|www2|www3|www4
-dynamic www5|www6
-</pre>
- </td>
- </tr>
- </table>
- <table border="0" cellspacing="1" cellpadding="5"
- bgcolor="#F0F0F0">
- <tr>
- <td>
-<pre>
-RewriteMap servers rnd:/path/to/file/map.txt
-</pre>
- </td>
- </tr>
- </table>
- </li>
-
- <li>
- <strong>Hash File</strong><br />
- MapType: <code>dbm</code>, MapSource: Unix filesystem
- path to valid regular file
+<tr>
- <p>Here the source is a binary NDBM format file
- containing the same contents as a <em>Plain Text</em>
- format file, but in a special representation which is
- optimized for really fast lookups. You can create such a
- file with any NDBM tool or with the following Perl
- script:</p>
+<td align="CENTER"><strong>Figure 2:</strong> The
+ back-reference flow through a rule</td>
- <table border="0" cellspacing="1" cellpadding="5"
- bgcolor="#F0F0F0">
- <tr>
- <td>
-<pre>
-#!/path/to/bin/perl
-##
-## txt2dbm -- convert txt map to dbm format
-##
+</tr>
-use NDBM_File;
-use Fcntl;
+</table>
-($txtmap, $dbmmap) = @ARGV;
+</div>
-open(TXT, "<$txtmap") or die "Couldn't open $txtmap!\n";
-tie (%DB, 'NDBM_File', $dbmmap,O_RDWR|O_TRUNC|O_CREAT, 0644) or die "Couldn't create $dbmmap!\n";
-while (<TXT>) {
- next if (/^\s*#/ or /^\s*$/);
- $DB{$1} = $2 if (/^\s*(\S+)\s+(\S+)/);
-}
+<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>
-untie %DB;
-close(TXT);
-</pre>
- </td>
- </tr>
- </table>
- <table border="0" cellspacing="1" cellpadding="5"
- bgcolor="#F0F0F0">
- <tr>
- <td>
-<pre>
-$ txt2dbm map.txt map.db
-</pre>
- </td>
- </tr>
- </table>
- </li>
- <li>
- <strong>Internal Function</strong><br />
- MapType: <code>int</code>, MapSource: Internal Apache
- function
+<h2>
+<a name="EnvVar">Environment Variables</a>
+</h2>
- <p>Here the source is an internal Apache function.
- Currently you cannot create your own, but the following
- functions already exists:</p>
- <ul>
- <li><strong>toupper</strong>:<br />
- Converts the looked up key to all upper case.</li>
+<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
+ standard CGI/SSI variables <code>SCRIPT_NAME</code> and
+ <code>SCRIPT_FILENAME</code> contain the <em>physical</em>
+ System-view. </p>
- <li><strong>tolower</strong>:<br />
- Converts the looked up key to all lower case.</li>
- <li><strong>escape</strong>:<br />
- Translates special characters in the looked up key to
- hex-encodings.</li>
+<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>
- <li><strong>unescape</strong>:<br />
- Translates hex-encodings in the looked up key back to
- special characters.</li>
- </ul>
- </li>
- <li>
- <strong>External Rewriting Program</strong><br />
- MapType: <code>prg</code>, MapSource: Unix filesystem
- path to valid regular file
+<p>
+<strong>Example:</strong>
+</p>
- <p>Here the source is a program, not a map file. To
- create it you can use the language of your choice, but
- the result has to be a executable (<em>i.e.</em>, either
- object-code or a script with the magic cookie trick
- '<code>#!/path/to/interpreter</code>' as the first
- line).</p>
- <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
- receive the key to lookup as a newline-terminated string
- on <code>stdin</code>. It then has to give back the
- looked-up value as a newline-terminated string on
- <code>stdout</code> or the four-character string
- ``<code>NULL</code>'' if it fails (<em>i.e.</em>, there
- is no corresponding value for the given key). A trivial
- 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>
- <table border="0" cellspacing="1" cellpadding="5"
- bgcolor="#F0F0F0">
- <tr>
- <td>
<pre>
-#!/usr/bin/perl
-$| = 1;
-while (<STDIN>) {
- # ...put here any transformations or lookups...
- print $_;
-}
+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>
- </td>
- </tr>
- </table>
- <p>But be very careful:<br />
- </p>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <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
- <code>stdout</code>! This will cause a deadloop! Hence
- the ``<code>$|=1</code>'' in the above example...</li>
+<h2>
+<a name="Solutions">Practical Solutions</a>
+</h2>
- <li>Use the <samp>RewriteLock</samp> 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>
- The <code>RewriteMap</code> directive can occur more than
- once. For each mapping-function use one
- <code>RewriteMap</code> directive to declare its rewriting
- mapfile. While you cannot <strong>declare</strong> a map in
- per-directory context it is of course possible to
- <strong>use</strong> this map in per-directory context.
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Note:</strong> 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>
- <hr noshade="noshade" size="1" />
-
- <h3><a id="RewriteBase"
- name="RewriteBase">RewriteBase</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteBase
- <em>URL-path</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>default is the
- physical directory path</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory,
- .htaccess<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> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache
- 1.2<br />
+<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>RewriteBase</code> directive explicitly sets the
- base URL for per-directory rewrites. As you will see below,
- <code>RewriteRule</code> can be used in per-directory config
- files (<code>.htaccess</code>). There it will act locally,
+<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>
+ 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
stage of processing and your rewriting rules act only on the
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
@@ -912,26 +496,28 @@
use the <code>RewriteBase</code> directive to specify the
correct URL-prefix.</p>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Notice:</strong> If your webserver's URLs are
- <strong>not</strong> directly related to physical file
- paths, you have to use <code>RewriteBase</code> in every
- <code>.htaccess</code> files where you want to use
- <code>RewriteRule</code> directives.</td>
- </tr>
- </table>
- <p><strong>Example:</strong></p>
+<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>
- <blockquote>
- Assume the following per-directory config file:
- <table border="0" cellspacing="1" cellpadding="5"
- bgcolor="#F0F0F0">
- <tr>
- <td>
+<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
@@ -948,23 +534,31 @@
# now the rewriting rules
RewriteRule ^oldstuff\.html$ newstuff.html
</pre>
- </td>
- </tr>
- </table>
- <p>In the above example, a request to
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<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>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td>
- <font size="-1"><strong>Note - For Apache
- hackers:</strong><br />
- The following list gives detailed information about
- the internal processing steps:</font>
+
+<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
@@ -977,8 +571,11 @@
Result:
/abc/def/newstuff.html
</font>
+
</pre>
- <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
@@ -989,52 +586,80 @@
procedure is used by many other operations inside
Apache. So, you can be sure the design and
implementation is correct.</font>
- </td>
- </tr>
- </table>
- </blockquote>
- <hr noshade="noshade" size="1" />
+</p>
- <h3><a id="RewriteCond"
- name="RewriteCond">RewriteCond</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteCond
- <em>TestString</em> <em>CondPattern</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, directory, .htaccess<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> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.2
- (partially), Apache 1.3<br />
+</td>
+</tr>
+</table>
+</blockquote>
- <p>The <code>RewriteCond</code> directive defines a rule
- condition. Precede a <code>RewriteRule</code> directive with
- one or more <code>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>
+</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>
- <p><em>TestString</em> is a string which can contains the
+<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
+ 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
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
@@ -1042,118 +667,164 @@
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 />
- HTTP_REFERER<br />
- HTTP_COOKIE<br />
- HTTP_FORWARDED<br />
- HTTP_HOST<br />
- HTTP_PROXY_CONNECTION<br />
- HTTP_ACCEPT<br />
- </font></p>
- </td>
+
+<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>
<td valign="TOP">
<strong>connection & request:</strong>
- <p><font size="-1">REMOTE_ADDR<br />
- REMOTE_HOST<br />
- REMOTE_USER<br />
- REMOTE_IDENT<br />
- REQUEST_METHOD<br />
- SCRIPT_FILENAME<br />
- PATH_INFO<br />
- QUERY_STRING<br />
- AUTH_TYPE<br />
- </font></p>
- </td>
- </tr>
- <tr>
- <td valign="TOP">
+<p>
+<font size="-1">REMOTE_ADDR<br>
+ REMOTE_HOST<br>
+ REMOTE_USER<br>
+ REMOTE_IDENT<br>
+ REQUEST_METHOD<br>
+ SCRIPT_FILENAME<br>
+ PATH_INFO<br>
+ QUERY_STRING<br>
+ AUTH_TYPE<br>
+
+</font>
+</p>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td valign="TOP">
<strong>server internals:</strong>
- <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>
+
+<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>
<td valign="TOP">
<strong>system stuff:</strong>
- <p><font size="-1">TIME_YEAR<br />
- TIME_MON<br />
- TIME_DAY<br />
- TIME_HOUR<br />
- TIME_MIN<br />
- TIME_SEC<br />
- TIME_WDAY<br />
- TIME<br />
- </font></p>
- </td>
+
+<p>
+<font size="-1">TIME_YEAR<br>
+ TIME_MON<br>
+ TIME_DAY<br>
+ TIME_HOUR<br>
+ TIME_MIN<br>
+ TIME_SEC<br>
+ TIME_WDAY<br>
+ TIME<br>
+
+</font>
+</p>
+
+</td>
<td valign="TOP">
<strong>specials:</strong>
- <p><font size="-1">API_VERSION<br />
- THE_REQUEST<br />
- REQUEST_URI<br />
- REQUEST_FILENAME<br />
- IS_SUBREQ<br />
- </font></p>
- </td>
- </tr>
- </table>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td>
- <p><strong>Notice:</strong> These variables all
+<p>
+<font size="-1">API_VERSION<br>
+ THE_REQUEST<br>
+ REQUEST_URI<br>
+ REQUEST_FILENAME<br>
+ IS_SUBREQ<br>
+
+</font>
+</p>
+
+</td>
+
+</tr>
+
+</table>
+
+
+<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.
@@ -1161,18 +832,27 @@
the CGI specification. Those that are special to
mod_rewrite include:</p>
- <dl>
- <dt><code>IS_SUBREQ</code></dt>
- <dd>Will contain the text "true" if the request
+<dl>
+
+<dt>
+<code>IS_SUBREQ</code>
+</dt>
+
+
+<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>
- <dd>This is the version of the Apache module API
+<dt>
+<code>API_VERSION</code>
+</dt>
+
+
+<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
@@ -1181,35 +861,55 @@
instance, it is 19990320:10), but is mainly of
interest to module authors.</dd>
- <dt><code>THE_REQUEST</code></dt>
- <dd>The full HTTP request line sent by the
+<dt>
+<code>THE_REQUEST</code>
+</dt>
+
+
+<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>
- <dd>The resource requested in the HTTP request
+<dt>
+<code>REQUEST_URI</code>
+</dt>
+
+
+<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>
- <dd>The full local filesystem path to the file or
+<dt>
+<code>REQUEST_FILENAME</code>
+</dt>
+
+
+<dd>The full local filesystem path to the file or
script matching the request.</dd>
- </dl>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <p>Special Notes:</p>
+</dl>
- <ol>
- <li>The variables SCRIPT_FILENAME and REQUEST_FILENAME
+</td>
+</tr>
+</table>
+</blockquote>
+
+</li>
+
+</ul>
+
+
+<p>Special Notes:</p>
+
+
+<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.
@@ -1218,20 +918,23 @@
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
@@ -1249,50 +952,62 @@
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>
- <p><em>CondPattern</em> is the condition pattern,
+</ol>
+
+
+<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
- lower)<br />
+
+<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
- greater)<br />
+
+<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
- equal)<br />
+
+<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
<em>TestString</em> is lexically equal to
@@ -1301,68 +1016,89 @@
is just <samp>""</samp> (two quotation marks) this
compares <em>TestString</em> to the empty string.</li>
- <li>'<strong>-d</strong>' (is
- <strong>d</strong>irectory)<br />
+
+<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
- <strong>f</strong>ile)<br />
+
+<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
- <strong>s</strong>ize)<br />
+
+<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
- <strong>l</strong>ink)<br />
+
+<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
- subrequest)<br />
+
+<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
access controls for that path. This uses an internal
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
- subrequest)<br />
+
+<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>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Notice:</strong> All of these tests can
+</ul>
+
+
+<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>
- </li>
- </ol>
+ negate their meaning.
+</td>
+</tr>
+</table>
+</blockquote>
- <p>Additionally you can set special flags for
+</li>
+
+</ol>
+
+
+<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>'
- (<strong>n</strong>o <strong>c</strong>ase)<br />
+
+<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
expanded <em>TestString</em> and the <em>CondPattern</em>.
@@ -1370,33 +1106,52 @@
<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 />
+ (<strong>or</strong> next condition)<br>
Use this to combine rule conditions with a local OR
instead of the implicit AND. Typical example:
- <blockquote>
+<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>
- </blockquote>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
+
Without this flag you would have to write the cond/rule
three times.
</li>
- </ul>
- <p><strong>Example:</strong></p>
+</ul>
- <blockquote>
- To rewrite the Homepage of a site according to the
+
+<p>
+<strong>Example:</strong>
+</p>
+
+
+<p>To rewrite the Homepage of a site according to the
``<code>User-Agent:</code>'' header of the request, you can
- use the following:
+ use the following: </p>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
- <blockquote>
<pre>
RewriteCond %{HTTP_USER_AGENT} ^Mozilla.*
RewriteRule ^/$ /homepage.max.html [L]
@@ -1406,47 +1161,784 @@
RewriteRule ^/$ /homepage.std.html [L]
</pre>
- </blockquote>
- Interpretation: If you use Netscape Navigator as your
+
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<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
you get the min homepage, which contains no images, no
tables, <em>etc.</em> If you use any other browser you get
- the standard homepage.
- </blockquote>
- <hr noshade="noshade" size="1" />
+ the standard homepage.</p>
- <h3><a id="RewriteRule"
- name="RewriteRule">RewriteRule</a></h3>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RewriteRule
- <em>Pattern</em> <em>Substitution</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, directory, .htaccess<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> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_rewrite.c<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.2
- (partially), Apache 1.3<br />
+</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>RewriteRule</code> directive is the real
+
+<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 <code class="directive"><a href="#rewriterule" class="directive">RewriteRule</a></code> directives!</p>
+
+
+<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>
+ <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
+ 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
+ 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
+ logfile it still creates the logfile output internally.
+ <strong>This will slow down the server with no advantage
+ 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>
+
+
+<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>
+
+
+<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>
+
+<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
+ <em>Level</em> to 0. This disables all rewrite action
+ logs.</p>
+
+
+<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>
+
+
+<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>
+
+<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
+ 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>
+ <em>LookupKey</em> <code>|</code> <em>DefaultValue</em>
+ <code>}</code></strong>
+
+</blockquote>
+
+
+<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
+ <em>MapSource</em> can be used:</p>
+
+
+<ul>
+
+<li>
+
+<strong>Standard Plain Text</strong>
+<br>
+ MapType: <code>txt</code>, MapSource: Unix filesystem
+ path to valid regular file
+
+ <p>This is the standard rewriting map feature where the
+ <em>MapSource</em> is a plain ASCII file containing
+ either blank lines, comment lines (starting with a '#'
+ character) or pairs like the following - one per
+ line.</p>
+
+
+<blockquote>
+
+<strong><em>MatchingKey</em>
+ <em>SubstValue</em></strong>
+
+</blockquote>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee">
+<p align="center">
+<strong>Example</strong>
+</p>
+<code>
+
+<pre>
+##
+## map.txt -- rewriting map
+##
+
+Ralf.S.Engelschall rse # Bastard Operator From Hell
+Mr.Joe.Average joe # Mr. Average
+</pre>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<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>
+
+<strong>Randomized Plain Text</strong>
+<br>
+ MapType: <code>rnd</code>, MapSource: Unix filesystem
+ path to valid regular file
+
+ <p>This is identical to the Standard Plain Text variant
+ above but with a special post-processing feature: After
+ looking up a value it is parsed according to contained
+ ``<code>|</code>'' characters which have the meaning of
+ ``or''. In other words they indicate a set of
+ alternatives from which the actual returned value is
+ chosen randomly. Although this sounds crazy and useless,
+ it was actually designed for load balancing in a reverse
+ proxy situation where the looked up values are server
+ names. Example:</p>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+
+<pre>
+##
+## map.txt -- rewriting map
+##
+
+static www1|www2|www3|www4
+dynamic www5|www6
+</pre>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+RewriteMap servers rnd:/path/to/file/map.txt
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+</li>
+
+
+<li>
+
+<strong>Hash File</strong>
+<br>
+ MapType: <code>dbm</code>, MapSource: Unix filesystem
+ path to valid regular file
+
+ <p>Here the source is a binary NDBM format file
+ containing the same contents as a <em>Plain Text</em>
+ format file, but in a special representation which is
+ optimized for really fast lookups. You can create such a
+ file with any NDBM tool or with the following Perl
+ script:</p>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+
+<pre>
+#!/path/to/bin/perl
+##
+## txt2dbm -- convert txt map to dbm format
+##
+
+use NDBM_File;
+use Fcntl;
+
+($txtmap, $dbmmap) = @ARGV;
+
+open(TXT, "<$txtmap") or die "Couldn't open $txtmap!\n";
+tie (%DB, 'NDBM_File', $dbmmap,O_RDWR|O_TRUNC|O_CREAT, 0644) or die "Couldn't create $dbmmap!\n";
+
+while (<TXT>) {
+ next if (/^\s*#/ or /^\s*$/);
+ $DB{$1} = $2 if (/^\s*(\S+)\s+(\S+)/);
+}
+
+untie %DB;
+close(TXT);
+</pre>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+$ txt2dbm map.txt map.db
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+</li>
+
+
+<li>
+
+<strong>Internal Function</strong>
+<br>
+ MapType: <code>int</code>, MapSource: Internal Apache
+ function
+
+ <p>Here the source is an internal Apache function.
+ Currently you cannot create your own, but the following
+ functions already exists:</p>
+
+
+<ul>
+
+<li>
+<strong>toupper</strong>:<br>
+ Converts the looked up key to all upper case.</li>
+
+
+<li>
+<strong>tolower</strong>:<br>
+ Converts the looked up key to all lower case.</li>
+
+
+<li>
+<strong>escape</strong>:<br>
+ Translates special characters in the looked up key to
+ hex-encodings.</li>
+
+
+<li>
+<strong>unescape</strong>:<br>
+ Translates hex-encodings in the looked up key back to
+ special characters.</li>
+
+</ul>
+
+</li>
+
+
+<li>
+
+<strong>External Rewriting Program</strong>
+<br>
+ MapType: <code>prg</code>, MapSource: Unix filesystem
+ path to valid regular file
+
+ <p>Here the source is a program, not a map file. To
+ create it you can use the language of your choice, but
+ the result has to be a executable (<em>i.e.</em>, either
+ object-code or a script with the magic cookie trick
+ '<code>#!/path/to/interpreter</code>' as the first
+ line).</p>
+
+
+<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
+ receive the key to lookup as a newline-terminated string
+ on <code>stdin</code>. It then has to give back the
+ looked-up value as a newline-terminated string on
+ <code>stdout</code> or the four-character string
+ ``<code>NULL</code>'' if it fails (<em>i.e.</em>, there
+ is no corresponding value for the given key). A trivial
+ 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>
+
+<pre>
+#!/usr/bin/perl
+$| = 1;
+while (<STDIN>) {
+ # ...put here any transformations or lookups...
+ print $_;
+}
+</pre>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<p>But be very careful:</p>
+
+
+<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
+ <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
+ 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>
+ 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
+ mapfile. While you cannot <strong>declare</strong> a map in
+ 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
+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>
+
+
+<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>
+ 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
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
@@ -1455,12 +1947,18 @@
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>
- <table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
- <tr>
- <td valign="TOP">
+<p>Some hints about the syntax of regular expressions:</p>
+
+
+<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
@@ -1486,11 +1984,15 @@
<strong><code>\</code></strong>char escape that particular char
(for instance to specify the chars "<code>.[]()</code>" <em>etc.</em>)
</pre>
- </td>
- </tr>
- </table>
- <p>For more information about regular expressions either have
+</td>
+
+</tr>
+
+</table>
+
+
+<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
@@ -1498,15 +2000,20 @@
(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 />
- Jeffrey E.F. Friedl<br />
- Nutshell Handbook Series<br />
- O'Reilly & Associates, Inc. 1997<br />
- ISBN 1-56592-257-3<br />
- </blockquote>
- <p>Additionally in mod_rewrite the NOT character
+<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>
+
+
+<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
@@ -1514,37 +2021,53 @@
it is easier to match the negative pattern, or as a last
default rule.</p>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Notice:</strong> When using the NOT character
+
+<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
pattern does NOT match, there are no contents for the
groups. In consequence, if negated patterns are used, you
cannot use <code>$N</code> in the substitution
- string!</td>
- </tr>
- </table>
+ string!
+</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
@@ -1563,7 +2086,8 @@
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
@@ -1572,7 +2096,8 @@
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
@@ -1580,10 +2105,15 @@
string, end the substitution string with just the question
mark.</p>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Note</strong>: There is a special feature:
+
+<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>]
then <strong>mod_rewrite</strong> automatically strips it
@@ -1591,36 +2121,49 @@
URLs is a useful and important feature when used in
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>
+ example section below to understand this.
+</td>
+</tr>
+</table>
+</blockquote>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Remember:</strong> An unconditional external
+
+<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>
+ <strong>R</strong>-flag (see below).
+</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 />
+ [=<em>code</em>]</strong>' (force <a id="redirect" name="redirect"><strong>r</strong>edirect</a>)<br>
Prefix <em>Substitution</em> with
<code>http://thishost[:thisport]/</code> (which makes the
new URL a URI) to force a external redirection. If no
@@ -1633,10 +2176,12 @@
canonicalize the URL and give it back to the client,
<em>e.g.</em>, translate ``<code>/~</code>'' into
``<code>/u/</code>'' or always append a slash to
- <code>/u/</code><em>user</em>, etc.<br />
+ <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
@@ -1644,36 +2189,38 @@
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>'<strong><code>forbidden|F</code></strong>' (force URL
- to be <strong>f</strong>orbidden)<br />
+</li>
+
+
+<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
403 (FORBIDDEN). Use this flag in conjunction with
appropriate RewriteConds to conditionally block some
URLs.</li>
- <li>'<strong><code>gone|G</code></strong>' (force URL to be
- <strong>g</strong>one)<br />
+
+<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 />
+ <strong>p</strong>roxy)<br>
This flag forces the substitution part to be internally
forced as a proxy request and immediately (<em>i.e.</em>,
- rewriting rule processing stops here) put through the <a
- href="mod_proxy.html">proxy module</a>. You have to make
+ rewriting rule processing stops here) put through the <a href="mod_proxy.html">proxy module</a>. You have to make
sure that the substitution string is a valid URI
(<em>e.g.</em>, typically starting with
<code>http://</code><em>hostname</em>) which can be
handled by the Apache proxy module. If not you get an
error from the proxy module. Use this flag to achieve a
- more powerful implementation of the <a
- href="mod_proxy.html#proxypass">ProxyPass</a> directive,
+ more powerful implementation of the <a href="mod_proxy.html#proxypass">ProxyPass</a> directive,
to map some remote stuff into the namespace of the local
server.
@@ -1685,10 +2232,12 @@
available to mod_rewrite. If not, then you first have to
rebuild the ``<code>httpd</code>'' program with mod_proxy
enabled.</p>
- </li>
- <li>'<strong><code>last|L</code></strong>'
- (<strong>l</strong>ast rule)<br />
+</li>
+
+
+<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
<code>last</code> command or the <code>break</code> command
@@ -1698,20 +2247,24 @@
('<code>/</code>') to a real one, <em>e.g.</em>,
'<code>/e/www/</code>'.</li>
- <li>'<strong><code>next|N</code></strong>'
- (<strong>n</strong>ext round)<br />
+
+<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
the original URL but the URL from the last rewriting rule.
This corresponds to the Perl <code>next</code> command or
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>
+ to immediately go to the top of the loop.<br>
- <li>'<strong><code>chain|C</code></strong>'
- (<strong>c</strong>hained with next rule)<br />
+<strong>But be careful not to create an infinite
+ loop!</strong>
+</li>
+
+
+<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,
<em>etc.</em>). This has the following effect: if a rule
@@ -1723,9 +2276,10 @@
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 MIME <strong>t</strong>ype)<br>
Force the MIME-type of the target file to be
<em>MIME-type</em>. For instance, this can be used to
simulate the <code>mod_alias</code> directive
@@ -1733,10 +2287,11 @@
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 />
+ <strong>s</strong>ub-request)<br>
This flag forces the rewriting engine to skip a
rewriting rule if the current request is an internal
sub-request. For instance, sub-requests occur internally
@@ -1745,35 +2300,40 @@
(<code>index.xxx</code>). On sub-requests it is not
always useful and even sometimes causes a failure to if
the complete set of rules are applied. Use this flag to
- exclude some rules.<br />
+ 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>'<strong><code>nocase|NC</code></strong>'
- (<strong>n</strong>o <strong>c</strong>ase)<br />
+</li>
+
+
+<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 />
+ <strong>a</strong>ppend)<br>
This flag forces the rewriting engine to append a query
string part in the substitution string to the existing one
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 />
+ output)<br>
This flag keeps mod_rewrite from applying the usual URI
escaping rules to the result of a rewrite. Ordinarily,
special characters (such as '%', '$', ';', and so on)
@@ -1781,27 +2341,25 @@
'%24', and '%3B', respectively); this flag prevents this
from being done. This allows percent symbols to appear in
the output, as in
-<pre>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
RewriteRule /foo/(.*) /bar?arg=P1\%3d$1 [R,NE]
+</code></td>
+</tr>
+</table>
+</blockquote>
-</pre>
which would turn '<code>/foo/zed</code>' into a safe
request for '<code>/bar?arg=P1=zed</code>'.
-
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Notice:</strong> The
- <code>noescape</code> flag is only available with
- Apache 1.3.20 and later versions.</td>
- </tr>
- </table>
</li>
- <li>
+
+<li>
'<strong><code>passthrough|PT</code></strong>'
(<strong>p</strong>ass <strong>t</strong>hrough to next
- handler)<br />
+ handler)<br>
This flag forces the rewriting engine to set the
<code>uri</code> field of the internal
<code>request_rec</code> structure to the value of the
@@ -1816,11 +2374,16 @@
engine of <code>mod_rewrite</code> and then
<code>/def</code> to <code>/ghi</code> with
<code>mod_alias</code>:
-<pre>
- RewriteRule ^/abc(.*) /def$1 [PT]
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ RewriteRule ^/abc(.*) /def$1 [PT]<br>
Alias /def /ghi
-
-</pre>
+</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
@@ -1835,23 +2398,30 @@
is the use of <code>mod_alias</code> and
<code>mod_rewrite</code>..</p>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><font size="-1"><strong>Note - For Apache
- hackers:</strong><br />
+
+<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.</font> </td>
- </tr>
- </table>
- </li>
+ Apache version 2.0.
+</td>
+</tr>
+</table>
+</blockquote>
- <li>'<strong><code>skip|S</code></strong>=<em>num</em>'
- (<strong>s</strong>kip next rule(s))<br />
+</li>
+
+
+<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
matches. Use this to make pseudo if-then-else constructs:
@@ -1860,9 +2430,10 @@
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 />
+ (set <strong>e</strong>nvironment variable)<br>
This forces an environment variable named <em>VAR</em> to
be set to the value <em>VAL</em>, where <em>VAL</em> can
contain regexp backreferences <code>$N</code> and
@@ -1875,37 +2446,46 @@
it in a following RewriteCond pattern via
<code>%{ENV:VAR}</code>. Use this to strip but remember
information from URLs.</li>
- </ul>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td>
- <strong>Note:</strong> 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
- directory!) is automatically <em>removed</em> for the
- pattern matching and automatically <em>added</em> after
- the substitution has been done.</strong> This feature
- is essential for many sorts of rewriting, because
- without this prefix stripping you have to match the
- parent directory which is not always possible.
+</ul>
+
+
+<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
+directory!) is automatically <em>removed</em> for the pattern matching
+and automatically <em>added</em> after the substitution has been
+done.</strong> This feature is essential for many sorts of rewriting,
+because without this prefix stripping you have to match the parent
+directory which is not always possible.
<p>There is one exception: If a substitution string
starts with ``<code>http://</code>'' then the directory
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>
- <table width="70%" border="0" bgcolor="#E0E0F0"
- cellspacing="0" cellpadding="10">
- <tr>
- <td><strong>Note:</strong> To enable the rewriting engine
+</td>
+</tr>
+</table>
+</blockquote>
+
+
+<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
<strong>and</strong> ``<code>Options
@@ -1913,23 +2493,35 @@
administrator has disabled override of
<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>
+ needed for security reasons.
+</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
- (<code>httpd.conf</code>)<br />
+
+<p>
+<strong>Inside per-server configuration
+ (<code>httpd.conf</code>)<br>
for request ``<code>GET
- /somepath/pathinfo</code>'':</strong><br />
- </p>
+ /somepath/pathinfo</code>'':</strong>
+<br>
+
+</p>
+
+
+<table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
+
+<tr>
+
+<td>
- <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!
@@ -1962,23 +2554,36 @@
^/somepath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo
via internal proxy
</pre>
- </td>
- </tr>
- </table>
- <p><strong>Inside per-directory configuration for
- <code>/somepath</code><br />
+</td>
+
+</tr>
+
+</table>
+
+
+<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 />
+ <code>RewriteBase /somepath</code>)<br>
for request ``<code>GET
- /somepath/localpath/pathinfo</code>'':</strong><br />
- </p>
+ /somepath/localpath/pathinfo</code>'':</strong>
+<br>
+
+</p>
+
+
+<table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
+
+<tr>
+
+<td>
- <table bgcolor="#F0F0F0" cellspacing="0" cellpadding="5">
- <tr>
- <td>
<pre>
+
<strong>Given Rule</strong> <strong>Resulting Substitution</strong>
---------------------------------------------- ----------------------------------
^localpath(.*) otherpath$1 /somepath/otherpath/pathinfo
@@ -2012,85 +2617,65 @@
^localpath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo
via internal proxy
</pre>
- </td>
- </tr>
- </table>
- <p><strong>Example:</strong></p>
+</td>
- <blockquote>
- We want to rewrite URLs of the form
+</tr>
- <blockquote>
- <code>/</code> <em>Language</em> <code>/~</code>
+</table>
+
+
+<p>
+<strong>Example:</strong>
+</p>
+
+
+<p>We want to rewrite URLs of the form </p>
+
+
+<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>
- <p>We take the rewrite mapfile from above and save it under
+</blockquote>
+
+
+<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>
+
+<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>
- </blockquote>
- </blockquote>
- <hr noshade="noshade" size="1" />
- <center>
- <h1><a id="Miscelleneous"
- name="Miscelleneous">Miscellaneous</a></h1>
- </center>
- <hr noshade="noshade" size="1" />
-
- <h2><a id="EnvVar" name="EnvVar">Environment
- Variables</a></h2>
- 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
- standard CGI/SSI variables <code>SCRIPT_NAME</code> and
- <code>SCRIPT_FILENAME</code> contain the <em>physical</em>
- System-view.
-
- <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>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p><strong>Example:</strong></p>
- <blockquote>
-<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>
- </blockquote>
- <hr noshade="noshade" size="1" />
-
- <h2><a id="Solutions" name="Solutions">Practical
- Solutions</a></h2>
- 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. <!--#include virtual="footer.html" -->
- </blockquote>
- <!-- page indentation -->
- <!--/%hypertext -->
- </body>
+</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>
-
1.19 +454 -263 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.18
retrieving revision 1.19
diff -u -d -b -u -r1.18 -r1.19
--- mod_setenvif.html 22 Sep 2001 19:36:01 -0000 1.18
+++ mod_setenvif.html 19 Feb 2002 18:37:19 -0000 1.19
@@ -1,338 +1,529 @@
-<!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_setenvif</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_setenvif</h1>
-
- <p>This module provides the ability to set environment
- variables based upon attributes of the request.</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_setenvif.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- setenvif_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.3 and later.</p>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
- <h2>Summary</h2>
- <p>The <samp>mod_setenvif</samp> 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>
-<pre>
- BrowserMatch ^Mozilla netscape
- BrowserMatch MSIE !netscape
-
-</pre>
- </blockquote>
- <br />
- <br />
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ BrowserMatch ^Mozilla netscape<br>
+ BrowserMatch MSIE !netscape<br>
- <p>For additional information, we provide a document on <a
- href="../env.html">Environment Variables in Apache</a>.</p>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <h2>Directives</h2>
+</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
+ above (in Apache 1.2 this directive was found in the
+ now-obsolete mod_browser module)</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
- <ul>
- <li><a href="#BrowserMatch">BrowserMatch</a></li>
+<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
+ <code>egrep</code>-style regex). The rest of the arguments give
+ the names of variables to set, and optionally values to which they
+ should be set. These take the form of</p>
- <li><a href="#BrowserMatchNoCase">BrowserMatchNoCase</a></li>
- <li><a href="#SetEnvIf">SetEnvIf</a></li>
+<ol>
- <li><a href="#SetEnvIfNoCase">SetEnvIfNoCase</a></li>
- </ul>
- <hr />
- <!-- the HR is part of the directive description -->
+<li>
+<code><em>varname</em></code>, or</li>
- <h2><a id="BrowserMatch" name="BrowserMatch">BrowserMatch
- directive</a></h2>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> BrowserMatch <em>regex
- env-variable</em>[=<em>value</em>]
- [<em>env-variable</em>[=<em>value</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, 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_setenvif<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.2 and
- above (in Apache 1.2 this directive was found in the
- now-obsolete mod_browser module)</p>
+<li>
+<code>!<em>varname</em></code>, or</li>
- <p>The BrowserMatch directive defines environment variables
- based on the <samp>User-Agent</samp> HTTP request header field.
- The first argument should be a POSIX.2 extended regular
- expression (similar to an <samp>egrep</samp>-style regex). The
- rest of the arguments give the names of variables to set, and
- optionally values to which they should be set. These take the
- form of</p>
- <ol>
- <li><samp><em>varname</em></samp>, or</li>
+<li>
+<code><em>varname</em>=<em>value</em></code>
+</li>
- <li><samp>!<em>varname</em></samp>, or</li>
+</ol>
- <li><samp><em>varname</em>=<em>value</em></samp></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
- <samp><em>value</em></samp>. If a <samp>User-Agent</samp>
+ <code><em>value</em></code>. If a <code>User-Agent</code>
string matches more than one entry, they will be merged.
Entries are processed in the order in which they appear, and
later entries can override earlier ones.</p>
- <p>For example:</p>
-<pre>
- BrowserMatch ^Mozilla forms jpeg=yes browser=netscape
- BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript
- BrowserMatch MSIE !javascript
-</pre>
+<p>For example:</p>
- <p>Note that the regular expression string is
+<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>
+
+
+<p>Note that the regular expression string is
<strong>case-sensitive</strong>. For case-INsensitive matching,
- see the <a
- href="#BrowserMatchNoCase"><samp>BrowserMatchNoCase</samp></a>
+ see the <code class="directive"><a href="#browsermatchnocase" class="directive">BrowserMatchNoCase</a></code>
directive.</p>
- <p>The <samp>BrowserMatch</samp> and
- <samp>BrowserMatchNoCase</samp> directives are special cases of
- the <a href="#SetEnvIf"><samp>SetEnvIf</samp></a> and <a
- href="#SetEnvIfNoCase"><samp>SetEnvIfNoCase</samp></a>
+
+<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>
directives. The following two lines have the same effect:</p>
-<pre>
- BrowserMatchNoCase Robot is_a_robot
- SetEnvIfNoCase User-Agent Robot is_a_robot
-</pre>
- <hr />
- <!-- the HR is part of the directive description -->
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ BrowserMatchNoCase Robot is_a_robot<br>
+ SetEnvIfNoCase User-Agent Robot is_a_robot<br>
- <h2><a id="BrowserMatchNoCase"
- name="BrowserMatchNoCase">BrowserMatchNoCase directive</a></h2>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> BrowserMatchNoCase
- <em>regex env-variable</em>[=<em>value</em>]
- [<em>env-variable</em>[=<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, 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_setenvif<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.2 and
+</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
above (in Apache 1.2 this directive was found in the
- now-obsolete mod_browser module)</p>
+ now-obsolete mod_browser module)</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
- <p>The <samp>BrowserMatchNoCase</samp> directive is
- semantically identical to the <a
- href="#BrowserMatch"><samp>BrowserMatch</samp></a> directive.
+
+<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.
However, it provides for case-insensitive matching. For
example:</p>
-<pre>
- BrowserMatchNoCase mac platform=macintosh
- BrowserMatchNoCase win platform=windows
-</pre>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ BrowserMatchNoCase mac platform=macintosh<br>
+ BrowserMatchNoCase win platform=windows<br>
- <p>The <samp>BrowserMatch</samp> and
- <samp>BrowserMatchNoCase</samp> directives are special cases of
- the <a href="#SetEnvIf"><samp>SetEnvIf</samp></a> and <a
- href="#SetEnvIfNoCase"><samp>SetEnvIfNoCase</samp></a>
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<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>
directives. The following two lines have the same effect:</p>
-<pre>
- BrowserMatchNoCase Robot is_a_robot
- SetEnvIfNoCase User-Agent Robot is_a_robot
-</pre>
- <hr />
- <!-- the HR is part of the directive description -->
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ BrowserMatchNoCase Robot is_a_robot<br>
+ SetEnvIfNoCase User-Agent Robot is_a_robot<br>
- <h2><a id="SetEnvIf" name="SetEnvIf">SetEnvIf
- directive</a></h2>
+</code></td>
+</tr>
+</table>
+</blockquote>
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SetEnvIf <em>attribute
+</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
regex env-variable</em>[=<em>value</em>]
- [<em>env-variable</em>[=<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, 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_setenvif<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.3 and
+ [<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; the Request_Protocol keyword and environment-variable
- matching are only available with 1.3.7 and later</p>
+ matching are only available with 1.3.7 and later</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
- <p>The <samp>SetEnvIf</samp> directive defines environment
+<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>
+ 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><samp>Remote_Host</samp> - the hostname (if available) of
+
+<ul>
+
+<li>
+<code>Remote_Host</code> - the hostname (if available) of
the client making the request</li>
- <li><samp>Remote_Addr</samp> - the IP address of the client
+
+<li>
+<code>Remote_Addr</code> - the IP address of the client
making the request</li>
- <li><samp>Remote_User</samp> - the authenticated username (if
+
+<li>
+<code>Remote_User</code> - the authenticated username (if
available)</li>
- <li><samp>Request_Method</samp> - the name of the method
- being used (<samp>GET</samp>, <samp>POST</samp>, <em>et
+
+<li>
+<code>Request_Method</code> - the name of the method
+ being used (<code>GET</code>, <code>POST</code>, <em>et
cetera</em>)</li>
- <li><samp>Request_Protocol</samp> - 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><samp>Request_URI</samp> - the portion of the URL
+
+<li>
+<code>Request_URI</code> - the portion of the URL
following the scheme and host portion</li>
- </ul>
- <p>Some of the more commonly used request header field names
- include <samp>Host</samp>, <samp>User-Agent</samp>, and
- <samp>Referer</samp>.</p>
+</ul>
- <p>If the <em>attribute</em> name doesn't match any of the
+
+<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
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>SetEnvIf</code> directives to test against the result of
+ <code class="directive">SetEnvIf</code> directives to test against the result of
prior matches.</p>
- <blockquote>
+
+<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>
- </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>
- <p>Example:</p>
-<pre>
- SetEnvIf Request_URI "\.gif$" object_is_image=gif
- SetEnvIf Request_URI "\.jpg$" object_is_image=jpg
- SetEnvIf Request_URI "\.xbm$" object_is_image=xbm
- :
- SetEnvIf Referer www\.mydomain\.com intra_site_referral
- :
- SetEnvIf object_is_image xbm XBIT_PROCESSING=1
- :
- SetEnvIf ^TS* ^[a-z].* HAVE_TS
-</pre>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee">
+<p align="center">
+<strong>Example:</strong>
+</p>
+<code>
- <p>The first three will set the environment variable
- <samp>object_is_image</samp> if the request was for an image
- file, and the fourth sets <samp>intra_site_referral</samp> if
+ SetEnvIf Request_URI "\.gif$" object_is_image=gif<br>
+ SetEnvIf Request_URI "\.jpg$" object_is_image=jpg<br>
+ SetEnvIf Request_URI "\.xbm$" object_is_image=xbm<br>
+ :<br>
+ SetEnvIf Referer www\.mydomain\.com intra_site_referral<br>
+ :<br>
+ SetEnvIf object_is_image xbm XBIT_PROCESSING=1<br>
+ :<br>
+ SetEnvIf ^TS* ^[a-z].* HAVE_TS<br>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<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
- <samp>www.mydomain.com</samp> Web site.</p>
+ <code>www.mydomain.com</code> Web site.</p>
- <p>The last example will set environment variable
- <samp>HAVE_TS</samp> if the request contains any headers that
+
+<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>
- <hr />
- <!-- the HR is part of the directive description -->
- <h2><a id="SetEnvIfNoCase" name="SetEnvIfNoCase">SetEnvIfNoCase
- directive</a></h2>
+</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><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SetEnvIfNoCase
- <em>attribute regex env-variable</em>[=<em>value</em>]
- [<em>env-variable</em>[=<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, 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_setenvif<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Apache 1.3 and
- above</p>
- <p>The <samp>SetEnvIfNoCase</samp> is semantically identical to
- the <a href="#SetEnvIf"><samp>SetEnvIf</samp></a> directive,
+<p>The <code class="directive">SetEnvIfNoCase</code> is semantically identical to
+ the <code class="directive"><a href="#setenvif" class="directive">SetEnvIf</a></code> directive,
and differs only in that the regular expression matching is
performed in a case-insensitive manner. For example:</p>
-<pre>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
SetEnvIfNoCase Host Apache\.Org site=apache
+</code></td>
+</tr>
+</table>
+</blockquote>
-</pre>
- <p>This will cause the <samp>site</samp> environment variable
- to be set to "<samp>apache</samp>" if the HTTP request header
- field <samp>Host:</samp> was included and contained
- <samp>Apache.Org</samp>, <samp>apache.org</samp>, or any other
+<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>
- <!--#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>
1.23 +188 -105 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.22
retrieving revision 1.23
diff -u -d -b -u -r1.22 -r1.23
--- mod_status.html 17 Oct 2001 17:55:07 -0000 1.22
+++ mod_status.html 19 Feb 2002 18:37:19 -0000 1.23
@@ -1,114 +1,170 @@
-<!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_status</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
- <blockquote>
+<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.
- </blockquote>
-
- <h1 align="CENTER">Module mod_status</h1>
-
- <p>This module provides information on server activity and
- performance.</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_status.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- status_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.1 and later.</p>
+</td>
+</tr>
+</table>
+</blockquote>
- <h2>Summary</h2>
- <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>
- <ul>
- <li>The number of children serving requests</li>
+<p>The details given are:</p>
- <li>The number of idle children</li>
- <li>The status of each child, the number of requests that
+<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
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>The time the server was started/restarted and the time it
+<li>A total number of accesses and byte count served (*)</li>
+
+
+<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>
- <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
-<pre>
- <Location /server-status>
- SetHandler server-status
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ <Location /server-status><br>
+ SetHandler server-status<br>
- Order Deny,Allow
- Deny from all
- Allow from .foo.com
+<br>
+ Order Deny,Allow<br>
+ Deny from all<br>
+ Allow from .foo.com<br>
</Location>
-</pre>
+</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
+ 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>
+
+<h2>Automatic Updates</h2>
- <p>Note that mod_status 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>
- <h3>Automatic Updates</h3>
You can get the status page to update itself automatically if
you have a browser that supports "refresh". Access the page
<code>http://your.server.name/server-status?refresh=N</code> to
refresh the page every N seconds.
- <h3>Machine Readable Status File</h3>
+<h2>Machine Readable Status File</h2>
+
+
A machine-readable version of the status file is available by
accessing the page
<code>http://your.server.name/server-status?auto</code>. This
@@ -117,41 +173,68 @@
<code>log_server_status</code>.
<blockquote>
- <strong>It should be noted that if <samp>mod_status</samp> is
+<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>,
- <samp>.htaccess</samp>). This may have security-related
+ <code>.htaccess</code>). This may have security-related
ramifications for your site.</strong>
- </blockquote>
- <hr />
+ </td>
+</tr>
+</table>
+</blockquote>
- <h2><a id="extendedstatus" name="extendedstatus">ExtendedStatus
- directive</a></h2>
- <!--%plaintext <?INDEX {\tt ExtendedStatus} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ExtendedStatus
- On|Off<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>ExtendedStatus
- Off</code><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_status<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ExtendedStatus
- is only available in Apache 1.3.2 and later.
- <p>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.</p>
+<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
+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
+<p>This setting applies to the entire server, and cannot be
enabled or disabled on a virtualhost-by-virtualhost basis.</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>
1.3 +99 -67 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.2
retrieving revision 1.3
diff -u -d -b -u -r1.2 -r1.3
--- mod_suexec.html 22 Sep 2001 19:36:01 -0000 1.2
+++ mod_suexec.html 19 Feb 2002 18:37:19 -0000 1.3
@@ -1,75 +1,107 @@
-<!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_suexec</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_suexec</h1>
-
- <p>This module provides support for <a
- href="../suexec.html">running CGI scripts as a specified User
- and Group</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_suexec.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- suexec_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>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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
+<p>This module allows CGI scripts to run as a specified user
and Group.</p>
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#suexecusergroup">SuexecUserGroup</a></li>
- </ul>
-
- <h2><a id="suexecusergroup"
- name="suexecusergroup">SuexecUserGroup directive</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> SuexecUserGroup
- <em>User Group</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_suexec<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> SuexecUserGroup
- is only available in 2.0 and later.</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>SuexecUserGroup</code> directive allows you to
+<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>
- <hr />
- <h3 align="CENTER">Apache HTTP Server Version 2.0</h3>
- <a href="./"><img src="../images/index.gif" alt="Index" /></a>
- <a href="../"><img src="../images/home.gif" alt="Home" /></a>
- </body>
+</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>
-
1.9 +94 -62 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.8
retrieving revision 1.9
diff -u -d -b -u -r1.8 -r1.9
--- mod_unique_id.html 22 Sep 2001 19:36:01 -0000 1.8
+++ mod_unique_id.html 19 Feb 2002 18:37:19 -0000 1.9
@@ -1,38 +1,50 @@
-<!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_unique_id</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_unique_id</h1>
-
- <p>This module provides an environment variable with a unique
- identifier for each request.</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_unique_id.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- unique_id_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.3 and later.</p>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
- <h2>Summary</h2>
- <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
@@ -41,13 +53,14 @@
useful for various reasons which are beyond the scope of this
document.</p>
- <h2>Directives</h2>
+</summary>
+<h2>Directives</h2>
+<p>This module provides no directives.</p>
+<h2>Theory</h2>
- <p>This module has 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
@@ -55,7 +68,8 @@
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
@@ -64,32 +78,40 @@
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>
- <p>As far as operating system assumptions go, we assume that
+</ul>
+
+
+<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
@@ -98,7 +120,8 @@
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
@@ -107,7 +130,8 @@
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
@@ -117,7 +141,8 @@
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
@@ -130,7 +155,8 @@
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
@@ -146,7 +172,8 @@
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
@@ -155,7 +182,8 @@
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
@@ -173,7 +201,8 @@
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,
@@ -184,7 +213,8 @@
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
@@ -196,9 +226,11 @@
kernel). In very specific situations the identifier can be
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).
- <!--#include virtual="footer.html" -->
- </p>
- </body>
-</html>
+ 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>
1.18 +190 -100 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.17
retrieving revision 1.18
diff -u -d -b -u -r1.17 -r1.18
--- mod_userdir.html 22 Sep 2001 19:36:01 -0000 1.17
+++ mod_userdir.html 19 Feb 2002 18:37:19 -0000 1.18
@@ -1,122 +1,212 @@
-<!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_userdir</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_userdir</h1>
-
- <p>This module provides for user-specific directories.</p>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+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>
- <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_userdir.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- userdir_module</p>
+</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
+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
+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>
- <h2>Directives</h2>
- <ul>
- <li><a href="#userdir">UserDir</a></li>
- </ul>
- <hr />
+<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>
- <h2><a id="userdir" name="userdir">UserDir</a> directive</h2>
- <!--%plaintext <?INDEX {\tt UserDir} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> UserDir
- <em>directory-filename</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <code>UserDir
- public_html</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_userdir<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> All forms except
- the <code>UserDir public_html</code> form are only available in
- Apache 1.1 or above. Use of the <samp>enabled</samp> keyword,
- or <samp>disabled</samp> with a list of usernames, is only
- available in Apache 1.3 and above.
- <p>The UserDir 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>
- <ul>
- <li>The name of a directory or a pattern such as those shown
+<li>The name of a directory or a pattern such as those shown
below.</li>
- <li>The keyword <samp>disabled</samp>. 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 <samp>enabled</samp> keyword (see
+ explicitly named with the <code>enabled</code> keyword (see
below).</li>
- <li>The keyword <samp>disabled</samp> 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 <samp>enabled</samp>
+ performed, even if they appear in an <code>enabled</code>
clause.</li>
- <li>The keyword <samp>enabled</samp> 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
- <samp>disabled</samp> clause.</li>
- </ul>
+ <code>disabled</code> clause.</li>
- <p>If neither the <samp>enabled</samp> nor the
- <samp>disabled</samp> keywords appear in the
- <samp>Userdir</samp> directive, the argument is treated as a
+</ul>
+
+
+<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
specification. A request for
<code>http://www.foo.com/~bob/one/two.html</code> will be
translated to:</p>
-<pre>
-UserDir public_html -> ~bob/public_html/one/two.html
-UserDir /usr/web -> /usr/web/bob/one/two.html
-UserDir /home/*/www -> /home/bob/www/one/two.html
-</pre>
- The following directives will send redirects to the client:
-<pre>
-UserDir http://www.foo.com/users -> http://www.foo.com/users/bob/one/two.html
-UserDir http://www.foo.com/*/usr -> http://www.foo.com/bob/usr/one/two.html
-UserDir http://www.foo.com/~*/ -> http://www.foo.com/~bob/one/two.html
-</pre>
- <br />
- <br />
- <blockquote>
+<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>
+
+</table>
+
+
+<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>
+
+</table>
+
+
+<blockquote>
+<table>
+<tr>
+<td bgcolor="#e0e5f5">
<strong>Be careful when using this directive; for instance,
- <samp>"UserDir ./"</samp> would map
- <samp>"/~root"</samp> to <samp>"/"</samp> - which is probably
+ <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
- "<samp>UserDir disabled root</samp>" declaration.
- See also the <a
- href="core.html#directory"><Directory></a> directive
- and the <a href="../misc/security_tips.html">Security
+ "<code>UserDir disabled root</code>" declaration.
+ See also the <code class="directive"><a href="core.html#directory" class="directive">Directory</a></code>
+ directive and the <a href="../misc/security_tips.html">Security
Tips</a> page for more information.</strong>
- </blockquote>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
+</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>