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>
-<div class="example"><p><code>
-<Files "mypaths.shtml"><br />
- Options +Includes<br />
- SetOutputFilter INCLUDES<br />
- AcceptPathInfo on<br />
-</Files>
-</code></p></div>
+
+ <div class="example"><pre>
+<Files "mypaths.shtml">
+ Options +Includes
+ SetOutputFilter INCLUDES
+ AcceptPathInfo on
+</Files></pre></div>
+
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AccessFileName" id="AccessFileName">AccessFileName</a> <a name="accessfilename" id="accessfilename">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Name of the distributed configuration file</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>AccessFileName <
em>filename</em> [<em>filename</em>] ...</td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>AccessFileName <
var>filename</var> [<var>filename</var>] ...</td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>AccessFileName .htaccess</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
configuration files are enabled for that directory. For
example:</p>
-<div class="example"><p><code>
-AccessFileName .acl
-</code></p></div>
+
<div class="example"><p><code>
+ AccessFileName .acl
+ </code></p></div>
<p>before returning the document
<code>/usr/local/web/index.html</code>, the server will read
<code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
for directives, unless they have been disabled with</p>
-<div class="example"><p><code>
-<Directory /><br />
- AllowOverride None<br />
-</Directory>
-</code></p></div>
+ <div class="example"><pre>
+<Directory />
+ AllowOverride None
+</Directory></pre></div>
<h3>See also</h3><ul><li><code class="directive"><a href="#allowoverride">AllowOverride</a></code></li><li><a href="../configuring.html">Configuration Files</a></li><li><a href="../howto/htaccess.html">.htaccess Files</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddDefaultCharset" id="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset" id="adddefaultcharset">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Default character set to be added for a
response without an explicit character set</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>AddDefaultCharset On|Off|<
em>charset</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>AddDefaultCharset On|Off|<
var>charset</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>AddDefaultCharset Off</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
-
<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
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>
+ <var>charset</var> to be used. For example:</p>
-<div class="example"><p><code>
- AddDefaultCharset utf-8
-</code></p></div>
+
<div class="example"><p><code>
+ AddDefaultCharset utf-8
+ </code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AllowOverride" id="AllowOverride">AllowOverride</a> <a name="allowoverride" id="allowoverride">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Types of directives that are allowed in
.htaccess files</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>AllowOverride All|None|<em>directive-type</em>
-[<
em>directive-type</em>] ...</td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>AllowOverride All|None|<var>directive-type</var>
+[<
var>directive-type</var>] ...</td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>AllowOverride All</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>directory</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
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 <var>directive-type</var> can be one of the following
groupings of directives.</p>
<dl>
<p>Example:</p>
- <div class="example"><p><code>AllowOverride AuthConfig Indexes</code></p></div>
+ <div class="example"><p><code>
+ AllowOverride AuthConfig Indexes
+ </code></p></div>
<h3>See also</h3><ul><li><code class="directive"><a href="#accessfilename">AccessFileName</a></code></li><li><a href="../configuring.html">Configuration Files</a></li><li><a href="../howto/htaccess.html">.htaccess Files</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AuthName" id="AuthName">AuthName</a> <a name="authname" id="authname">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Authorization realm for use in HTTP
authentication</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>AuthName <
em>auth-domain</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>AuthName <
var>auth-domain</var></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>AuthConfig</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<p>For example:</p>
- <div class="example"><p><code>AuthName "Top Secret"</code></p></div>
+ <div class="example"><p><code>
+ AuthName "Top Secret"
+ </code></p></div>
<p>The string provided for the <code>AuthName</code> is what will
appear in the password dialog provided by most browsers.</p>
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>
-<div class="example"><p><code>
- Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
-</code></p></div>
+
+ <div class="example"><p><code>
+ Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
+ </code></p></div>
<p>Note that this can cause performance problems on your server
since the message digest is computed on every request (the
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="DefaultType" id="DefaultType">DefaultType</a> <a name="defaulttype" id="defaulttype">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>MIME content-type that will be sent if the
server cannot determine a type in any other way</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>DefaultType <
em>MIME-type</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>DefaultType <
var>MIME-type</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>DefaultType text/plain</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
document, so in the event of an unknown type it uses the
<code>DefaultType</code>. For example:</p>
-<div class="example"><p><code>
- <code>DefaultType image/gif</code>
-</code></p></div>
+ <div class="example"><p><code>
+ DefaultType image/gif
+ </code></p></div>
+
<p>would be appropriate for a directory which contained many gif
images with filenames missing the .gif extension.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Directory" id="Directory"><Directory></a> <a name="directory" id="directory">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Enclose a group of directives that apply only to the
named file-system directory and sub-directories</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><Directory <em>directory-path</em>>
+ </a></th><td><Directory <var>directory-path</var>>
... </Directory></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<code></Directory></code> are used to enclose a group of
directives that will apply only to the named directory and
sub-directories of that directory. Any directive that is allowed
- in a directory context may be used. <em>Directory-path</em> is
+ in a directory context may be used. <var>Directory-path</var> is
either the full path to a directory, or a wild-card string using
Unix shell-style matching. In a wild-card string, `?' matches any
single character, and `*' matches any sequences of characters.
/*/public_html></code> will not match
<code>/home/user/public_html</code>, but <code><Directory
/home/*/public_html></code> will match. Example:</p>
-<div class="example"><p><code>
- <Directory /usr/local/httpd/htdocs><br />
- Options Indexes FollowSymLinks<br />
- </Directory><br />
-</code></p></div>
-
-<div class="note">
-<p>Be careful with the <em>directory-path</em> arguments: They have
-to literally match the filesystem path which Apache uses to access the
-files. Directives applied to a particular <Directory> will not
-apply to files accessed from that same directory via a different path,
-such as via different symbolic links.</p>
-</div>
+
+ <div class="example"><pre>
+<Directory /usr/local/httpd/htdocs>
+ Options Indexes FollowSymLinks
+</Directory></pre></div>
+
+ <div class="note">
+ <p>Be careful with the <var>directory-path</var> arguments:
+ They have to literally match the filesystem path which Apache uses
+ to access the files. Directives applied to a particular
+ <Directory> will not apply to files accessed from that same
+ directory via a different path, such as via different symbolic
+ links.</p>
+ </div>
<p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-<div class="example"><p><code>
- <Directory ~ "^/www/.*/[0-9]{3}">
-</code></p></div>
+
+ <div class="example"><p><code>
+ <Directory ~ "^/www/.*/[0-9]{3}">
+ </code></p></div>
+
<p>would match directories in /www/ that consisted of three
numbers.</p>
first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example,
with</p>
-<div class="example"><p><code>
- <Directory /><br />
- AllowOverride None<br />
- </Directory><br />
- <br />
- <Directory /home/><br />
- AllowOverride FileInfo<br />
- </Directory>
-</code></p></div>
+ <div class="example"><pre>
+<Directory />
+ AllowOverride None
+</Directory>
+
+<Directory /home/>
+ AllowOverride FileInfo
+</Directory></pre></div>
+
<p>for access to the document <code>/home/web/dir/doc.html</code>
the steps are:</p>
expressions are tested in the order they appeared in the
configuration file. For example, with</p>
-<div class="example"><p><code><Directory ~ abc$><br />
- ... directives here ...<br />
- </Directory><br />
-</code></p></div>
+ <div class="example"><pre>
+<Directory ~ abc$>
+ # ... directives here ...
+</Directory></pre></div>
<p>The regular expression section won't be considered until after
all normal <Directory>s and <code>.htaccess</code> files
recommended that you change this with a block such
as</strong></p>
-<div class="example"><p><code>
- <Directory /><br />
- Order Deny,Allow<br />
- Deny from All<br />
- </Directory>
-</code></p></div>
+ <div class="example"><pre>
+<Directory />
+ Order Deny,Allow
+ Deny from All
+</Directory></pre></div>
<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
</a></th><td>Enclose directives that apply to
file-system directories matching a regular expression and their
subdirectories</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><DirectoryMatch <em>regex</em>>
+ </a></th><td><DirectoryMatch <var>regex</var>>
... </Directory></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
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"><Directory></a></code>. However, it
takes as an argument a regular expression. For example:</p>
-<div class="example"><p><code>
- <DirectoryMatch "^/www/.*/[0-9]{3}">
-</code></p></div>
+
+ <div class="example"><p><code>
+ <DirectoryMatch "^/www/.*/[0-9]{3}">
+ </code></p></div>
<p>would match directories in <code>/www/</code> that consisted of three
numbers.</p>
combined when a request is received</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="DocumentRoot" id="DocumentRoot">DocumentRoot</a> <a name="documentroot" id="documentroot">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Directory that forms the main document tree visible
from the web</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>DocumentRoot <
em>directory-path</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>DocumentRoot <
var>directory-path</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>DocumentRoot /usr/local/apache/htdocs</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
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>
-<div class="example"><p><code>
- DocumentRoot /usr/web
-</code></p></div>
+
+ <div class="example"><p><code>
+ DocumentRoot /usr/web
+ </code></p></div>
+
<p>then an access to
<code>http://www.my.host.com/index.html</code> refers to
<code>/usr/web/index.html</code>.</p>
delivery. By default, when the handling of a request requires
access to the data within a file-- for example, when delivering a
server-parsed file using <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>-- Apache
- memory-maps the file if the OS supports it.
- </p>
- <p>
- This memory-mapping sometimes yields a performance improvement.
+ memory-maps the file if the OS supports it.</p>
+
+ <p>This memory-mapping sometimes yields a performance improvement.
But in some environments, it is better to disable the memory-mapping
- to prevent operational problems:
- </p>
+ to prevent operational problems:</p>
+
<ul>
<li>On some multiprocessor systems, memory-mapping can reduce the
performance of the httpd.</li>
the httpd may crash due tof a segmentation fault if a file is deleted
or truncated while the httpd has it memory-mapped.</li>
</ul>
- <p>
- For server configurations that are vulnerable to these problems,
- you should disable memory-mapping of delivered files by specifying:
- </p>
-<div class="example"><p><code>
- EnableMMAP off
-</code></p></div>
+
+ <p>For server configurations that are vulnerable to these problems,
+ you should disable memory-mapping of delivered files by specifying:</p>
+
+
<div class="example"><p><code>
+ EnableMMAP off
+ </code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ErrorDocument" id="ErrorDocument">ErrorDocument</a> <a name="errordocument" id="errordocument">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>What the server will return to the client
in case of an error</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>ErrorDocument <
em>error-code document</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>ErrorDocument <
var>error-code</var> <var>document</var></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<li>output a customized message</li>
- <li>redirect to a local <em>URL-path</em> to handle the
+ <li>redirect to a local <var>URL-path</var> to handle the
problem/error</li>
- <li>redirect to an external <em>URL</em> to handle the
+ <li>redirect to an external <var>URL</var> to handle the
problem/error</li>
</ol>
URL which the client can resolve. Alternatively, a message can
be provided to be displayed by the browser. Examples:</p>
-<div class="example"><p><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></p></div>
+ <div class="example"><p><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></p></div>
<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
<h3>See also</h3><ul><li><a href="../custom-error.html">documentation of
customizable responses</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ErrorLog" id="ErrorLog">ErrorLog</a> <a name="errorlog" id="errorlog">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Location where the server will log errors</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td> ErrorLog <
em>file-path</em>|syslog[:<em>facility</em>]</td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td> ErrorLog <
var>file-path</var>|syslog[:<var>facility</var>]</td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>ErrorLog logs/error_log (Unix)
ErrorLog logs/error.log (Windows and OS/2)</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>core</td></tr></table>
<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">ServerRoot</a></code>. If the <em>file-path</em>
+ the <var>file-path</var> does not begin with a slash (/) then it is
+ assumed to be relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>. If the <var>file-path</var>
begins with a pipe (|) then it is assumed to be a command to spawn
to handle the error log.</p>
<p>Using <code>syslog</code> instead of a filename enables logging
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
+ using the <code>syslog:<var>facility</var></code> syntax where
+ <var>facility</var> 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>
<h3>See also</h3><ul><li><code class="directive"><a href="#loglevel">LogLevel</a></code></li><li><a href="../logs.html">Apache Log Files</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="FileETag" id="FileETag">FileETag</a> <a name="fileetag" id="fileetag">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>File attributes used to create the ETag
HTTP response header</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>FileETag <
em>component</em> ...</td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>FileETag <
var>component</var> ...</td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>FileETag INode MTime Size</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
FileETag directive allows you to choose which of these -- if any
-- should be used. The recognized keywords are:
</p>
+
<dl>
<dt><strong>INode</strong></dt>
<dd>The file's i-node number will be included in the calculation</dd>
<dt><strong>Size</strong></dt>
<dd>The number of bytes in the file will be included</dd>
<dt><strong>All</strong></dt>
- <dd>All available fields will be used (equivalent to
- '<code>FileETag INode MTime Size</code>')</dd>
+ <dd>All available fields will be used. This is equivalent to:
+ <div class="example"><p><code>FileETag INode MTime Size</code></p></div></dd>
<dt><strong>None</strong></dt>
<dd>If a document is file-based, no ETag field will be included in the
response</dd>
</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>
- If a directory's configuration includes
- '<code>FileETag INode MTime Size</code>', and a
- subdirectory's includes '<code>FileETag -INode</code>',
+
+ <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
+ keywords may be prefixed with either <code>+</code> or <code>-</code>,
+ 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>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>'.
- </p>
+ <code>FileETag MTime Size</code>.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Files" id="Files"><Files></a> <a name="files" id="files">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Contains directives that apply to matched
filenames</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><Files <
em>filename</em>> ... </Files></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td><Files <
var>filename</var>> ... </Files></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
inside <code class="directive"><a href="#directory"><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 <var>filename</var> 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>
-<div class="example"><p><code>
- <Files ~ "\.(gif|jpe?g|png)$">
-</code></p></div>
+
+ <div class="example"><p><code>
+ <Files ~ "\.(gif|jpe?g|png)$">
+ </code></p></div>
+
<p>would match most common Internet graphics formats. In Apache 1.3
and later, <code class="directive"><a href="#filesmatch"><FilesMatch></a></code> is preferred, however.</p>
request is received</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="FilesMatch" id="FilesMatch"><FilesMatch></a> <a name="filesmatch" id="filesmatch">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Contains directives that apply to regular-expression matched
filenames</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><FilesMatch <
em>regex</em>> ... </FilesMatch></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td><FilesMatch <
var>regex</var>> ... </FilesMatch></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<p>The <code class="directive"><FilesMatch></code> directive
provides for access control by filename, just as the <code class="directive"><a href="#files"><Files></a></code> directive
does. However, it accepts a regular expression. For example:</p>
-<div class="example"><p><code>
- <FilesMatch "\.(gif|jpe?g|png)$">
-</code></p></div>
+
+ <div class="example"><p><code>
+ <FilesMatch "\.(gif|jpe?g|png)$">
+ </code></p></div>
<p>would match most common Internet graphics formats.</p>
<h3>See also</h3><ul><li><a href="../sections.html">How
request is received</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ForceType" id="ForceType">ForceType</a> <a name="forcetype" id="forcetype">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Forces all matching files to be served with the specified
MIME content-type</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>ForceType <
em>mime-type</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>ForceType <
var>MIME-type</var></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<code class="directive"><a href="#files"><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
+ <var>MIME-type</var>. 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>
-<div class="example"><p><code>
- ForceType image/gif
-</code></p></div>
+
+ <div class="example"><p><code>
+ ForceType image/gif
+ </code></p></div>
<p>Note that unlike <code class="directive"><a href="#defaulttype">DefaultType</a></code>,
this directive overrides all mime-type associations, including
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
- the <em>/support</em> directory, can be used to look up host
+ the <var>/support</var> directory, can be used to look up host
names from logged IP addresses offline.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="IdentityCheck" id="IdentityCheck">IdentityCheck</a> <a name="identitycheck" id="identitycheck">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Enables logging of the RFC1413 identity of the remote
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="IfDefine" id="IfDefine"><IfDefine></a> <a name="ifdefine" id="ifdefine">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Encloses directives that will be processed only
if a test is true at startup</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><IfDefine [!]<em>parameter-name</em>> <em>...</em>
+ </a></th><td><IfDefine [!]<var>parameter-name</var>> ...
</IfDefine></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
- <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 <code><IfDefine <var>test</var>>...</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 <var>test</var> is true. If <var>
+ test</var> is false, everything between the start and end markers is
+ ignored.</p>
- <p>The <em>test</em> in the <code class="directive"><IfDefine></code> section directive can be one
- of two forms:</p>
+ <p>The <var>test</var> in the <code class="directive"><IfDefine></code> section directive can be one of two forms:</p>
<ul>
- <li><em>parameter-name</em></li>
+ <li><var>parameter-name</var></li>
- <li><code>!</code><em>parameter-name</em></li>
+ <li><code>!</code><var>parameter-name</var></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
+ <var>parameter-name</var> is defined. The second format reverses
the test, and only processes the directives if
- <em>parameter-name</em> is <strong>not</strong> defined.</p>
+ <var>parameter-name</var> is <strong>not</strong> defined.</p>
- <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>The <var>parameter-name</var> argument is a define as given on
+ the <code>httpd</code> command line via <code>-D<var>parameter-</var>
+ </code>, at the time the server was started.</p>
<p><code class="directive"><IfDefine></code> sections are
nest-able, which can be used to implement simple
multiple-parameter tests. Example:</p>
-<div class="example"><pre>
- $ httpd -DReverseProxy ...
- # httpd.conf
- <IfDefine ReverseProxy>
+ <div class="example"><pre>
+$ httpd -DReverseProxy ...
+
+# httpd.conf
+<IfDefine ReverseProxy>
LoadModule rewrite_module modules/mod_rewrite.so
LoadModule proxy_module modules/libproxy.so
- </IfDefine>
-</pre></div>
-
+</IfDefine></pre></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="IfModule" id="IfModule"><IfModule></a> <a name="ifmodule" id="ifmodule">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Encloses directives that are processed conditional on the
presence of absence of a specific module</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><IfModule [!]<em>module-name</em>> <em>...</em>
+ </a></th><td><IfModule [!]<var>module-name</var>> ...
</IfModule></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
- <p>The <code><IfModule
- <em>test</em>>...</IfModule></code> section is used to
- mark directives that are conditional on the presence of a
- specific module. The directives within an
- <code class="directive"><IfModule></code> section are only
- processed if the <em>test</em> is true. If <em>test</em> is false,
- everything between the start and end markers is ignored.</p>
+ <p>The <code><IfModule <var>test</var>>...</IfModule></code>
+ section is used to mark directives that are conditional on the presence of a
+ specific module. The directives within an <code class="directive"><IfModule></code> section are only processed if the <var>test</var>
+ is true. If <var>test</var> is false, everything between the start and
+ end markers is ignored.</p>
- <p>The <em>test</em> in the <code class="directive"><IfModule></code> section directive can be one
- of two forms:</p>
+ <p>The <var>test</var> in the <code class="directive"><IfModule></code> section directive can be one of two forms:</p>
<ul>
- <li><em>module name</em></li>
+ <li><var>module name</var></li>
- <li>!<em>module name</em></li>
+ <li>!<var>module name</var></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 <code class="directive"><a href="../mod/mod_so.html#loadmodule">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>
+ markers are only processed if the module named <var>module
+ name</var> is included in Apache -- either compiled in or
+ dynamically loaded using <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>. The second format reverses the test,
+ and only processes the directives if <var>module name</var> is
+ <strong>not</strong> included.</p>
- <p>The <em>module name</em> argument is the file name of the
+ <p>The <var>module name</var> argument is the file name of the
module, at the time it was compiled. For example,
<code>mod_rewrite.c</code>. If a module consists of several
source files, use the name of the file containing the string
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Include" id="Include">Include</a> <a name="include" id="include">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Includes other configuration files from within
the server configuration files</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>Include <
em>file-path</em>|<em>directory-path</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>Include <
var>file-path</var>|<var>directory-path</var></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
<p>Examples:</p>
-<div class="example"><p><code>
- Include /usr/local/apache/conf/ssl.conf<br />
- Include /usr/local/apache/conf/vhosts/
-</code></p></div>
-
-
<p>Or, providing paths relative to your <code>ServerRoot</code>
- directory:</p>
-
-<div class="example"><p><code>
- Include conf/ssl.conf<br />
- Include conf/vhosts/
-</code></p></div>
-
-
<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>
-
-<div class="example"><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></div>
-
-
<p>This will help in verifying that you are getting only the files
- that you intended as part of your configuration.</p>
+
<div class="example"><p><code>
+ Include /usr/local/apache/conf/ssl.conf<br />
+ Include /usr/local/apache/conf/vhosts/
+ </code></p></div>
+
+ <p>Or, providing paths relative to your <code>ServerRoot</code>
+ directory:</p>
+
+
<div class="example"><p><code>
+ Include conf/ssl.conf<br />
+ Include conf/vhosts/
+ </code></p></div>
+
+ <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>
+
+ <div class="example"><p><code>
+ root@host# apachectl configtest<br />
+ Processing config directory: /usr/local/apache/conf/vhosts<br />
+ Processing config file: /usr/local/apache/conf/vhosts/vhost1<br />
+ Processing config file: /usr/local/apache/conf/vhosts/vhost2<br />
+ Syntax OK
+ </code></p></div>
+
+ <p>This will help in verifying that you are getting only the files
+ that you intended as part of your configuration.</p>
<h3>See also</h3><ul><li><a href="../programs/apachectl.html">apachectl</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="KeepAlive" id="KeepAlive">KeepAlive</a> <a name="keepalive" id="keepalive">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Enables HTTP persistent connections</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
</a></th><td>KeepAlive on|off</td></tr><tr><th><a href="directive-dict.html#Default">Default:
<h3>See also</h3><ul><li><code class="directive"><a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="KeepAliveTimeout" id="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout" id="keepalivetimeout">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Amount of time the server will wait for subsequent
requests on a persistent connection</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>KeepAliveTimeout <
em>seconds</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>KeepAliveTimeout <
var>seconds</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>KeepAliveTimeout 15</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Limit" id="Limit"><Limit></a> <a name="limit" id="limit">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Restrict enclosed access controls to only certain HTTP
methods</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><Limit <em>method</em> [<em>method</em>] ... > ...
+ </a></th><td><Limit <var>method</var> [<var>method</var>] ... > ...
</Limit></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
example applies the access control only to the methods POST, PUT,
and DELETE, leaving all other methods unprotected:</p>
-<div class="example"><p><code>
- <code><Limit POST PUT DELETE><br />
- Require valid-user<br />
- </Limit></code>
-</code></p></div>
- <p>The method names listed can be one or more of: GET, POST, PUT,
- DELETE, CONNECT, OPTIONS, TRACE, PATCH, PROPFIND, PROPPATCH,
- MKCOL, COPY, MOVE, LOCK, and UNLOCK. <strong>The method name is
- case-sensitive.</strong> If GET is used it will also restrict
- HEAD requests.</p>
+ <div class="example"><pre>
+<Limit POST PUT DELETE>
+ Require valid-user
+</Limit></pre></div>
+
+ <p>The method names listed can be one or more of: <code>GET</code>,
+ <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
+ <code>CONNECT</code>, <code>OPTIONS</code>, <code>TRACE</code>,
+ <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
+ <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
+ <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
+ case-sensitive.</strong> If <code>GET</code> is used it will also
+ restrict <code>HEAD</code> requests.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="LimitExcept" id="LimitExcept"><LimitExcept></a> <a name="limitexcept" id="limitexcept">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Restrict access controls to all HTTP methods
except the named ones</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><LimitExcept <em>method</em> [<em>method</em>] ... > ...
+ </a></th><td><LimitExcept <var>method</var> [<var>method</var>] ... > ...
</LimitExcept></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
<p>For example:</p>
- <div class="example"><p><code>
- <LimitExcept POST GET><br />
- Require valid-user<br />
- <LimitExcept>
- </code></p></div>
+ <div class="example"><pre>
+<LimitExcept POST GET>
+ Require valid-user
+<LimitExcept></pre></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="LimitRequestBody" id="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody" id="limitrequestbody">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Restricts the total size of the HTTP request body sent
from the client</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>LimitRequestBody <
em>bytes</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>LimitRequestBody <
var>bytes</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>LimitRequestBody 0</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
- <p>This directive specifies the number of <em>bytes</em> from 0
+ <p>This directive specifies the number of <var>bytes</var> 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
you might use the following directive:</p>
<div class="example"><p><code>
- LimitRequestBody 102400
+ LimitRequestBody 102400
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="LimitRequestFields" id="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields" id="limitrequestfields">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Limits the number of HTTP request header fields that
will be accepted from the client</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>LimitRequestFields <
em>number</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>LimitRequestFields <
var>number</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>LimitRequestFields 100</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
- <p><em>Number</em> is an integer from 0 (meaning unlimited) to
+ <p><var>Number</var> 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>For example:</p>
<div class="example"><p><code>
- LimitRequestFields 50
+ LimitRequestFields 50
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="LimitRequestFieldSize" id="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize" id="limitrequestfieldsize">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Limits the size of the HTTP request header allowed from the
client</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>LimitRequestFieldsize <
em>bytes</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>LimitRequestFieldsize <
var>bytes</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>LimitRequestFieldsize 8190</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
- <p>This directive specifies the number of <em>bytes</em> from 0
+ <p>This directive specifies the number of <var>bytes</var> 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
<p>For example:</p>
<div class="example"><p><code>
- LimitRequestFieldSize 16380
+ LimitRequestFieldSize 16380
</code></p></div>
<div class="note">Under normal conditions, the value should not be changed from
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="LimitRequestLine" id="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline" id="limitrequestline">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Limit the size of the HTTP request line that will be accepted
from the client</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>LimitRequestLine <
em>bytes</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>LimitRequestLine <
var>bytes</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>LimitRequestLine 8190</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
- <p>This directive sets the number of <em>bytes</em> from 0 to
+ <p>This directive sets the number of <var>bytes</var> 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>For example:</p>
<div class="example"><p><code>
- LimitRequestLine 16380
+ LimitRequestLine 16380
</code></p></div>
<div class="note">Under normal conditions, the value should not be changed from
the default.</div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="LimitXMLRequestBody" id="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody" id="limitxmlrequestbody">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Limits the size of an XML-based request body</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>LimitXMLRequestBody <
em>number</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>LimitXMLRequestBody <
var>number</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>LimitXMLRequestBody 1000000</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
<p>Example:</p>
<div class="example"><p><code>
- LimitXMLRequestBody 0
+ LimitXMLRequestBody 0
</code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Location" id="Location"><Location></a> <a name="location" id="location">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
<p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-<div class="example"><p><code>
- <Location ~ "/(extra|special)/data">
-</code></p></div>
+
+ <div class="example"><p><code>
+ <Location ~ "/(extra|special)/data">
+ </code></p></div>
<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="#sethandler">SetHandler</a></code>
directive. For example, to enable status requests, but allow them
only from browsers at foo.com, you might use:</p>
-<div class="example"><p><code>
- <Location /status><br />
- SetHandler server-status<br />
- Order Deny,Allow<br />
- Deny from all<br />
- Allow from .foo.com<br />
- </Location>
-</code></p></div>
-
-<div class="note"><h3>Note about / (slash)</h3> <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"><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>
-</div>
+
+ <div class="example"><pre>
+<Location /status>
+ SetHandler server-status
+ Order Deny,Allow
+ Deny from all
+ Allow from .foo.com
+</Location></pre></div>
+
+ <div class="note"><h3>Note about / (slash)</h3>
+ <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 (<var>i.e.</var>, <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"><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.</p>
+
+ <p>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>
+ </div>
<h3>See also</h3><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
</a></th><td>Applies the enclosed directives only to regular-expression
matching URLs</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
</a></th><td><LocationMatch
- <
em>regex</em>> ... </Location></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ <
var>regex</var>> ... </Location></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
<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"><Location></a></code>. However, it takes a regular
- expression as an argument instead of a simple string. For
- example:</p>
-<div class="example"><p><code>
- <LocationMatch "/(extra|special)/data">
-</code></p></div>
+ <code class="directive"><a href="#location"><Location></a></code>. However,
+ it takes a regular expression as an argument instead of a simple
+ string. For example:</p>
+
+ <div class="example"><p><code>
+ <LocationMatch "/(extra|special)/data">
+ </code></p></div>
- <p>would match URLs that contained the substring "/extra/data"
- or "/special/data".</p>
+ <p>would match URLs that contained the substring <code>/extra/data</code>
+ or <code>/special/data</code>.</p>
<h3>See also</h3><ul><li><a href="../sections.html">How
Directory, Location and Files sections work</a> for an
explanation of how these different sections are combined when a
request is received</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="LogLevel" id="LogLevel">LogLevel</a> <a name="loglevel" id="loglevel">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Controls the verbosity of the ErrorLog</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>LogLevel <
em>level</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>LogLevel <
var>level</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>LogLevel warn</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
<p><code class="directive">LogLevel</code> adjusts the verbosity of the
messages recorded in the error logs (see <code class="directive"><a href="#errorlog">ErrorLog</a></code> directive). The following
- <em>level</em>s are available, in order of decreasing
+ <var>level</var>s are available, in order of decreasing
significance:</p>
<table class="bordered">
<p>For example:</p>
- <div class="example"><p><code>LogLevel notice</code></p></div>
-
+ <div class="example"><p><code>
+ LogLevel notice
+ </code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="MaxKeepAliveRequests" id="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests" id="maxkeepaliverequests">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Number of requests allowed on a persistent
connection</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>MaxKeepAliveRequests <
em>number</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>MaxKeepAliveRequests <
var>number</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>MaxKeepAliveRequests 100</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<p>For example:</p>
- <div class="example"><p><code>MaxKeepAliveRequests 500</code></p></div>
+ <div class="example"><p><code>
+ MaxKeepAliveRequests 500
+ </code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="NameVirtualHost" id="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost" id="namevirtualhost">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Designates an IP address for name-virtual
hosting</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>NameVirtualHost <
em>addr</em>[:<em>port</em>]</td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>NameVirtualHost <
var>addr</var>[:<var>port</var>]</td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
<p>The <code class="directive">NameVirtualHost</code> directive is a
required directive if you want to configure <a href="../vhosts/">name-based virtual hosts</a>.</p>
- <p>Although <em>addr</em> can be hostname it is recommended
- that you always use an IP address, <em>e.g.</em></p>
+ <p>Although <var>addr</var> can be hostname it is recommended
+ that you always use an IP address, e.g.</p>
-<div class="example"><p><code>NameVirtualHost 111.22.33.44</code></p></div>
+ <div class="example"><p><code>
+ NameVirtualHost 111.22.33.44
+ </code></p></div>
<p>With the <code class="directive">NameVirtualHost</code> directive you
specify the IP address on which the server will receive requests
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>
+ name-based virtual hosts should be used, e.g.</p>
-<div class="example"><p><code>NameVirtualHost 111.22.33.44:8080</code></p></div>
+ <div class="example"><p><code>
+ NameVirtualHost 111.22.33.44:8080
+ </code></p></div>
-
<p>IPv6 addresses must be enclosed in square brackets, as shown
- in the following example:</p>
+ <p>IPv6 addresses must be enclosed in square brackets, as shown
+ in the following example:</p>
-<div class="example"><p><code>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</code></p></div>
+ <div class="example"><p><code>
+ NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080
+ </code></p></div>
<p>To receive requests on all interfaces, you can use an argument of
*</p>
-<div class="example"><p><code>NameVirtualHost *</code></p></div>
-
-<div class="note"><h3>Argument to <VirtualHost> directive</h3>
-<p>Note that the argument to the <VirtualHost> directive must exactly
-match the argument to the <code class="directive">NameVirtualHost</code>
-directive.</p>
-<div class="example"><p><code>
-NameVirtualHost 1.2.3.4<br />
-<VirtualHost 1.2.3.4><br />
-...<br />
-</VirtualHost><br />
-</code></p></div>
-</div>
+ <div class="example"><p><code>
+ NameVirtualHost *
+ </code></p></div>
+ <div class="note"><h3>Argument to <VirtualHost> directive</h3>
+ <p>Note that the argument to the <VirtualHost> directive must
+ exactly match the argument to the <code class="directive">NameVirtualHost</code> directive.</p>
+
+ <div class="example"><p><code>
+ NameVirtualHost 1.2.3.4<br />
+ <VirtualHost 1.2.3.4><br />
+ # ...<br />
+ </VirtualHost><br />
+ </code></p></div>
+ </div>
<h3>See also</h3><ul><li>See also: <a href="../vhosts/">Virtual Hosts
documentation</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Options" id="Options">Options</a> <a name="options" id="options">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Configures what features are available in a particular
directory</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
</a></th><td>Options
- [+|-]<
em>option</em> [[+|-]<em>option</em>] ...</td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ [+|-]<
var>option</var> [[+|-]<var>option</var>] ...</td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>Options All</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>Options</td></tr><tr><th><a href="directive-dict.html#Status">Status:
<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><var>option</var> 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>
<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"><Directory></a></code> sections.<br />
- <strong>Note</strong>: this option gets ignored if set inside a
- <code class="directive"><a href="#location"><Location></a></code>
- section.</dd>
+ The server will follow symbolic links in this directory.
+ <div class="note">
+ <p>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"><Directory></a></code> sections.</p>
+ <p>Note also, that this option <strong>gets ignored</strong> if set
+ inside a <code class="directive"><a href="#location"><Location></a></code>
+ section.</p>
+ </div></dd>
<dt>Includes</dt>
<p>For example, without any + and - symbols:</p>
+ <div class="example"><pre>
+<Directory /web/docs>
+ Options Indexes FollowSymLinks
+</Directory>
+
+<Directory /web/docs/spec>
+ Options Includes
+</Directory></pre></div>
-<div class="example"><p><code><Directory /web/docs><br />
- Options Indexes FollowSymLinks<br />
- </Directory><br />
- <Directory /web/docs/spec><br />
- Options Includes<br />
- </Directory>
-</code></p></div>
<p>then only <code>Includes</code> will be set for the
/web/docs/spec directory. However if the second
<code class="directive">Options</code> directive uses the + and - symbols:</p>
-<div class="example"><p><code>
- <Directory /web/docs><br />
- Options Indexes FollowSymLinks<br />
- </Directory><br />
- <Directory /web/docs/spec><br />
- Options +Includes -Indexes<br />
- </Directory>
-</code></p></div>
+ <div class="example"><pre>
+<Directory /web/docs>
+ Options Indexes FollowSymLinks
+</Directory>
+
+<Directory /web/docs/spec>
+ Options +Includes -Indexes
+</Directory></pre></div>
+
<p>then the options <code>FollowSymLinks</code> and
<code>Includes</code> are set for the /web/docs/spec directory.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Require" id="Require">Require</a> <a name="require" id="require">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Selects which authenticated users can access
a resource</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>Require <
em>entity-name</em> [<em>entity-name</em>] ...</td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>Require <
var>entity-name</var> [<var>entity-name</var>] ...</td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>AuthConfig</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<ul>
<li>
- Require user <em>userid</em> [<em>userid</em>] ...
+ Require user <var>userid</var> [<var>userid</var>] ...
<p>Only the named users can access the directory.</p>
</li>
<li>
- Require group <em>group-name</em> [<em>group-name</em>] ...
+ Require group <var>group-name</var> [<var>group-name</var>] ...
<p>Only users in the named groups can access the
and <code class="directive"><a href="../mod/mod_auth.html#authgroupfile">AuthGroupFile</a></code> (to
define users and groups) in order to work correctly. Example:</p>
-<div class="example"><p><code>
+
<div class="example"><p><code>
AuthType Basic<br />
AuthName "Restricted Directory"<br />
AuthUserFile /web/users<br />
AuthGroupFile /web/groups<br />
- Require group admin<br />
-</code></p></div>
+ Require group admin
+ </code></p></div>
<p>Access controls which are applied in this way are effective for
<strong>all</strong> methods. <strong>This is what is normally
<h3>See also</h3><ul><li><code class="directive"><a href="#satisfy">Satisfy</a></code></li><li><code class="module"><a href="../mod/mod_access.html">mod_access</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="RLimitCPU" id="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu" id="rlimitcpu">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Limits the CPU consumption of processes launched
by Apache children</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>RLimitCPU <
em>number</em>|max [<em>number</em>|max]</td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>RLimitCPU <
var>number</var>|max [<var>number</var>|max]</td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>Unset; uses operating system defaults</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
<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
+ or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as root, or in the initial startup
<h3>See also</h3><ul><li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li><li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="RLimitMEM" id="RLimitMEM">RLimitMEM</a> <a name="rlimitmem" id="rlimitmem">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Limits the memory consumption of processes launched
by Apache children</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>RLimitMEM <
em>number</em>|max [<em>number</em>|max]</td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>RLimitMEM <
var>number</var>|max [<var>number</var>|max]</td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>Unset; uses operating system defaults</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
<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
+ or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as root, or in the initial startup
<h3>See also</h3><ul><li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li><li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="RLimitNPROC" id="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc" id="rlimitnproc">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Limits the number of processes that can be launched by
processes launched by Apache children</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>RLimitNPROC <
em>number</em>|max [<em>number</em>|max]</td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>RLimitNPROC <
var>number</var>|max [<var>number</var>|max]</td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>Unset; uses operating system defaults</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>All</td></tr><tr><th><a href="directive-dict.html#Status">Status:
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
+ <strong><code>cannot fork</code></strong> messages in the
error_log.</p>
<h3>See also</h3><ul><li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li><li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Satisfy" id="Satisfy">Satisfy</a> <a name="satisfy" id="satisfy">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Interaction between host-level access control and
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
<p>Access policy if both <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#require">Require</a></code> used. The parameter can be
- either <em>'all'</em> or <em>'any'</em>. This directive is only
+ either <var>all</var> or <var>any</var>. 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 default behavior (<var>all</var>) 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
configuration similar to the following:</p>
<div class="example"><p><code>
- Require valid-user<br />
- Allow from 192.168.1<br />
- Satisfy any
+ Require valid-user<br />
+ Allow from 192.168.1<br />
+ Satisfy any
</code></p></div>
<h3>See also</h3><ul><li><code class="directive"><a href="../mod/mod_access.html#allow">Allow</a></code></li><li><code class="directive"><a href="#require">Require</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ScriptInterpreterSource" id="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource" id="scriptinterpretersource">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ServerAdmin" id="ServerAdmin">ServerAdmin</a> <a name="serveradmin" id="serveradmin">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Email address that the server includes in error
messages sent to the client</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>ServerAdmin <
em>email-address</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>ServerAdmin <
var>email-address</var></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
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>
-<div class="example"><p><code>ServerAdmin www-admin@foo.bar.com</code></p></div>
+ <p>It may be worth setting up a dedicated address for this, e.g.</p>
+
+ <div class="example"><p><code>
+ ServerAdmin www-admin@foo.example.com
+ </code></p></div>
<p>as users do not always mention that they are talking about the
server!</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ServerAlias" id="ServerAlias">ServerAlias</a> <a name="serveralias" id="serveralias">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Alternate names for a host used when matching requests
to name-virtual hosts</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>ServerAlias <
em>hostname</em> [<em>hostname</em>] ...</td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>ServerAlias <
var>hostname</var> [<var>hostname</var>] ...</td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
<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>
-<div class="example"><p><code>
- <VirtualHost *><br />
- ServerName server.domain.com<br />
- ServerAlias server server2.domain.com server2<br />
- ...<br />
- </VirtualHost>
-</code></p></div>
+
<div class="example"><p><code>
+ <VirtualHost *><br />
+ ServerName server.domain.com<br />
+ ServerAlias server server2.domain.com server2<br />
+ # ...<br />
+ </VirtualHost>
+ </code></p></div>
<h3>See also</h3><ul><li><a href="../vhosts/">Apache Virtual Host documentation</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ServerName" id="ServerName">ServerName</a> <a name="servername" id="servername">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Hostname and port that the server uses to identify
itself</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>ServerName <
em>fully-qualified-domain-name[:port]</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>ServerName <
var>fully-qualified-domain-name</var>[:<var>port</var>]</td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr><tr><th><a href="directive-dict.html#Compatibility">Compatibility:
and you wish the webserver to be so identified, the following
directive should be used:</p>
-<div class="example"><p><code>ServerName www.example.com:80</code></p></div>
+ <div class="example"><p><code>
+ ServerName www.example.com:80
+ </code></p></div>
<p>If no <code class="directive">ServerName</code> is specified, then the
server attempts to deduce the hostname by performing a reverse
documentation</a></li><li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li><li><code class="directive"><a href="#namevirtualhost">NameVirtualHost</a></code></li><li><code class="directive"><a href="#serveralias">ServerAlias</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ServerPath" id="ServerPath">ServerPath</a> <a name="serverpath" id="serverpath">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Legacy URL pathname for a name-virtual host that
is accessed by an incompatible browser</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>ServerPath <
em>URL-path</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>ServerPath <
var>URL-path</var></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
URL pathname for a host, for use with <a href="../vhosts/">name-based virtual hosts</a>.</p>
<h3>See also</h3><ul><li><a href="../vhosts/">Apache Virtual Host documentation</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ServerRoot" id="ServerRoot">ServerRoot</a> <a name="serverroot" id="serverroot">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Base directory for the server installation</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>ServerRoot <
em>directory-path</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>ServerRoot <
var>directory-path</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>ServerRoot /usr/local/apache</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
directory.</p>
<div class="example"><h3>Example</h3><p><code>
- ServerRoot /home/httpd
+ ServerRoot /home/httpd
</code></p></div>
<h3>See also</h3><ul><li><a href="../invoking.html">the <code>-d</code>
<h3>See also</h3><ul><li><code class="directive"><a href="#serversignature">ServerSignature</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="SetHandler" id="SetHandler">SetHandler</a> <a name="sethandler" id="sethandler">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Forces all matching files to be processed by a
handler</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>SetHandler <
em>handler-name</em></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>SetHandler <
var>handler-name</var></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<code class="directive"><a href="#location"><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
+ <var>handler-name</var>. 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>
-<div class="example"><p><code>
- SetHandler imap-file
-</code></p></div>
+
+ <div class="example"><p><code>
+ SetHandler imap-file
+ </code></p></div>
<p>Another example: if you wanted to have the server display a
status report whenever a URL of
<code>http://servername/status</code> was called, you might put
the following into httpd.conf:</p>
-<div class="example"><p><code>
- <Location /status><br />
- SetHandler server-status<br />
- </Location>
-</code></p></div>
+ <div class="example"><p><code>
+ <Location /status><br />
+ SetHandler server-status<br />
+ </Location>
+ </code></p></div>
<h3>See also</h3><ul><li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="SetInputFilter" id="SetInputFilter">SetInputFilter</a> <a name="setinputfilter" id="setinputfilter">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Sets the filters that will process client requests and POST
input</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>SetInputFilter <
em>filter</em>[<em>;filter</em>...]</td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>SetInputFilter <
var>filter</var>[;<var>filter</var>...]</td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<h3>See also</h3><ul><li><a href="../filter.html">Filters</a> documentation</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="SetOutputFilter" id="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter" id="setoutputfilter">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Sets the filters that will process responses from the
server</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>SetOutputFilter <
em>filter</em>[<em>;filter</em>...]</td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td>SetOutputFilter <
var>filter</var>[;<var>filter</var>...]</td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
<p>For example, the following configuration will process all files
in the <code>/www/data/</code> directory for server-side
includes.</p>
-<div class="example"><p><code>
-<Directory /www/data/><br />
- SetOutputFilter INCLUDES<br />
-</Directory>
-</code></p></div>
+
+ <div class="example"><pre>
+<Directory /www/data/>
+ SetOutputFilter INCLUDES
+</Directory></pre></div>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
<h3>See also</h3><ul><li><a href="../filter.html">Filters</a> documentation</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="TimeOut" id="TimeOut">TimeOut</a> <a name="timeout" id="timeout">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Amount of time the server will wait for
certain events before failing a request</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td>TimeOut <
em>number</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td>TimeOut <
var>number</var></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>TimeOut 300</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>server config, virtual host, directory</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>core</td></tr></table>
- <p>In many situations Apache must construct a
- <em>self-referential</em> URL -- that is, a URL that 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">ServerName</a></code> directive to construct the 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 must construct a <em>self-referential</em>
+ URL -- that is, a URL that 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">ServerName</a></code>
+ directive to construct the 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
self-referential URLs using the hostname and port supplied by
</a></th><td>Contains directives that apply only to a specific
hostname or IP address</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
</a></th><td><VirtualHost
- <em>addr</em>[:<em>port</em>] [<em>addr</em>[:<em>port</em>]]
+ <var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
...> ... </VirtualHost></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Core</td></tr><tr><th><a href="directive-dict.html#Module">Module:
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>
+ section. <var>Addr</var> can be:</p>
<ul>
<li>The IP address of the virtual host;</li>
with IP virtual hosting to catch unmatched IP addresses.</li>
</ul>
-
-<div class="example"><h3>Example</h3><p><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></p></div>
+ <div class="example"><h3>Example</h3><p><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></p></div>
-
<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>
-
-<div class="example"><p><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></p></div>
+ <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>
+
+ <div class="example"><p><code>
+ <VirtualHost [fe80::a00:20ff:fea7:ccea]><br />
+ ServerAdmin webmaster@host.example.com<br />
+ DocumentRoot /www/docs/host.example.com<br />
+ ServerName host.example.com<br />
+ ErrorLog logs/host.example.com-error_log<br />
+ TransferLog logs/host.example.com-access_log<br />
+ </VirtualHost>
+ </code></p></div>
<p>Each Virtual Host must correspond to a different IP address,
different port number or a different host name for the server,
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>
-<example>
-<Files "mypaths.shtml"><br />
- Options +Includes<br />
- SetOutputFilter INCLUDES<br />
- AcceptPathInfo on<br />
-</Files>
-</example>
+
+ <example><pre>
+<Files "mypaths.shtml">
+ Options +Includes
+ SetOutputFilter INCLUDES
+ AcceptPathInfo on
+</Files></pre>
+ </example>
+
</usage>
</directivesynopsis>
<directivesynopsis>
<name>AccessFileName</name>
<description>Name of the distributed configuration file</description>
-<syntax>AccessFileName <em>filename</em> [<em>filename</em>] ...</syntax>
+<syntax>AccessFileName <var>filename</var> [<var>filename</var>] ...</syntax>
<default>AccessFileName .htaccess</default>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
configuration files are enabled for that directory. For
example:</p>
-<example>
-AccessFileName .acl
-</example>
+ <example>
+ AccessFileName .acl
+ </example>
<p>before returning the document
<code>/usr/local/web/index.html</code>, the server will read
<code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
for directives, unless they have been disabled with</p>
-<example>
-<Directory /><br />
- AllowOverride None<br />
-</Directory>
-</example>
+ <example><pre>
+<Directory />
+ AllowOverride None
+</Directory></pre>
+ </example>
</usage>
<seealso><directive module="core">AllowOverride</directive></seealso>
<seealso><a href="../configuring.html">Configuration Files</a></seealso>
<name>AddDefaultCharset</name>
<description>Default character set to be added for a
response without an explicit character set</description>
-<syntax>AddDefaultCharset On|Off|<em>charset</em></syntax>
+<syntax>AddDefaultCharset On|Off|<var>charset</var></syntax>
<default>AddDefaultCharset Off</default>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<override>FileInfo</override>
<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
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>
+ <var>charset</var> to be used. For example:</p>
-<example>
- AddDefaultCharset utf-8
-</example>
+ <example>
+ AddDefaultCharset utf-8
+ </example>
</usage>
</directivesynopsis>
<name>AllowOverride</name>
<description>Types of directives that are allowed in
.htaccess files</description>
-<syntax>AllowOverride All|None|<em>directive-type</em>
-[<em>directive-type</em>] ...</syntax>
+<syntax>AllowOverride All|None|<var>directive-type</var>
+[<var>directive-type</var>] ...</syntax>
<default>AllowOverride All</default>
<contextlist><context>directory</context></contextlist>
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 <var>directive-type</var> can be one of the following
groupings of directives.</p>
<dl>
<p>Example:</p>
- <example>AllowOverride AuthConfig Indexes</example>
+ <example>
+ AllowOverride AuthConfig Indexes
+ </example>
</usage>
<seealso><directive module="core">AccessFileName</directive></seealso>
<name>AuthName</name>
<description>Authorization realm for use in HTTP
authentication</description>
-<syntax>AuthName <em>auth-domain</em></syntax>
+<syntax>AuthName <var>auth-domain</var></syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
<p>For example:</p>
- <example>AuthName "Top Secret"</example>
+ <example>
+ AuthName "Top Secret"
+ </example>
<p>The string provided for the <code>AuthName</code> is what will
appear in the password dialog provided by most browsers.</p>
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>
-<example>
- Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
-</example>
+
+ <example>
+ Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
+ </example>
<p>Note that this can cause performance problems on your server
since the message digest is computed on every request (the
<name>DefaultType</name>
<description>MIME content-type that will be sent if the
server cannot determine a type in any other way</description>
-<syntax>DefaultType <em>MIME-type</em></syntax>
+<syntax>DefaultType <var>MIME-type</var></syntax>
<default>DefaultType text/plain</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
document, so in the event of an unknown type it uses the
<code>DefaultType</code>. For example:</p>
-<example>
- <code>DefaultType image/gif</code>
-</example>
+ <example>
+ DefaultType image/gif
+ </example>
+
<p>would be appropriate for a directory which contained many gif
images with filenames missing the .gif extension.</p>
<name>Directory</name>
<description>Enclose a group of directives that apply only to the
named file-system directory and sub-directories</description>
-<syntax><Directory <em>directory-path</em>>
+<syntax><Directory <var>directory-path</var>>
... </Directory></syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<code></Directory></code> are used to enclose a group of
directives that will apply only to the named directory and
sub-directories of that directory. Any directive that is allowed
- in a directory context may be used. <em>Directory-path</em> is
+ in a directory context may be used. <var>Directory-path</var> is
either the full path to a directory, or a wild-card string using
Unix shell-style matching. In a wild-card string, `?' matches any
single character, and `*' matches any sequences of characters.
/*/public_html></code> will not match
<code>/home/user/public_html</code>, but <code><Directory
/home/*/public_html></code> will match. Example:</p>
-<example>
- <Directory /usr/local/httpd/htdocs><br />
- Options Indexes FollowSymLinks<br />
- </Directory><br />
-</example>
-
-<note>
-<p>Be careful with the <em>directory-path</em> arguments: They have
-to literally match the filesystem path which Apache uses to access the
-files. Directives applied to a particular <Directory> will not
-apply to files accessed from that same directory via a different path,
-such as via different symbolic links.</p>
-</note>
+
+ <example><pre>
+<Directory /usr/local/httpd/htdocs>
+ Options Indexes FollowSymLinks
+</Directory></pre>
+ </example>
+
+ <note>
+ <p>Be careful with the <var>directory-path</var> arguments:
+ They have to literally match the filesystem path which Apache uses
+ to access the files. Directives applied to a particular
+ <Directory> will not apply to files accessed from that same
+ directory via a different path, such as via different symbolic
+ links.</p>
+ </note>
<p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-<example>
- <Directory ~ "^/www/.*/[0-9]{3}">
-</example>
+
+ <example>
+ <Directory ~ "^/www/.*/[0-9]{3}">
+ </example>
+
<p>would match directories in /www/ that consisted of three
numbers.</p>
href="#accessfilename">.htaccess</a> files. For example,
with</p>
-<example>
- <Directory /><br />
- AllowOverride None<br />
- </Directory><br />
- <br />
- <Directory /home/><br />
- AllowOverride FileInfo<br />
- </Directory>
-</example>
+ <example><pre>
+<Directory />
+ AllowOverride None
+</Directory>
+
+<Directory /home/>
+ AllowOverride FileInfo
+</Directory></pre>
+ </example>
+
<p>for access to the document <code>/home/web/dir/doc.html</code>
the steps are:</p>
expressions are tested in the order they appeared in the
configuration file. For example, with</p>
-<example><Directory ~ abc$><br />
- ... directives here ...<br />
- </Directory><br />
-</example>
+ <example><pre>
+<Directory ~ abc$>
+ # ... directives here ...
+</Directory></pre>
+ </example>
<p>The regular expression section won't be considered until after
all normal <Directory>s and <code>.htaccess</code> files
recommended that you change this with a block such
as</strong></p>
-<example>
- <Directory /><br />
- Order Deny,Allow<br />
- Deny from All<br />
- </Directory>
-</example>
+ <example><pre>
+<Directory />
+ Order Deny,Allow
+ Deny from All
+</Directory></pre>
+ </example>
<p><strong>and then override this for directories you
<em>want</em> accessible. See the <a
<description>Enclose directives that apply to
file-system directories matching a regular expression and their
subdirectories</description>
-<syntax><DirectoryMatch <em>regex</em>>
+<syntax><DirectoryMatch <var>regex</var>>
... </Directory></syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
sub-directories of that directory, the same as <directive
module="core" type="section">Directory</directive>. However, it
takes as an argument a regular expression. For example:</p>
-<example>
- <DirectoryMatch "^/www/.*/[0-9]{3}">
-</example>
+
+ <example>
+ <DirectoryMatch "^/www/.*/[0-9]{3}">
+ </example>
<p>would match directories in <code>/www/</code> that consisted of three
numbers.</p>
<name>DocumentRoot</name>
<description>Directory that forms the main document tree visible
from the web</description>
-<syntax>DocumentRoot <em>directory-path</em></syntax>
+<syntax>DocumentRoot <var>directory-path</var></syntax>
<default>DocumentRoot /usr/local/apache/htdocs</default>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
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>
-<example>
- DocumentRoot /usr/web
-</example>
+
+ <example>
+ DocumentRoot /usr/web
+ </example>
+
<p>then an access to
<code>http://www.my.host.com/index.html</code> refers to
<code>/usr/web/index.html</code>.</p>
delivery. By default, when the handling of a request requires
access to the data within a file-- for example, when delivering a
server-parsed file using <module>mod_include</module>-- Apache
- memory-maps the file if the OS supports it.
- </p>
- <p>
- This memory-mapping sometimes yields a performance improvement.
+ memory-maps the file if the OS supports it.</p>
+
+ <p>This memory-mapping sometimes yields a performance improvement.
But in some environments, it is better to disable the memory-mapping
- to prevent operational problems:
- </p>
+ to prevent operational problems:</p>
+
<ul>
<li>On some multiprocessor systems, memory-mapping can reduce the
performance of the httpd.</li>
the httpd may crash due tof a segmentation fault if a file is deleted
or truncated while the httpd has it memory-mapped.</li>
</ul>
- <p>
- For server configurations that are vulnerable to these problems,
- you should disable memory-mapping of delivered files by specifying:
- </p>
-<example>
- EnableMMAP off
-</example>
+
+ <p>For server configurations that are vulnerable to these problems,
+ you should disable memory-mapping of delivered files by specifying:</p>
+
+ <example>
+ EnableMMAP off
+ </example>
</usage>
</directivesynopsis>
<name>ErrorDocument</name>
<description>What the server will return to the client
in case of an error</description>
-<syntax>ErrorDocument <em>error-code document</em></syntax>
+<syntax>ErrorDocument <var>error-code</var> <var>document</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<li>output a customized message</li>
- <li>redirect to a local <em>URL-path</em> to handle the
+ <li>redirect to a local <var>URL-path</var> to handle the
problem/error</li>
- <li>redirect to an external <em>URL</em> to handle the
+ <li>redirect to an external <var>URL</var> to handle the
problem/error</li>
</ol>
URL which the client can resolve. Alternatively, a message can
be provided to be displayed by the browser. Examples:</p>
-<example>
- 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"
-</example>
+ <example>
+ 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"
+ </example>
<p>Note that when you specify an <directive>ErrorDocument</directive>
that points to a remote URL (ie. anything with a method such as
<directivesynopsis>
<name>ErrorLog</name>
<description>Location where the server will log errors</description>
-<syntax> ErrorLog <em>file-path</em>|syslog[:<em>facility</em>]</syntax>
+<syntax> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</syntax>
<default>ErrorLog logs/error_log (Unix)
ErrorLog logs/error.log (Windows and OS/2)</default>
<contextlist><context>server config</context><context>virtual host</context>
<usage>
<p>The <directive>ErrorLog</directive> 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
+ the <var>file-path</var> does not begin with a slash (/) then it is
assumed to be relative to the <directive
- module="core">ServerRoot</directive>. If the <em>file-path</em>
+ module="core">ServerRoot</directive>. If the <var>file-path</var>
begins with a pipe (|) then it is assumed to be a command to spawn
to handle the error log.</p>
<p>Using <code>syslog</code> instead of a filename enables logging
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
+ using the <code>syslog:<var>facility</var></code> syntax where
+ <var>facility</var> can be one of the names usually documented in
syslog(1).</p>
<p>SECURITY: See the <a
<name>FileETag</name>
<description>File attributes used to create the ETag
HTTP response header</description>
-<syntax>FileETag <em>component</em> ...</syntax>
+<syntax>FileETag <var>component</var> ...</syntax>
<default>FileETag INode MTime Size</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
FileETag directive allows you to choose which of these -- if any
-- should be used. The recognized keywords are:
</p>
+
<dl>
<dt><strong>INode</strong></dt>
<dd>The file's i-node number will be included in the calculation</dd>
<dt><strong>Size</strong></dt>
<dd>The number of bytes in the file will be included</dd>
<dt><strong>All</strong></dt>
- <dd>All available fields will be used (equivalent to
- '<code>FileETag INode MTime Size</code>')</dd>
+ <dd>All available fields will be used. This is equivalent to:
+ <example>FileETag INode MTime Size</example></dd>
<dt><strong>None</strong></dt>
<dd>If a document is file-based, no ETag field will be included in the
response</dd>
</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>
- If a directory's configuration includes
- '<code>FileETag INode MTime Size</code>', and a
- subdirectory's includes '<code>FileETag -INode</code>',
+
+ <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
+ keywords may be prefixed with either <code>+</code> or <code>-</code>,
+ 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>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>'.
- </p>
+ <code>FileETag MTime Size</code>.</p>
</usage>
</directivesynopsis>
<name>Files</name>
<description>Contains directives that apply to matched
filenames</description>
-<syntax><Files <em>filename</em>> ... </Files></syntax>
+<syntax><Files <var>filename</var>> ... </Files></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
module="core">Directory</directive> 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 <var>filename</var> 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>
-<example>
- <Files ~ "\.(gif|jpe?g|png)$">
-</example>
+
+ <example>
+ <Files ~ "\.(gif|jpe?g|png)$">
+ </example>
+
<p>would match most common Internet graphics formats. In Apache 1.3
and later, <directive module="core"
type="section">FilesMatch</directive> is preferred, however.</p>
<name>FilesMatch</name>
<description>Contains directives that apply to regular-expression matched
filenames</description>
-<syntax><FilesMatch <em>regex</em>> ... </FilesMatch></syntax>
+<syntax><FilesMatch <var>regex</var>> ... </FilesMatch></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
provides for access control by filename, just as the <directive
module="core" type="section">Files</directive> directive
does. However, it accepts a regular expression. For example:</p>
-<example>
- <FilesMatch "\.(gif|jpe?g|png)$">
-</example>
+
+ <example>
+ <FilesMatch "\.(gif|jpe?g|png)$">
+ </example>
<p>would match most common Internet graphics formats.</p>
</usage>
<name>ForceType</name>
<description>Forces all matching files to be served with the specified
MIME content-type</description>
-<syntax>ForceType <em>mime-type</em></syntax>
+<syntax>ForceType <var>MIME-type</var></syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<directive type="section" module="core">Files</directive>
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
+ <var>MIME-type</var>. 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>
-<example>
- ForceType image/gif
-</example>
+
+ <example>
+ ForceType image/gif
+ </example>
<p>Note that unlike <directive module="core">DefaultType</directive>,
this directive overrides all mime-type associations, including
<code>off</code>, since DNS lookups can take considerable
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
+ the <var>/support</var> directory, can be used to look up host
names from logged IP addresses offline.</p>
</usage>
</directivesynopsis>
<name>IfDefine</name>
<description>Encloses directives that will be processed only
if a test is true at startup</description>
-<syntax><IfDefine [!]<em>parameter-name</em>> <em>...</em>
+<syntax><IfDefine [!]<var>parameter-name</var>> ...
</IfDefine></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
<override>All</override>
<usage>
- <p>The <code><IfDefine
- <em>test</em>>...</IfDefine></code> section is used to
- mark directives that are conditional. The directives within an
- <directive type="section">IfDefine</directive> 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 <var>test</var>>...</IfDefine>
+ </code> section is used to mark directives that are conditional. The
+ directives within an <directive type="section">IfDefine</directive>
+ section are only processed if the <var>test</var> is true. If <var>
+ test</var> is false, everything between the start and end markers is
+ ignored.</p>
- <p>The <em>test</em> in the <directive
- type="section">IfDefine</directive> section directive can be one
- of two forms:</p>
+ <p>The <var>test</var> in the <directive type="section"
+ >IfDefine</directive> section directive can be one of two forms:</p>
<ul>
- <li><em>parameter-name</em></li>
+ <li><var>parameter-name</var></li>
- <li><code>!</code><em>parameter-name</em></li>
+ <li><code>!</code><var>parameter-name</var></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
+ <var>parameter-name</var> is defined. The second format reverses
the test, and only processes the directives if
- <em>parameter-name</em> is <strong>not</strong> defined.</p>
+ <var>parameter-name</var> is <strong>not</strong> defined.</p>
- <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>The <var>parameter-name</var> argument is a define as given on
+ the <code>httpd</code> command line via <code>-D<var>parameter-</var>
+ </code>, at the time the server was started.</p>
<p><directive type="section">IfDefine</directive> sections are
nest-able, which can be used to implement simple
multiple-parameter tests. Example:</p>
-<example><pre>
- $ httpd -DReverseProxy ...
- # httpd.conf
- <IfDefine ReverseProxy>
+ <example><pre>
+$ httpd -DReverseProxy ...
+
+# httpd.conf
+<IfDefine ReverseProxy>
LoadModule rewrite_module modules/mod_rewrite.so
LoadModule proxy_module modules/libproxy.so
- </IfDefine>
-</pre></example>
-
+</IfDefine></pre>
+ </example>
</usage>
</directivesynopsis>
<name>IfModule</name>
<description>Encloses directives that are processed conditional on the
presence of absence of a specific module</description>
-<syntax><IfModule [!]<em>module-name</em>> <em>...</em>
+<syntax><IfModule [!]<var>module-name</var>> ...
</IfModule></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
<override>All</override>
<usage>
- <p>The <code><IfModule
- <em>test</em>>...</IfModule></code> section is used to
- mark directives that are conditional on the presence of a
- specific module. The directives within an
- <directive type="section">IfModule</directive> 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 <directive
- type="section">IfModule</directive> section directive can be one
- of two forms:</p>
+ <p>The <code><IfModule <var>test</var>>...</IfModule></code>
+ section is used to mark directives that are conditional on the presence of a
+ specific module. The directives within an <directive type="section"
+ >IfModule</directive> section are only processed if the <var>test</var>
+ is true. If <var>test</var> is false, everything between the start and
+ end markers is ignored.</p>
+
+ <p>The <var>test</var> in the <directive type="section"
+ >IfModule</directive> section directive can be one of two forms:</p>
<ul>
- <li><em>module name</em></li>
+ <li><var>module name</var></li>
- <li>!<em>module name</em></li>
+ <li>!<var>module name</var></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
+ markers are only processed if the module named <var>module
+ name</var> is included in Apache -- either compiled in or
dynamically loaded using <directive module="mod_so"
- >LoadModule</directive>. The second format
- reverses the test, and only processes the directives if <em>module
- name</em> is <strong>not</strong> included.</p>
+ >LoadModule</directive>. The second format reverses the test,
+ and only processes the directives if <var>module name</var> is
+ <strong>not</strong> included.</p>
- <p>The <em>module name</em> argument is the file name of the
+ <p>The <var>module name</var> argument is the file name of the
module, at the time it was compiled. For example,
<code>mod_rewrite.c</code>. If a module consists of several
source files, use the name of the file containing the string
<name>Include</name>
<description>Includes other configuration files from within
the server configuration files</description>
-<syntax>Include <em>file-path</em>|<em>directory-path</em></syntax>
+<syntax>Include <var>file-path</var>|<var>directory-path</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context>
</contextlist>
<p>Examples:</p>
-<example>
- Include /usr/local/apache/conf/ssl.conf<br />
- Include /usr/local/apache/conf/vhosts/
-</example>
-
-
<p>Or, providing paths relative to your <code>ServerRoot</code>
- directory:</p>
-
-<example>
- Include conf/ssl.conf<br />
- Include conf/vhosts/
-</example>
-
-
<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>
-
-<example><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></example>
-
-
<p>This will help in verifying that you are getting only the files
- that you intended as part of your configuration.</p>
+ <example>
+ Include /usr/local/apache/conf/ssl.conf<br />
+ Include /usr/local/apache/conf/vhosts/
+ </example>
+
+ <p>Or, providing paths relative to your <code>ServerRoot</code>
+ directory:</p>
+
+ <example>
+ Include conf/ssl.conf<br />
+ Include conf/vhosts/
+ </example>
+
+ <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>
+
+ <example>
+ root@host# apachectl configtest<br />
+ Processing config directory: /usr/local/apache/conf/vhosts<br />
+ Processing config file: /usr/local/apache/conf/vhosts/vhost1<br />
+ Processing config file: /usr/local/apache/conf/vhosts/vhost2<br />
+ Syntax OK
+ </example>
+
+ <p>This will help in verifying that you are getting only the files
+ that you intended as part of your configuration.</p>
</usage>
<seealso><a href="../programs/apachectl.html">apachectl</a></seealso>
<name>KeepAliveTimeout</name>
<description>Amount of time the server will wait for subsequent
requests on a persistent connection</description>
-<syntax>KeepAliveTimeout <em>seconds</em></syntax>
+<syntax>KeepAliveTimeout <var>seconds</var></syntax>
<default>KeepAliveTimeout 15</default>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<name>Limit</name>
<description>Restrict enclosed access controls to only certain HTTP
methods</description>
-<syntax><Limit <em>method</em> [<em>method</em>] ... > ...
+<syntax><Limit <var>method</var> [<var>method</var>] ... > ...
</Limit></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
example applies the access control only to the methods POST, PUT,
and DELETE, leaving all other methods unprotected:</p>
-<example>
- <code><Limit POST PUT DELETE><br />
- Require valid-user<br />
- </Limit></code>
-</example>
- <p>The method names listed can be one or more of: GET, POST, PUT,
- DELETE, CONNECT, OPTIONS, TRACE, PATCH, PROPFIND, PROPPATCH,
- MKCOL, COPY, MOVE, LOCK, and UNLOCK. <strong>The method name is
- case-sensitive.</strong> If GET is used it will also restrict
- HEAD requests.</p>
+ <example><pre>
+<Limit POST PUT DELETE>
+ Require valid-user
+</Limit></pre>
+ </example>
+
+ <p>The method names listed can be one or more of: <code>GET</code>,
+ <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
+ <code>CONNECT</code>, <code>OPTIONS</code>, <code>TRACE</code>,
+ <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
+ <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
+ <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
+ case-sensitive.</strong> If <code>GET</code> is used it will also
+ restrict <code>HEAD</code> requests.</p>
</usage>
</directivesynopsis>
<name>LimitExcept</name>
<description>Restrict access controls to all HTTP methods
except the named ones</description>
-<syntax><LimitExcept <em>method</em> [<em>method</em>] ... > ...
+<syntax><LimitExcept <var>method</var> [<var>method</var>] ... > ...
</LimitExcept></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
<p>For example:</p>
- <example>
- <LimitExcept POST GET><br />
- Require valid-user<br />
- <LimitExcept>
+ <example><pre>
+<LimitExcept POST GET>
+ Require valid-user
+<LimitExcept></pre>
</example>
</usage>
<name>LimitRequestBody</name>
<description>Restricts the total size of the HTTP request body sent
from the client</description>
-<syntax>LimitRequestBody <em>bytes</em></syntax>
+<syntax>LimitRequestBody <var>bytes</var></syntax>
<default>LimitRequestBody 0</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
<override>All</override>
<usage>
- <p>This directive specifies the number of <em>bytes</em> from 0
+ <p>This directive specifies the number of <var>bytes</var> 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
you might use the following directive:</p>
<example>
- LimitRequestBody 102400
+ LimitRequestBody 102400
</example>
</usage>
<name>LimitRequestFields</name>
<description>Limits the number of HTTP request header fields that
will be accepted from the client</description>
-<syntax>LimitRequestFields <em>number</em></syntax>
+<syntax>LimitRequestFields <var>number</var></syntax>
<default>LimitRequestFields 100</default>
<contextlist><context>server config</context></contextlist>
<usage>
- <p><em>Number</em> is an integer from 0 (meaning unlimited) to
+ <p><var>Number</var> 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>For example:</p>
<example>
- LimitRequestFields 50
+ LimitRequestFields 50
</example>
</usage>
<name>LimitRequestFieldSize</name>
<description>Limits the size of the HTTP request header allowed from the
client</description>
-<syntax>LimitRequestFieldsize <em>bytes</em></syntax>
+<syntax>LimitRequestFieldsize <var>bytes</var></syntax>
<default>LimitRequestFieldsize 8190</default>
<contextlist><context>server config</context></contextlist>
<usage>
- <p>This directive specifies the number of <em>bytes</em> from 0
+ <p>This directive specifies the number of <var>bytes</var> 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
<p>For example:</p>
<example>
- LimitRequestFieldSize 16380
+ LimitRequestFieldSize 16380
</example>
<note>Under normal conditions, the value should not be changed from
<name>LimitRequestLine</name>
<description>Limit the size of the HTTP request line that will be accepted
from the client</description>
-<syntax>LimitRequestLine <em>bytes</em></syntax>
+<syntax>LimitRequestLine <var>bytes</var></syntax>
<default>LimitRequestLine 8190</default>
<contextlist><context>server config</context></contextlist>
<usage>
- <p>This directive sets the number of <em>bytes</em> from 0 to
+ <p>This directive sets the number of <var>bytes</var> 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>For example:</p>
<example>
- LimitRequestLine 16380
+ LimitRequestLine 16380
</example>
<note>Under normal conditions, the value should not be changed from
<directivesynopsis>
<name>LimitXMLRequestBody</name>
<description>Limits the size of an XML-based request body</description>
-<syntax>LimitXMLRequestBody <em>number</em></syntax>
+<syntax>LimitXMLRequestBody <var>number</var></syntax>
<default>LimitXMLRequestBody 1000000</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<p>Example:</p>
<example>
- LimitXMLRequestBody 0
+ LimitXMLRequestBody 0
</example>
</usage>
<p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
-<example>
- <Location ~ "/(extra|special)/data">
-</example>
+
+ <example>
+ <Location ~ "/(extra|special)/data">
+ </example>
<p>would match URLs that contained the substring "/extra/data" or
"/special/data". In Apache 1.3 and above, a new directive
<directive module="core">SetHandler</directive>
directive. For example, to enable status requests, but allow them
only from browsers at foo.com, you might use:</p>
-<example>
- <Location /status><br />
- SetHandler server-status<br />
- Order Deny,Allow<br />
- Deny from all<br />
- Allow from .foo.com<br />
- </Location>
-</example>
-
-<note><title>Note about / (slash)</title> <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 <directive type="section"
-module="core">LocationMatch</directive> directive and the regex
-version of <directive type="section">Location</directive> 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) <directive
-type="section">Location</directive> directive behaves similarly when
-used for proxy requests. But when (non-regex) <directive
-type="section">Location</directive> 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>
-</note>
+
+ <example><pre>
+<Location /status>
+ SetHandler server-status
+ Order Deny,Allow
+ Deny from all
+ Allow from .foo.com
+</Location></pre>
+ </example>
+
+ <note><title>Note about / (slash)</title>
+ <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 (<var>i.e.</var>, <code>/home///foo</code> is the same as
+ <code>/home/foo</code>). In URL-space this is not necessarily true.
+ The <directive type="section" module="core">LocationMatch</directive>
+ directive and the regex version of <directive type="section"
+ >Location</directive> require you to explicitly specify multiple
+ slashes if that is your intention.</p>
+
+ <p>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) <directive type="section"
+ >Location</directive> directive behaves similarly when used for
+ proxy requests. But when (non-regex) <directive type="section"
+ >Location</directive> 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>
+ </note>
</usage>
<seealso><a href="../sections.html">How
Directory, Location and Files sections work</a> for an
<description>Applies the enclosed directives only to regular-expression
matching URLs</description>
<syntax><LocationMatch
- <em>regex</em>> ... </Location></syntax>
+ <var>regex</var>> ... </Location></syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<usage>
<p>The <directive type="section">LocationMatch</directive> directive
provides for access control by URL, in an identical manner to
- <directive module="core"
- type="section">Location</directive>. However, it takes a regular
- expression as an argument instead of a simple string. For
- example:</p>
-<example>
- <LocationMatch "/(extra|special)/data">
-</example>
+ <directive module="core" type="section">Location</directive>. However,
+ it takes a regular expression as an argument instead of a simple
+ string. For example:</p>
- <p>would match URLs that contained the substring "/extra/data"
- or "/special/data".</p>
+ <example>
+ <LocationMatch "/(extra|special)/data">
+ </example>
+
+ <p>would match URLs that contained the substring <code>/extra/data</code>
+ or <code>/special/data</code>.</p>
</usage>
<seealso><a href="../sections.html">How
<directivesynopsis>
<name>LogLevel</name>
<description>Controls the verbosity of the ErrorLog</description>
-<syntax>LogLevel <em>level</em></syntax>
+<syntax>LogLevel <var>level</var></syntax>
<default>LogLevel warn</default>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<p><directive>LogLevel</directive> adjusts the verbosity of the
messages recorded in the error logs (see <directive
module="core">ErrorLog</directive> directive). The following
- <em>level</em>s are available, in order of decreasing
+ <var>level</var>s are available, in order of decreasing
significance:</p>
<table border="1">
<p>For example:</p>
- <example>LogLevel notice</example>
-
+ <example>
+ LogLevel notice
+ </example>
</usage>
</directivesynopsis>
<name>MaxKeepAliveRequests</name>
<description>Number of requests allowed on a persistent
connection</description>
-<syntax>MaxKeepAliveRequests <em>number</em></syntax>
+<syntax>MaxKeepAliveRequests <var>number</var></syntax>
<default>MaxKeepAliveRequests 100</default>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<p>For example:</p>
- <example>MaxKeepAliveRequests 500</example>
+ <example>
+ MaxKeepAliveRequests 500
+ </example>
</usage>
</directivesynopsis>
<name>NameVirtualHost</name>
<description>Designates an IP address for name-virtual
hosting</description>
-<syntax>NameVirtualHost <em>addr</em>[:<em>port</em>]</syntax>
+<syntax>NameVirtualHost <var>addr</var>[:<var>port</var>]</syntax>
<contextlist><context>server config</context></contextlist>
<usage>
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 <var>addr</var> can be hostname it is recommended
+ that you always use an IP address, e.g.</p>
-<example>NameVirtualHost 111.22.33.44</example>
+ <example>
+ NameVirtualHost 111.22.33.44
+ </example>
<p>With the <directive>NameVirtualHost</directive> directive you
specify the IP address on which the server will receive requests
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>
+ name-based virtual hosts should be used, e.g.</p>
-<example>NameVirtualHost 111.22.33.44:8080</example>
+ <example>
+ NameVirtualHost 111.22.33.44:8080
+ </example>
-
<p>IPv6 addresses must be enclosed in square brackets, as shown
- in the following example:</p>
+ <p>IPv6 addresses must be enclosed in square brackets, as shown
+ in the following example:</p>
-<example>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</example>
+ <example>
+ NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080
+ </example>
<p>To receive requests on all interfaces, you can use an argument of
*</p>
-<example>NameVirtualHost *</example>
-
-<note><title>Argument to <VirtualHost> directive</title>
-<p>Note that the argument to the <VirtualHost> directive must exactly
-match the argument to the <directive>NameVirtualHost</directive>
-directive.</p>
-<example>
-NameVirtualHost 1.2.3.4<br />
-<VirtualHost 1.2.3.4><br />
-...<br />
-</VirtualHost><br />
-</example>
-</note>
+ <example>
+ NameVirtualHost *
+ </example>
+ <note><title>Argument to <VirtualHost> directive</title>
+ <p>Note that the argument to the <VirtualHost> directive must
+ exactly match the argument to the <directive
+ >NameVirtualHost</directive> directive.</p>
+
+ <example>
+ NameVirtualHost 1.2.3.4<br />
+ <VirtualHost 1.2.3.4><br />
+ # ...<br />
+ </VirtualHost><br />
+ </example>
+ </note>
</usage>
<seealso>See also: <a href="../vhosts/">Virtual Hosts
<description>Configures what features are available in a particular
directory</description>
<syntax>Options
- [+|-]<em>option</em> [[+|-]<em>option</em>] ...</syntax>
+ [+|-]<var>option</var> [[+|-]<var>option</var>] ...</syntax>
<default>Options All</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
<p>The <directive>Options</directive> 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><var>option</var> 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>
<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 <directive type="section"
- module="core">Directory</directive> sections.<br />
- <strong>Note</strong>: this option gets ignored if set inside a
- <directive type="section" module="core">Location</directive>
- section.</dd>
+ The server will follow symbolic links in this directory.
+ <note>
+ <p>Even though the server follows the symlink it does <em>not</em>
+ change the pathname used to match against <directive type="section"
+ module="core">Directory</directive> sections.</p>
+ <p>Note also, that this option <strong>gets ignored</strong> if set
+ inside a <directive type="section" module="core">Location</directive>
+ section.</p>
+ </note></dd>
<dt>Includes</dt>
<p>For example, without any + and - symbols:</p>
+ <example><pre>
+<Directory /web/docs>
+ Options Indexes FollowSymLinks
+</Directory>
+
+<Directory /web/docs/spec>
+ Options Includes
+</Directory></pre>
+ </example>
-<example><Directory /web/docs><br />
- Options Indexes FollowSymLinks<br />
- </Directory><br />
- <Directory /web/docs/spec><br />
- Options Includes<br />
- </Directory>
-</example>
<p>then only <code>Includes</code> will be set for the
/web/docs/spec directory. However if the second
<directive>Options</directive> directive uses the + and - symbols:</p>
-<example>
- <Directory /web/docs><br />
- Options Indexes FollowSymLinks<br />
- </Directory><br />
- <Directory /web/docs/spec><br />
- Options +Includes -Indexes<br />
- </Directory>
-</example>
+ <example><pre>
+<Directory /web/docs>
+ Options Indexes FollowSymLinks
+</Directory>
+
+<Directory /web/docs/spec>
+ Options +Includes -Indexes
+</Directory></pre>
+ </example>
+
<p>then the options <code>FollowSymLinks</code> and
<code>Includes</code> are set for the /web/docs/spec directory.</p>
<name>Require</name>
<description>Selects which authenticated users can access
a resource</description>
-<syntax>Require <em>entity-name</em> [<em>entity-name</em>] ...</syntax>
+<syntax>Require <var>entity-name</var> [<var>entity-name</var>] ...</syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
<ul>
<li>
- Require user <em>userid</em> [<em>userid</em>] ...
+ Require user <var>userid</var> [<var>userid</var>] ...
<p>Only the named users can access the directory.</p>
</li>
<li>
- Require group <em>group-name</em> [<em>group-name</em>] ...
+ Require group <var>group-name</var> [<var>group-name</var>] ...
<p>Only users in the named groups can access the
and <directive module="mod_auth">AuthGroupFile</directive> (to
define users and groups) in order to work correctly. Example:</p>
-<example>
+ <example>
AuthType Basic<br />
AuthName "Restricted Directory"<br />
AuthUserFile /web/users<br />
AuthGroupFile /web/groups<br />
- Require group admin<br />
-</example>
+ Require group admin
+ </example>
<p>Access controls which are applied in this way are effective for
<strong>all</strong> methods. <strong>This is what is normally
<name>RLimitCPU</name>
<description>Limits the CPU consumption of processes launched
by Apache children</description>
-<syntax>RLimitCPU <em>number</em>|max [<em>number</em>|max]</syntax>
+<syntax>RLimitCPU <var>number</var>|max [<var>number</var>|max]</syntax>
<default>Unset; uses operating system defaults</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<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
+ or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as root, or in the initial startup
<name>RLimitMEM</name>
<description>Limits the memory consumption of processes launched
by Apache children</description>
-<syntax>RLimitMEM <em>number</em>|max [<em>number</em>|max]</syntax>
+<syntax>RLimitMEM <var>number</var>|max [<var>number</var>|max]</syntax>
<default>Unset; uses operating system defaults</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<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
+ or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as root, or in the initial startup
<name>RLimitNPROC</name>
<description>Limits the number of processes that can be launched by
processes launched by Apache children</description>
-<syntax>RLimitNPROC <em>number</em>|max [<em>number</em>|max]</syntax>
+<syntax>RLimitNPROC <var>number</var>|max [<var>number</var>|max]</syntax>
<default>Unset; uses operating system defaults</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
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
+ <strong><code>cannot fork</code></strong> messages in the
error_log.</p>
</usage>
<seealso><directive module="core">RLimitMEM</directive></seealso>
<p>Access policy if both <directive
module="core">Allow</directive> and <directive
module="core">Require</directive> used. The parameter can be
- either <em>'all'</em> or <em>'any'</em>. This directive is only
+ either <var>all</var> or <var>any</var>. 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 default behavior (<var>all</var>) 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
configuration similar to the following:</p>
<example>
- Require valid-user<br />
- Allow from 192.168.1<br />
- Satisfy any
+ Require valid-user<br />
+ Allow from 192.168.1<br />
+ Satisfy any
</example>
</usage>
<name>ServerAdmin</name>
<description>Email address that the server includes in error
messages sent to the client</description>
-<syntax>ServerAdmin <em>email-address</em></syntax>
+<syntax>ServerAdmin <var>email-address</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
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>
-<example>ServerAdmin www-admin@foo.bar.com</example>
+ <p>It may be worth setting up a dedicated address for this, e.g.</p>
+
+ <example>
+ ServerAdmin www-admin@foo.example.com
+ </example>
<p>as users do not always mention that they are talking about the
server!</p>
</usage>
<name>ServerAlias</name>
<description>Alternate names for a host used when matching requests
to name-virtual hosts</description>
-<syntax>ServerAlias <em>hostname</em> [<em>hostname</em>] ...</syntax>
+<syntax>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</syntax>
<contextlist><context>virtual host</context></contextlist>
<usage>
alternate names for a host, for use with <a
href="../vhosts/name-based.html">name-based virtual hosts</a>.</p>
-<example>
- <VirtualHost *><br />
- ServerName server.domain.com<br />
- ServerAlias server server2.domain.com server2<br />
- ...<br />
- </VirtualHost>
-</example>
+ <example>
+ <VirtualHost *><br />
+ ServerName server.domain.com<br />
+ ServerAlias server server2.domain.com server2<br />
+ # ...<br />
+ </VirtualHost>
+ </example>
</usage>
<seealso><a href="../vhosts/">Apache Virtual Host documentation</a></seealso>
</directivesynopsis>
<name>ServerName</name>
<description>Hostname and port that the server uses to identify
itself</description>
-<syntax>ServerName <em>fully-qualified-domain-name[:port]</em></syntax>
+<syntax>ServerName <var>fully-qualified-domain-name</var>[:<var>port</var>]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<compatibility>In version 2.0, this
and you wish the webserver to be so identified, the following
directive should be used:</p>
-<example>ServerName www.example.com:80</example>
+ <example>
+ ServerName www.example.com:80
+ </example>
<p>If no <directive>ServerName</directive> is specified, then the
server attempts to deduce the hostname by performing a reverse
<name>ServerPath</name>
<description>Legacy URL pathname for a name-virtual host that
is accessed by an incompatible browser</description>
-<syntax>ServerPath <em>URL-path</em></syntax>
+<syntax>ServerPath <var>URL-path</var></syntax>
<contextlist><context>virtual host</context></contextlist>
<usage>
<directivesynopsis>
<name>ServerRoot</name>
<description>Base directory for the server installation</description>
-<syntax>ServerRoot <em>directory-path</em></syntax>
+<syntax>ServerRoot <var>directory-path</var></syntax>
<default>ServerRoot /usr/local/apache</default>
<contextlist><context>server config</context></contextlist>
directory.</p>
<example><title>Example</title>
- ServerRoot /home/httpd
+ ServerRoot /home/httpd
</example>
</usage>
<name>SetHandler</name>
<description>Forces all matching files to be processed by a
handler</description>
-<syntax>SetHandler <em>handler-name</em></syntax>
+<syntax>SetHandler <var>handler-name</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<directive type="section" module="core">Location</directive>
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
+ <var>handler-name</var>. 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>
-<example>
- SetHandler imap-file
-</example>
+
+ <example>
+ SetHandler imap-file
+ </example>
<p>Another example: if you wanted to have the server display a
status report whenever a URL of
<code>http://servername/status</code> was called, you might put
the following into httpd.conf:</p>
-<example>
- <Location /status><br />
- SetHandler server-status<br />
- </Location>
-</example>
+ <example>
+ <Location /status><br />
+ SetHandler server-status<br />
+ </Location>
+ </example>
</usage>
<seealso><directive module="mod_mime">AddHandler</directive></seealso>
<name>SetInputFilter</name>
<description>Sets the filters that will process client requests and POST
input</description>
-<syntax>SetInputFilter <em>filter</em>[<em>;filter</em>...]</syntax>
+<syntax>SetInputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<name>SetOutputFilter</name>
<description>Sets the filters that will process responses from the
server</description>
-<syntax>SetOutputFilter <em>filter</em>[<em>;filter</em>...]</syntax>
+<syntax>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<p>For example, the following configuration will process all files
in the <code>/www/data/</code> directory for server-side
includes.</p>
-<example>
-<Directory /www/data/><br />
- SetOutputFilter INCLUDES<br />
-</Directory>
-</example>
+
+ <example><pre>
+<Directory /www/data/>
+ SetOutputFilter INCLUDES
+</Directory></pre>
+ </example>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
<name>TimeOut</name>
<description>Amount of time the server will wait for
certain events before failing a request</description>
-<syntax>TimeOut <em>number</em></syntax>
+<syntax>TimeOut <var>number</var></syntax>
<default>TimeOut 300</default>
<contextlist><context>server config</context></contextlist>
<context>directory</context></contextlist>
<usage>
- <p>In many situations Apache must construct a
- <em>self-referential</em> URL -- that is, a URL that refers back to
- the same server. With <code>UseCanonicalName on</code> Apache will
- use the hostname and port specified in the <directive
- module="core">ServerName</directive> directive to construct the 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 must construct a <em>self-referential</em>
+ URL -- that is, a URL that refers back to the same server. With
+ <code>UseCanonicalName on</code> Apache will use the hostname and port
+ specified in the <directive module="core">ServerName</directive>
+ directive to construct the 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
self-referential URLs using the hostname and port supplied by
<description>Contains directives that apply only to a specific
hostname or IP address</description>
<syntax><VirtualHost
- <em>addr</em>[:<em>port</em>] [<em>addr</em>[:<em>port</em>]]
+ <var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
...> ... </VirtualHost></syntax>
<contextlist><context>server config</context></contextlist>
used. When the server receives a request for a document on a
particular virtual host, it uses the configuration directives
enclosed in the <directive type="section">VirtualHost</directive>
- section. <em>Addr</em> can be</p>
+ section. <var>Addr</var> can be:</p>
<ul>
<li>The IP address of the virtual host;</li>
with IP virtual hosting to catch unmatched IP addresses.</li>
</ul>
-
-<example><title>Example</title>
- <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>
-</example>
+ <example><title>Example</title>
+ <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>
+ </example>
-
<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>
-
-<example>
-<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>
-</example>
+ <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>
+
+ <example>
+ <VirtualHost [fe80::a00:20ff:fea7:ccea]><br />
+ ServerAdmin webmaster@host.example.com<br />
+ DocumentRoot /www/docs/host.example.com<br />
+ ServerName host.example.com<br />
+ ErrorLog logs/host.example.com-error_log<br />
+ TransferLog logs/host.example.com-access_log<br />
+ </VirtualHost>
+ </example>
<p>Each Virtual Host must correspond to a different IP address,
different port number or a different host name for the server,
<table class="qref"><tr><td><a href="prefork.html#acceptmutex" id="A" name="A">AcceptMutex default|<em>method</em></a></td><td> default </td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">Method that Apache uses to serialize multiple children
accepting requests on network sockets</td></tr>
<tr class="odd"><td><a href="core.html#acceptpathinfo">AcceptPathInfo On|Off|Default</a></td><td> Default </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Resources accept trailing pathname information</td></tr>
-<tr><td><a href="core.html#accessfilename">AccessFileName <em>filename</em> [<em>filename</em>] ...</a></td><td> .htaccess </td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Name of the distributed configuration file</td></tr>
+<tr><td><a href="core.html#accessfilename">AccessFileName <var>filename</var> [<var>filename</var>] ...</a></td><td> .htaccess </td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Name of the distributed configuration file</td></tr>
<tr class="odd"><td><a href="mod_actions.html#action">Action <em>action-type cgi-script</em></a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Activates a CGI script for a particular handler or
content-type</td></tr>
<tr><td><a href="mod_autoindex.html#addalt">AddAlt <em>string file</em> [<em>file</em>] ...</a></td><td /><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Alternate text to display for a file, instead of an
<tr class="odd"><td><a href="mod_mime.html#addcharset">AddCharset <em>charset extension</em>
[<em>extension</em>] ...</a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Maps the given filename extensions
to the specified content charset</td></tr>
-<tr><td><a href="core.html#adddefaultcharset">AddDefaultCharset On|Off|<em>charset</em></a></td><td> Off </td><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Default character set to be added for a
+<tr><td><a href="core.html#adddefaultcharset">AddDefaultCharset On|Off|<var>charset</var></a></td><td> Off </td><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Default character set to be added for a
response without an explicit character set</td></tr>
<tr class="odd"><td><a href="mod_autoindex.html#adddescription">AddDescription
<em>string file</em> [<em>file</em>] ...</a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Description to display for a file</td></tr>
server</td></tr>
<tr class="odd"><td><a href="mod_proxy.html#allowconnect">AllowCONNECT <em>port</em> [<em>port</em>] ...</a></td><td> 443 563 </td><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Ports that are allowed to <code>CONNECT</code> through
the proxy</td></tr>
-<tr><td><a href="core.html#allowoverride">AllowOverride All|None|<em>directive-type</em>
-[<em>directive-type</em>] ...</a></td><td> All </td><td>d</td><td>C</td></tr><tr><td class="descr" colspan="4">Types of directives that are allowed in
+<tr><td><a href="core.html#allowoverride">AllowOverride All|None|<var>directive-type</var>
+[<var>directive-type</var>] ...</a></td><td> All </td><td>d</td><td>C</td></tr><tr><td class="descr" colspan="4">Types of directives that are allowed in
.htaccess files</td></tr>
<tr class="odd"><td><a href="mod_auth_anon.html#anonymous">Anonymous <em>user</em> [<em>user</em>] ...</a></td><td /><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Specifies userIDs that areallowed access without
password verification</td></tr>
environment variable</td></tr>
<tr><td><a href="mod_auth_ldap.html#authldapstarttls directive">AuthLDAPStartTLS on|off</a></td><td /><td>dh</td><td>X</td></tr><tr><td class="descr" colspan="4">Use a secure TLS connection to the LDAP server</td></tr>
<tr class="odd"><td><a href="mod_auth_ldap.html#authldapurl">AuthLDAPUrl <em>url</em></a></td><td /><td>dh</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">URL specifying the LDAP search parameters</td></tr>
-<tr><td><a href="core.html#authname">AuthName <em>auth-domain</em></a></td><td /><td>dh</td><td>C</td></tr><tr><td class="descr" colspan="4">Authorization realm for use in HTTP
+<tr><td><a href="core.html#authname">AuthName <var>auth-domain</var></a></td><td /><td>dh</td><td>C</td></tr><tr><td class="descr" colspan="4">Authorization realm for use in HTTP
authentication</td></tr>
<tr class="odd"><td><a href="core.html#authtype">AuthType Basic|Digest</a></td><td /><td>dh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Type of user authentication</td></tr>
<tr><td><a href="mod_auth.html#authuserfile">AuthUserFile <em>file-path</em></a></td><td /><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets the name of a text file containing the list of users and
<tr><td><a href="mod_mime.html#defaultlanguage">DefaultLanguage
<em>MIME-lang</em></a></td><td /><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets all files in the given scope to the
specified language</td></tr>
-<tr class="odd"><td><a href="core.html#defaulttype">DefaultType <em>MIME-type</em></a></td><td> text/plain </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">MIME content-type that will be sent if the
+<tr class="odd"><td><a href="core.html#defaulttype">DefaultType <var>MIME-type</var></a></td><td> text/plain </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">MIME content-type that will be sent if the
server cannot determine a type in any other way</td></tr>
<tr><td><a href="mod_deflate.html#deflatebuffersize">DeflateBufferSize <em>value</em></a></td><td> 8096 </td><td>sv</td><td>E</td></tr><tr><td class="descr" colspan="4">Fragment size to be compressed at one time by zlib</td></tr>
<tr class="odd"><td><a href="mod_deflate.html#deflatefilternote">DeflateFilterNote <em>notename</em></a></td><td /><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Places the compression ratio in a note for logging</td></tr>
all|<em>host</em>|env=<em>env-variable</em>
[<em>host</em>|env=<em>env-variable</em>] ...</a></td><td /><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Controls which hosts are denied access to the
server</td></tr>
-<tr class="odd"><td><a href="core.html#directory"><Directory <em>directory-path</em>>
+<tr class="odd"><td><a href="core.html#directory"><Directory <var>directory-path</var>>
... </Directory></a></td><td /><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Enclose a group of directives that apply only to the
named file-system directory and sub-directories</td></tr>
<tr><td><a href="mod_dir.html#directoryindex">DirectoryIndex
<em>local-url</em> [<em>local-url</em>] ...</a></td><td> index.html </td><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">List of resources to look for when the client requests
a directory</td></tr>
-<tr class="odd"><td><a href="core.html#directorymatch"><DirectoryMatch <em>regex</em>>
+<tr class="odd"><td><a href="core.html#directorymatch"><DirectoryMatch <var>regex</var>>
... </Directory></a></td><td /><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Enclose directives that apply to
file-system directories matching a regular expression and their
subdirectories</td></tr>
-<tr><td><a href="core.html#documentroot">DocumentRoot <em>directory-path</em></a></td><td> /usr/local/apache/h +</td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Directory that forms the main document tree visible
+<tr><td><a href="core.html#documentroot">DocumentRoot <var>directory-path</var></a></td><td> /usr/local/apache/h +</td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Directory that forms the main document tree visible
from the web</td></tr>
<tr class="odd"><td><a href="core.html#enablemmap" id="E" name="E">EnableMMAP on|off</a></td><td> on </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Use memory-mapping to read files during delivery</td></tr>
-<tr><td><a href="core.html#errordocument">ErrorDocument <em>error-code document</em></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">What the server will return to the client
+<tr><td><a href="core.html#errordocument">ErrorDocument <var>error-code</var> <var>document</var></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">What the server will return to the client
in case of an error</td></tr>
-<tr class="odd"><td><a href="core.html#errorlog"> ErrorLog <em>file-path</em>|syslog[:<em>facility</em>]</a></td><td> logs/error_log (Uni +</td><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Location where the server will log errors</td></tr>
+<tr class="odd"><td><a href="core.html#errorlog"> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</a></td><td> logs/error_log (Uni +</td><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Location where the server will log errors</td></tr>
<tr><td><a href="mod_example.html#example">Example</a></td><td /><td>svdh</td><td>X</td></tr><tr><td class="descr" colspan="4">Demonstration directive to illustrate the Apache module
API</td></tr>
<tr class="odd"><td><a href="mod_expires.html#expiresactive">ExpiresActive On|Off</a></td><td /><td>svdh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Enables generation of <code>Expires</code> headers</td></tr>
<tr class="odd"><td><a href="mod_ext_filter.html#extfilterdefine">ExtFilterDefine <em>filtername</em> <em>parameters</em></a></td><td /><td>s</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">-</td></tr>
<tr><td><a href="mod_ext_filter.html#extfilteroptions">ExtFilterOptions
<em>option</em> [<em>option</em>] ...</a></td><td> DebugLevel=0 NoLogS +</td><td>d</td><td>X</td></tr><tr><td class="descr" colspan="4">-</td></tr>
-<tr class="odd"><td><a href="core.html#fileetag" id="F" name="F">FileETag <em>component</em> ...</a></td><td> INode MTime Size </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">File attributes used to create the ETag
+<tr class="odd"><td><a href="core.html#fileetag" id="F" name="F">FileETag <var>component</var> ...</a></td><td> INode MTime Size </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">File attributes used to create the ETag
HTTP response header</td></tr>
-<tr><td><a href="core.html#files"><Files <em>filename</em>> ... </Files></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Contains directives that apply to matched
+<tr><td><a href="core.html#files"><Files <var>filename</var>> ... </Files></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Contains directives that apply to matched
filenames</td></tr>
-<tr class="odd"><td><a href="core.html#filesmatch"><FilesMatch <em>regex</em>> ... </FilesMatch></a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Contains directives that apply to regular-expression matched
+<tr class="odd"><td><a href="core.html#filesmatch"><FilesMatch <var>regex</var>> ... </FilesMatch></a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Contains directives that apply to regular-expression matched
filenames</td></tr>
<tr><td><a href="mod_negotiation.html#forcelanguagepriority">ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback]</a></td><td> Prefer </td><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Action to take if a single acceptable document is not
found</td></tr>
-<tr class="odd"><td><a href="core.html#forcetype">ForceType <em>mime-type</em></a></td><td /><td>dh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Forces all matching files to be served with the specified
+<tr class="odd"><td><a href="core.html#forcetype">ForceType <var>MIME-type</var></a></td><td /><td>dh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Forces all matching files to be served with the specified
MIME content-type</td></tr>
<tr><td><a href="mpm_common.html#group" id="G" name="G">Group <em>unix-group</em></a></td><td> #-1 </td><td>sv</td><td>M</td></tr><tr><td class="descr" colspan="4">Group under which the server will answer
requests</td></tr>
<tr class="odd"><td><a href="core.html#hostnamelookups">HostnameLookups on|off|double</a></td><td> off </td><td>svd</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Enables DNS lookups on client IP addresses</td></tr>
<tr><td><a href="core.html#identitycheck" id="I" name="I">IdentityCheck on|off</a></td><td> off </td><td>svd</td><td>C</td></tr><tr><td class="descr" colspan="4">Enables logging of the RFC1413 identity of the remote
user</td></tr>
-<tr class="odd"><td><a href="core.html#ifdefine"><IfDefine [!]<em>parameter-name</em>> <em>...</em>
+<tr class="odd"><td><a href="core.html#ifdefine"><IfDefine [!]<var>parameter-name</var>> ...
</IfDefine></a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Encloses directives that will be processed only
if a test is true at startup</td></tr>
-<tr><td><a href="core.html#ifmodule"><IfModule [!]<em>module-name</em>> <em>...</em>
+<tr><td><a href="core.html#ifmodule"><IfModule [!]<var>module-name</var>> ...
</IfModule></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Encloses directives that are processed conditional on the
presence of absence of a specific module</td></tr>
<tr class="odd"><td><a href="mod_imap.html#imapbase">ImapBase map|referer|<em>URL</em></a></td><td> http://servername/ </td><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Default <code>base</code> for imagemap files</td></tr>
<tr class="odd"><td><a href="mod_imap.html#imapmenu">ImapMenu
none|formatted|semiformatted|unformatted</a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Action if no coordinates are given when calling
an imagemap</td></tr>
-<tr><td><a href="core.html#include">Include <em>file-path</em>|<em>directory-path</em></a></td><td /><td>svd</td><td>C</td></tr><tr><td class="descr" colspan="4">Includes other configuration files from within
+<tr><td><a href="core.html#include">Include <var>file-path</var>|<var>directory-path</var></a></td><td /><td>svd</td><td>C</td></tr><tr><td class="descr" colspan="4">Includes other configuration files from within
the server configuration files</td></tr>
<tr class="odd"><td><a href="mod_autoindex.html#indexignore">IndexIgnore <em>file</em> [<em>file</em>] ...</a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Adds to the list of files to hide when listing
a directory</td></tr>
<tr class="odd"><td><a href="mod_isapi.html#isapireadaheadbuffer">ISAPIReadAheadBuffer <em>size</em></a></td><td> 49152 </td><td>sdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Size of the Read Ahead Buffer sent to ISAPI
extensions</td></tr>
<tr><td><a href="core.html#keepalive" id="K" name="K">KeepAlive on|off</a></td><td> On </td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Enables HTTP persistent connections</td></tr>
-<tr class="odd"><td><a href="core.html#keepalivetimeout">KeepAliveTimeout <em>seconds</em></a></td><td> 15 </td><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Amount of time the server will wait for subsequent
+<tr class="odd"><td><a href="core.html#keepalivetimeout">KeepAliveTimeout <var>seconds</var></a></td><td> 15 </td><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Amount of time the server will wait for subsequent
requests on a persistent connection</td></tr>
<tr><td><a href="mod_negotiation.html#languagepriority" id="L" name="L">LanguagePriority <em>MIME-lang</em> [<em>MIME-lang</em>] ...</a></td><td /><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">The precendence of language variants for cases where
the client does not express a preference</td></tr>
<tr class="odd"><td><a href="mod_ldap.html#ldapopcachettl">LDAPOpCacheTTL <em>seconds</em></a></td><td> 600 </td><td>s</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">Time that entries in the operation cache remain
valid</td></tr>
<tr><td><a href="mod_ldap.html#ldapsharedcachesize">LDAPSharedCacheSize <em>bytes</em></a></td><td> 102400 </td><td>s</td><td>X</td></tr><tr><td class="descr" colspan="4">Size in bytes of the shared-memory cache</td></tr>
-<tr class="odd"><td><a href="core.html#limit"><Limit <em>method</em> [<em>method</em>] ... > ...
+<tr class="odd"><td><a href="core.html#limit"><Limit <var>method</var> [<var>method</var>] ... > ...
</Limit></a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Restrict enclosed access controls to only certain HTTP
methods</td></tr>
-<tr><td><a href="core.html#limitexcept"><LimitExcept <em>method</em> [<em>method</em>] ... > ...
+<tr><td><a href="core.html#limitexcept"><LimitExcept <var>method</var> [<var>method</var>] ... > ...
</LimitExcept></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Restrict access controls to all HTTP methods
except the named ones</td></tr>
-<tr class="odd"><td><a href="core.html#limitrequestbody">LimitRequestBody <em>bytes</em></a></td><td> 0 </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Restricts the total size of the HTTP request body sent
+<tr class="odd"><td><a href="core.html#limitrequestbody">LimitRequestBody <var>bytes</var></a></td><td> 0 </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Restricts the total size of the HTTP request body sent
from the client</td></tr>
-<tr><td><a href="core.html#limitrequestfields">LimitRequestFields <em>number</em></a></td><td> 100 </td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Limits the number of HTTP request header fields that
+<tr><td><a href="core.html#limitrequestfields">LimitRequestFields <var>number</var></a></td><td> 100 </td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Limits the number of HTTP request header fields that
will be accepted from the client</td></tr>
-<tr class="odd"><td><a href="core.html#limitrequestfieldsize">LimitRequestFieldsize <em>bytes</em></a></td><td /><td>s</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Limits the size of the HTTP request header allowed from the
+<tr class="odd"><td><a href="core.html#limitrequestfieldsize">LimitRequestFieldsize <var>bytes</var></a></td><td /><td>s</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Limits the size of the HTTP request header allowed from the
client</td></tr>
-<tr><td><a href="core.html#limitrequestline">LimitRequestLine <em>bytes</em></a></td><td> 8190 </td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Limit the size of the HTTP request line that will be accepted
+<tr><td><a href="core.html#limitrequestline">LimitRequestLine <var>bytes</var></a></td><td> 8190 </td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Limit the size of the HTTP request line that will be accepted
from the client</td></tr>
-<tr class="odd"><td><a href="core.html#limitxmlrequestbody">LimitXMLRequestBody <em>number</em></a></td><td> 1000000 </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Limits the size of an XML-based request body</td></tr>
+<tr class="odd"><td><a href="core.html#limitxmlrequestbody">LimitXMLRequestBody <var>number</var></a></td><td> 1000000 </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Limits the size of an XML-based request body</td></tr>
<tr><td><a href="mpm_common.html#listen">Listen [<em>IP-address</em>:]<em>portnumber</em></a></td><td /><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">IP addresses and ports that the server
listens to</td></tr>
<tr class="odd"><td><a href="mpm_common.html#listenbacklog">ListenBacklog <em>backlog</em></a></td><td /><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Maximum length of the queue of pending connections</td></tr>
URL-path|URL> ... </Location></a></td><td /><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Applies the enclosed directives only to matching
URLs</td></tr>
<tr class="odd"><td><a href="core.html#locationmatch"><LocationMatch
- <em>regex</em>> ... </Location></a></td><td /><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Applies the enclosed directives only to regular-expression
+ <var>regex</var>> ... </Location></a></td><td /><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Applies the enclosed directives only to regular-expression
matching URLs</td></tr>
<tr><td><a href="mpm_common.html#lockfile">LockFile <em>filename</em></a></td><td> logs/accept.lock </td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">Location of the accept serialization lock file</td></tr>
<tr class="odd"><td><a href="mod_log_config.html#logformat">LogFormat
<em>format</em>|<em>nickname</em> [<em>nickname</em>]</a></td><td> "%h %l %u %t \"%r\" +</td><td>s</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Describes a format for use in a log file</td></tr>
-<tr><td><a href="core.html#loglevel">LogLevel <em>level</em></a></td><td> warn </td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Controls the verbosity of the ErrorLog</td></tr>
+<tr><td><a href="core.html#loglevel">LogLevel <var>level</var></a></td><td> warn </td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Controls the verbosity of the ErrorLog</td></tr>
<tr class="odd"><td><a href="mpm_common.html#maxclients" id="M" name="M">MaxClients <em>number</em></a></td><td /><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Maximum number of child processes that will be created
to serve requests</td></tr>
-<tr><td><a href="core.html#maxkeepaliverequests">MaxKeepAliveRequests <em>number</em></a></td><td> 100 </td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Number of requests allowed on a persistent
+<tr><td><a href="core.html#maxkeepaliverequests">MaxKeepAliveRequests <var>number</var></a></td><td> 100 </td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Number of requests allowed on a persistent
connection</td></tr>
<tr class="odd"><td><a href="mpm_common.html#maxmemfree">MaxMemFree <em>number</em></a></td><td /><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Maximum amount of memory that the main allocator is allowed
to hold without calling free()</td></tr>
<tr class="odd"><td><a href="mod_mime.html#multiviewsmatch">MultiviewsMatch
<em>[NegotiatedOnly] [Handlers] [Filters] [Any]</em></a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The types of files that will be included when
searching for a matching file with MultiViews</td></tr>
-<tr><td><a href="core.html#namevirtualhost" id="N" name="N">NameVirtualHost <em>addr</em>[:<em>port</em>]</a></td><td /><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Designates an IP address for name-virtual
+<tr><td><a href="core.html#namevirtualhost" id="N" name="N">NameVirtualHost <var>addr</var>[:<var>port</var>]</a></td><td /><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Designates an IP address for name-virtual
hosting</td></tr>
<tr class="odd"><td><a href="mod_proxy.html#noproxy">NoProxy <em>host</em> [<em>host</em>] ...</a></td><td /><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Hosts, domains, or networks that will be connected
to directly</td></tr>
<tr><td><a href="mpm_common.html#numservers">NumServers <em>number</em></a></td><td> 2 </td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">Total number of children alive at the same time</td></tr>
<tr class="odd"><td><a href="core.html#options" id="O" name="O">Options
- [+|-]<em>option</em> [[+|-]<em>option</em>] ...</a></td><td> All </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Configures what features are available in a particular
+ [+|-]<var>option</var> [[+|-]<var>option</var>] ...</a></td><td> All </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Configures what features are available in a particular
directory</td></tr>
<tr><td><a href="mod_access.html#order"> Order <em>ordering</em></a></td><td> Deny,Allow </td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Controls the default access state and the order in which
<code class="directive">Allow</code> and <code class="directive">Deny</code> are
extensions</td></tr>
<tr><td><a href="mod_headers.html#requestheader">RequestHeader set|append|add|unset <em>header</em>
[<em>value</em>]</a></td><td /><td>svdh</td><td>E</td></tr><tr><td class="descr" colspan="4">Configure HTTP request headers</td></tr>
-<tr class="odd"><td><a href="core.html#require">Require <em>entity-name</em> [<em>entity-name</em>] ...</a></td><td /><td>dh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Selects which authenticated users can access
+<tr class="odd"><td><a href="core.html#require">Require <var>entity-name</var> [<var>entity-name</var>] ...</a></td><td /><td>dh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Selects which authenticated users can access
a resource</td></tr>
<tr><td><a href="mod_rewrite.html#rewritebase">RewriteBase <em>URL-path</em></a></td><td /><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Sets the base URL for per-directory rewrites</td></tr>
<tr class="odd"><td><a href="mod_rewrite.html#rewritecond"> RewriteCond
<tr class="odd"><td><a href="mod_rewrite.html#rewriteoptions">RewriteOptions <em>Options</em></a></td><td /><td>svdh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Sets some special options for the rewrite engine</td></tr>
<tr><td><a href="mod_rewrite.html#rewriterule">RewriteRule
<em>Pattern</em> <em>Substitution</em></a></td><td /><td>svdh</td><td>E</td></tr><tr><td class="descr" colspan="4">Defines rules for the rewriting engine</td></tr>
-<tr class="odd"><td><a href="core.html#rlimitcpu">RLimitCPU <em>number</em>|max [<em>number</em>|max]</a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Limits the CPU consumption of processes launched
+<tr class="odd"><td><a href="core.html#rlimitcpu">RLimitCPU <var>number</var>|max [<var>number</var>|max]</a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Limits the CPU consumption of processes launched
by Apache children</td></tr>
-<tr><td><a href="core.html#rlimitmem">RLimitMEM <em>number</em>|max [<em>number</em>|max]</a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Limits the memory consumption of processes launched
+<tr><td><a href="core.html#rlimitmem">RLimitMEM <var>number</var>|max [<var>number</var>|max]</a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Limits the memory consumption of processes launched
by Apache children</td></tr>
-<tr class="odd"><td><a href="core.html#rlimitnproc">RLimitNPROC <em>number</em>|max [<em>number</em>|max]</a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Limits the number of processes that can be launched by
+<tr class="odd"><td><a href="core.html#rlimitnproc">RLimitNPROC <var>number</var>|max [<var>number</var>|max]</a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Limits the number of processes that can be launched by
processes launched by Apache children</td></tr>
<tr><td><a href="core.html#satisfy" id="S" name="S">Satisfy any|all</a></td><td> all </td><td>dh</td><td>C</td></tr><tr><td class="descr" colspan="4">Interaction between host-level access control and
user authentication</td></tr>
<tr><td><a href="mod_cgi.html#scriptloglength">ScriptLogLength <em>bytes</em></a></td><td> 10385760 </td><td>sv</td><td>B</td></tr><tr><td class="descr" colspan="4">Size limit of the CGI script logfile</td></tr>
<tr class="odd"><td><a href="mod_cgid.html#scriptsock">ScriptSock <em>file-path</em></a></td><td> logs/cgisock </td><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">-</td></tr>
<tr><td><a href="mpm_common.html#sendbuffersize">SendBufferSize <em>bytes</em></a></td><td /><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">TCP buffer size</td></tr>
-<tr class="odd"><td><a href="core.html#serveradmin">ServerAdmin <em>email-address</em></a></td><td /><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Email address that the server includes in error
+<tr class="odd"><td><a href="core.html#serveradmin">ServerAdmin <var>email-address</var></a></td><td /><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Email address that the server includes in error
messages sent to the client</td></tr>
-<tr><td><a href="core.html#serveralias">ServerAlias <em>hostname</em> [<em>hostname</em>] ...</a></td><td /><td>v</td><td>C</td></tr><tr><td class="descr" colspan="4">Alternate names for a host used when matching requests
+<tr><td><a href="core.html#serveralias">ServerAlias <var>hostname</var> [<var>hostname</var>] ...</a></td><td /><td>v</td><td>C</td></tr><tr><td class="descr" colspan="4">Alternate names for a host used when matching requests
to name-virtual hosts</td></tr>
<tr class="odd"><td><a href="mpm_common.html#serverlimit">ServerLimit <em>number</em></a></td><td> 256 (prefork), Serv +</td><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Upper limit on configurable number of processes</td></tr>
-<tr><td><a href="core.html#servername">ServerName <em>fully-qualified-domain-name[:port]</em></a></td><td /><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Hostname and port that the server uses to identify
+<tr><td><a href="core.html#servername">ServerName <var>fully-qualified-domain-name</var>[:<var>port</var>]</a></td><td /><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Hostname and port that the server uses to identify
itself</td></tr>
-<tr class="odd"><td><a href="core.html#serverpath">ServerPath <em>URL-path</em></a></td><td /><td>v</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Legacy URL pathname for a name-virtual host that
+<tr class="odd"><td><a href="core.html#serverpath">ServerPath <var>URL-path</var></a></td><td /><td>v</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Legacy URL pathname for a name-virtual host that
is accessed by an incompatible browser</td></tr>
-<tr><td><a href="core.html#serverroot">ServerRoot <em>directory-path</em></a></td><td> /usr/local/apache </td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Base directory for the server installation</td></tr>
+<tr><td><a href="core.html#serverroot">ServerRoot <var>directory-path</var></a></td><td> /usr/local/apache </td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Base directory for the server installation</td></tr>
<tr class="odd"><td><a href="core.html#serversignature">ServerSignature On|Off|EMail</a></td><td> Off </td><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Configures the footer on server-generated documents</td></tr>
<tr><td><a href="core.html#servertokens">ServerTokens Major|Minor|Minimal|ProductOnly|OS|Full</a></td><td> Full </td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Configures the Server HTTP response header</td></tr>
<tr class="odd"><td><a href="mod_env.html#setenv">SetEnv <em>env-variable value</em></a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets environment variables</td></tr>
[!]env-variable</em>[=<em>value</em>]
[[!]<em>env-variable</em>[=<em>value</em>]] ...</a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets environment variables based on attributes of the request
without respect to case</td></tr>
-<tr><td><a href="core.html#sethandler">SetHandler <em>handler-name</em></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Forces all matching files to be processed by a
+<tr><td><a href="core.html#sethandler">SetHandler <var>handler-name</var></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Forces all matching files to be processed by a
handler</td></tr>
-<tr class="odd"><td><a href="core.html#setinputfilter">SetInputFilter <em>filter</em>[<em>;filter</em>...]</a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the filters that will process client requests and POST
+<tr class="odd"><td><a href="core.html#setinputfilter">SetInputFilter <var>filter</var>[;<var>filter</var>...]</a></td><td /><td>svdh</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the filters that will process client requests and POST
input</td></tr>
-<tr><td><a href="core.html#setoutputfilter">SetOutputFilter <em>filter</em>[<em>;filter</em>...]</a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Sets the filters that will process responses from the
+<tr><td><a href="core.html#setoutputfilter">SetOutputFilter <var>filter</var>[;<var>filter</var>...]</a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Sets the filters that will process responses from the
server</td></tr>
<tr class="odd"><td><a href="mod_include.html#ssiendtag">SSIEndTag <em>tag</em></a></td><td> "-->" </td><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">String that ends an include element</td></tr>
<tr><td><a href="mod_include.html#ssierrormsg">SSIErrorMsg <em>message</em></a></td><td>
per child process</td></tr>
<tr class="odd"><td><a href="mpm_common.html#threadsperchild">ThreadsPerChild <em>number</em></a></td><td /><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Number of threads created by each child process</td></tr>
<tr><td><a href="mpm_netware.html#threadstacksize">ThreadStackSize <em>number</em></a></td><td> 65536 </td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">-</td></tr>
-<tr class="odd"><td><a href="core.html#timeout">TimeOut <em>number</em></a></td><td> 300 </td><td>s</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Amount of time the server will wait for
+<tr class="odd"><td><a href="core.html#timeout">TimeOut <var>number</var></a></td><td> 300 </td><td>s</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Amount of time the server will wait for
certain events before failing a request</td></tr>
<tr><td><a href="mod_log_config.html#transferlog">TransferLog <em>file</em>|<em>pipe</em></a></td><td /><td>s</td><td>B</td></tr><tr><td class="descr" colspan="4">Specifly location of a log file</td></tr>
<tr class="odd"><td><a href="mod_mime.html#typesconfig">TypesConfig <em>file-path</em></a></td><td> conf/mime.types </td><td>s</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The location of the mime.types file</td></tr>
<tr class="odd"><td><a href="mod_vhost_alias.html#virtualdocumentrootip">VirtualDocumentRootIP <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Dynamically configure the location of the document root
for a given virtual host</td></tr>
<tr><td><a href="core.html#virtualhost"><VirtualHost
- <em>addr</em>[:<em>port</em>] [<em>addr</em>[:<em>port</em>]]
+ <var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
...> ... </VirtualHost></a></td><td /><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Contains directives that apply only to a specific
hostname or IP address</td></tr>
<tr class="odd"><td><a href="mod_vhost_alias.html#virtualscriptalias">VirtualScriptAlias <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Dynamically configure the location of the CGI directory for
projects / apache / commitdiff