<p>The string provided for the <code>AuthRealm</code> is what will
appear in the password dialog provided by most browsers.</p>
</usage><p><strong>See also </strong></p><ul><li><a href="../howto/auth.html">Authentication, Authorization, and
- Access Control</a></li></ul><hr/><h2><a name="AuthType">AuthType</a> <a name="authtype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Selects the type of user authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthType Basic|Digest</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
+ Access Control</a></li></ul><hr/><h2><a name="AuthType">AuthType</a> <a name="authtype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Selects the type of user authentication</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>AuthType Basic|Digest</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#
Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
<p>This directive selects the type of user authentication for a
directory. Only <code>Basic</code> and <code>Digest</code> are
currently implemented.
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<code>DefaultType image/gif</code>
</code></td></tr></table></blockquote>
- would be appropriate for a directory which contained many gif
- images with filenames missing the .gif extension.
+ <p>would be appropriate for a directory which contained many gif
+ images with filenames missing the .gif extension.</p>
<p>Note that unlike <a href="#forcetype" class="directive"><code class="directive">ForceType</code></a>, this directive is only
provides the default mime-type. All other mime-type definitions,
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Directory ~ "^/www/.*/[0-9]{3}">
</code></td></tr></table></blockquote>
- would match directories in /www/ that consisted of three
- numbers.
+ <p>would match directories in /www/ that consisted of three
+ numbers.</p>
<p>If multiple (non-regular expression) directory sections
match the directory (or its parents) containing a document,
<code>/home/abc/public_html/abc</code> and be applied.</p>
<p><strong>Note that the default Apache access for
- <Directory /> is <samp>Allow from All</samp>. This means
+ <Directory /> is <code>Allow from All</code>. This means
that Apache will serve any file mapped from an URL. It is
recommended that you change this with a block such
as</strong></p>
FileETag directive allows you to choose which of these -- if any
-- should be used. The recognized keywords are:
</p>
- <dl compact="compact">
- <dt><b>INode</b></dt>
+ <dl>
+ <dt><strong>INode</strong></dt>
<dd>The file's i-node number will be included in the calculation</dd>
- <dt><b>MTime</b></dt>
+ <dt><strong>MTime</strong></dt>
<dd>The date and time the file was last modified will be included</dd>
- <dt><b>Size</b></dt>
+ <dt><strong>Size</strong></dt>
<dd>The number of bytes in the file will be included</dd>
- <dt><b>All</b></dt>
+ <dt><strong>All</strong></dt>
<dd>All available fields will be used (equivalent to
'<code>FileETag INode MTime Size</code>')</dd>
- <dt><b>None</b></dt>
+ <dt><strong>None</strong></dt>
<dd>If a document is file-based, no ETag field will be included in the
response</dd>
</dl>
<table>
<tr>
- <th align="LEFT"><strong>Level</strong> </th>
+ <th><strong>Level</strong> </th>
- <th align="LEFT"><strong>Description</strong> </th>
+ <th><strong>Description</strong> </th>
</tr>
<tr>
<th>
</th>
- <th align="LEFT"><strong>Example</strong> </th>
+ <th><strong>Example</strong> </th>
</tr>
<tr>
mod_info output, ...). The reason why you would want to enable
such a footer line is that in a chain of proxies, the user often
has no possibility to tell which of the chained servers actually
- produced a returned error message.<br> The <samp>Off</samp>
+ produced a returned error message.<br> The <code>Off</code>
setting, which is the default, suppresses the error line (and is
therefore compatible with the behavior of Apache-1.2 and
- below). The <samp>On</samp> setting simply adds a line with the
+ below). The <code>On</code> setting simply adds a line with the
server version number and <a href="#servername" class="directive"><code class="directive">ServerName</code></a> of the serving virtual host,
- and the <samp>EMail</samp> setting additionally creates a
+ and the <code>EMail</code> setting additionally creates a
"mailto:" reference to the <a href="#serveradmin" class="directive"><code class="directive">ServerAdmin</code></a> of the referenced
document.</p>
</usage><hr/><h2><a name="ServerTokens">ServerTokens</a> <a name="servertokens">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures the Server HTTP response header</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ServerTokens Minimal|ProductOnly|OS|Full</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerTokens Full</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td></tr></table></td></tr></table><usage>
- <p>This directive controls whether <samp>Server</samp> response
+ <p>This directive controls whether <code>Server</code> response
header field which is sent back to clients includes a
description of the generic OS-type of the server as well as
information about compiled-in modules.</p>
<dl>
<dt><code>ServerTokens Prod[uctOnly]</code></dt>
- <dd>Server sends (<em>e.g.</em>): <samp>Server:
- Apache</samp></dd>
+ <dd>Server sends (<em>e.g.</em>): <code>Server:
+ Apache</code></dd>
<dt><code>ServerTokens Min[imal]</code></dt>
- <dd>Server sends (<em>e.g.</em>): <samp>Server:
- Apache/1.3.0</samp></dd>
+ <dd>Server sends (<em>e.g.</em>): <code>Server:
+ Apache/1.3.0</code></dd>
<dt><code>ServerTokens OS</code></dt>
- <dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0
- (Unix)</samp></dd>
+ <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/1.3.0
+ (Unix)</code></dd>
<dt><code>ServerTokens Full</code> (or not specified)</dt>
- <dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0
- (Unix) PHP/3.0 MyMod/1.2</samp></dd>
+ <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/1.3.0
+ (Unix) PHP/3.0 MyMod/1.2</code></dd>
</dl>
<p>This setting applies to the entire server, and cannot be
<li>A fully qualified domain name for the IP address of the
virtual host.</li>
</ul>
- Example:
+
-<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code><VirtualHost 10.1.2.3><br>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></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>
same header repeatedly toggles between ascending and descending
order. These column header links are suppressed with
<a href="autoindex.html#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> directive's
- <samp>SuppressColumnSorting</samp> option.</p>
+ <code>SuppressColumnSorting</code> option.</p>
<p>Note that when the display is sorted by "Size", it's the
<em>actual</em> size of the files that's used, not the
resource.</p>
<ul>
- <li><samp>C=N</samp> sorts the directory by file name</li>
+ <li><code>C=N</code> sorts the directory by file name</li>
- <li><samp>C=M</samp> sorts the directory by last-modified
+ <li><code>C=M</code> sorts the directory by last-modified
date, then file name</li>
- <li><samp>C=S</samp> sorts the directory by size, then file
+ <li><code>C=S</code> sorts the directory by size, then file
name</li>
- <li><samp>C=D</samp> sorts the directory by description, then
+ <li><code>C=D</code> sorts the directory by description, then
file name<br>
</li>
- <li><samp>O=A</samp> sorts the listing in Ascending
+ <li><code>O=A</code> sorts the listing in Ascending
Order</li>
- <li><samp>O=D</samp> sorts the listing in Descending
+ <li><code>O=D</code> sorts the listing in Descending
Order<br>
</li>
- <li><samp>F=0</samp> formats the listing as a simple list
+ <li><code>F=0</code> formats the listing as a simple list
(not FancyIndexed)</li>
- <li><samp>F=1</samp> formats the listing as a FancyIndexed
+ <li><code>F=1</code> formats the listing as a FancyIndexed
list</li>
- <li><samp>F=2</samp> formats the listing as an HTMLTable
+ <li><code>F=2</code> formats the listing as an HTMLTable
FancyIndexed list<br>
</li>
- <li><samp>V=0</samp> disables version sorting</li>
+ <li><code>V=0</code> disables version sorting</li>
- <li><samp>V=1</samp> enables version sorting<br>
+ <li><code>V=1</code> enables version sorting<br>
</li>
- <li><samp>P=<em>pattern</em></samp> lists only files matching
+ <li><code>P=<em>pattern</em></code> lists only files matching
the given <em>pattern</em></li>
</ul>
of</p>
<dl>
- <dt><a id="indexoptions:descriptionwidth" name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
+ <dt><a name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
| *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
<dd>The <code>DescriptionWidth</code> keyword allows you to
width necessary to accommodate the longest description
string.</dd>
- <dd><
b>See the section on <a href="#adddescription" class="directive"><code class="directive">AddDescription</code></a> for dangers
- inherent in truncating descriptions.</b></dd>
+ <dd><
strong>See the section on <a href="#adddescription" class="directive"><code class="directive">AddDescription</code></a> for dangers
+ inherent in truncating descriptions.</strong></dd>
- <dt><a id="indexoptions:fancyindexing" name="indexoptions:fancyindexing">FancyIndexing</a></dt>
+ <dt><a name="indexoptions:fancyindexing">FancyIndexing</a></dt>
<dd>
This turns on fancy indexing of directories.</dd>
- <dt><a id="indexoptions:foldersfirst" name="indexoptions:foldersfirst">FoldersFirst (<i>Apache
- 1.3.10 or 2.0.23 and later</i>)</a></dt>
+ <dt><a name="indexoptions:foldersfirst">FoldersFirst (<em>Apache
+ 1.3.10 or 2.0.23 and later</em>)</a></dt>
<dd>If this option is enabled, subdirectory listings will
- <i>always</i> appear first, followed by normal files in the
+ <em>always</em> appear first, followed by normal files in the
directory. The listing is basically broken into two
components, the files and the subdirectories, and each is
sorted separately and then displayed subdirectories-first.
<code>FoldersFirst</code> is enabled, subdirectory
<code>Zed</code> will be listed before subdirectory
<code>Beta</code>, which will be listed before normal files
- <code>Gamma</code> and <code>Alpha</code>. <b>This option
+ <code>Gamma</code> and <code>Alpha</code>. <strong>This option
only has an effect if <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
- is also enabled.</b></dd>
+ is also enabled.</strong></dd>
- <dt><a id="indexoptions:htmltable" name="indexoptions:htmltable">HTMLTable</a> <i>(Experimental,
- Apache 2.0.23 and later)</i></dt>
+ <dt><a name="indexoptions:htmltable">HTMLTable</a> <em>(Experimental,
+ Apache 2.0.23 and later)</em></dt>
<dd>
This experimental option with FancyIndexing constructs a
left-to-right and right-to-left reading order, as can happen
on WinNT or other utf-8 enabled platforms.</dd>
- <dt><a id="indexoptions:iconsarelinks" name="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
+ <dt><a name="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
<dd>
This makes the icons part of the anchor for the filename, for
fancy indexing.</dd>
- <dt><a id="indexoptions:iconheight" name="indexoptions:iconheight">IconHeight[=pixels]
+ <dt><a name="indexoptions:iconheight">IconHeight[=pixels]
(<em>Apache 1.3 and later</em>)</a></dt>
<dd>
the standard height of the icons supplied with the Apache
software.</dd>
- <dt><a id="indexoptions:iconwidth" name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
+ <dt><a name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
1.3 and later</em>)</a></dt>
<dd>
the standard width of the icons supplied with the Apache
software.</dd>
- <dt><a id="indexoptions:ignoreclient" name="indexoptions:ignoreclient">IgnoreClient</a></dt>
+ <dt><a name="indexoptions:ignoreclient">IgnoreClient</a></dt>
<dd>
This option causes mod_autoindex to ignore all query
variables from the client, including sort order (implies
<code><a href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code>.)</dd>
- <dt><a id="indexoptions:namewidth" name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
+ <dt><a name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
(<em>Apache 1.3.2 and later</em>)</a></dt>
<dd>The NameWidth keyword allows you to specify the width of
<dd><code>NameWidth=*</code> grows the column to the
necessary width.</dd>
- <dt><a id="indexoptions:scanhtmltitles" name="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
+ <dt><a name="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
<dd>
This enables the extraction of the title from HTML documents
httpd will read the document for the value of the TITLE tag.
This is CPU and disk intensive.</dd>
- <dt><a id="indexoptions:suppresscolumnsorting" name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
+ <dt><a name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
(<em>Apache 1.3 and later</em>)</dt>
<dd>
string.</strong> That behavior is now controlled by <a href="#indexoptions:ignoreclient">IndexOptions
IgnoreClient</a> in Apache 2.0.23.</dd>
- <dt><a id="indexoptions:suppressdescription" name="indexoptions:suppressdescription">SuppressDescription</a></dt>
+ <dt><a name="indexoptions:suppressdescription">SuppressDescription</a></dt>
<dd>
This will suppress the file description in fancy indexing
index option to limit the size of the description
column.</dd>
- <dt><a id="indexoptions:suppresshtmlpreamble" name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
+ <dt><a name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
(<em>Apache 1.3 and later</em>)</dt>
<dd>
HTML instructions in this case. If there is no header file, the
preamble is generated as usual.</dd>
- <dt><a id="indexoptions:suppressicon" name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
+ <dt><a name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
2.0.23 and later</em>)</dt>
<dd>
by the final specification prohibits IMG and HR tags from the
PRE block (used to format FancyIndexed listings.)</dd>
- <dt><a id="indexoptions:suppresslastmodified" name="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
+ <dt><a name="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
<dd>
This will suppress the display of the last modification date,
in fancy indexing listings.</dd>
- <dt><a id="indexoptions:suppressrules" name="indexoptions:suppressrules">SuppressRules</a>
+ <dt><a name="indexoptions:suppressrules">SuppressRules</a>
(<em>Apache 2.0.23 and later</em>)</dt>
<dd>
by the final specification prohibits IMG and HR tags from the
PRE block (used to format FancyIndexed listings.)</dd>
- <dt><a id="indexoptions:suppresssize" name="indexoptions:suppresssize">SuppressSize</a></dt>
+ <dt><a name="indexoptions:suppresssize">SuppressSize</a></dt>
<dd>
This will suppress the file size in fancy indexing
listings.</dd>
- <dt><a id="indexoptions:trackmodified" name="indexoptions:trackmodified">TrackModified (<em>Apache
+ <dt><a name="indexoptions:trackmodified">TrackModified (<em>Apache
1.3.15 or 2.0.23 and later</em>)</a></dt>
<dd>
Last-Modified header on all Unix platforms.</strong> If this
is a concern, leave this option disabled.</dd>
- <dt><a id="indexoptions:versionsort" name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
+ <dt><a name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
and later</em>)</a></dt>
<dd>
</dd>
<dd>
- <h3>Incremental IndexOptions</h3>
+ <strong>Incremental IndexOptions</strong>
</dd>
<dd>
as a valid character set name by the character set support in
APR. Generally, this means that it must be supported by
iconv.</p>
- Example:
-<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
<Directory "/export/home/trawick/apacheinst/htdocs/convert"><br>
CharsetSourceEnc UTF-16BE<br>
CharsetDefault ISO8859-1<br>
as a valid character set name by the character set support in
APR. Generally, this means that it must be supported by
iconv.</p>
- Example:
-<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>example</strong></p><code>
<Directory "/export/home/trawick/apacheinst/htdocs/convert"><br>
CharsetSourceEnc UTF-16BE<br>
CharsetDefault ISO8859-1<br>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Apache module mod_example</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
-
- <blockquote>
- <strong>Warning:</strong> This document has not been updated
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_example - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_example</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Illustrates the Apache module API</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>example_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+<blockquote><table><tr><td bgcolor="#ffe5f5">
+ This document has not been updated
to take into account changes made in the 2.0 version of the
Apache HTTP Server. Some of the information may still be
relevant, but please use it with care.
- </blockquote>
-
- <h1 align="CENTER">Module mod_example</h1>
-
- <p>This module illustrates many of the aspects of the <a
- href="../misc/API.html" rel="Help">Apache 1.2 API</a> and, when
- used, demonstrates the manner in which module callbacks are
- triggered by the server.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_example.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- example_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.2 and later.</p>
-
- <h2>Summary</h2>
+</td></tr></table></blockquote>
<p>The files in the <code>src/modules/example directory</code>
under the Apache distribution directory tree are provided as an
location, and then browse to that location, you will see a
display of some of the tracing the example module did as the
various callbacks were made.</p>
-
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#example">Example</a></li>
- </ul>
- <br />
- <br />
-
-
- <h2>Compiling the example module</h2>
+</summary><h2>Directives</h2><ul><li><a href="#example">Example</a></li></ul><h2>Compiling the example module</h2>
<p>To include the example module in your server, follow the
steps below:</p>
Uncomment the "AddModule modules/example/mod_example" line
near the bottom of the <code>src/Configuration</code> file.
If there isn't one, add it; it should look like this:
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddModule modules/example/mod_example.o
-
-</pre>
+</code></td></tr></table></blockquote>
</li>
<li>Run the <code>src/Configure</code> script
- ("<samp>cd src; ./Configure</samp>"). This will
+ ("<code>cd src; ./Configure</code>"). This will
build the Makefile for the server itself, and update the
<code>src/modules/Makefile</code> for any additional modules
you have requested from beneath that subdirectory.</li>
- <li>Make the server (run "<samp>make</samp>" in the
+ <li>Make the server (run "<code>make</code>" in the
<code>src</code> directory).</li>
</ol>
<p>To add another module of your own:</p>
<ol type="A">
- <li><samp>mkdir src/modules/<em>mymodule</em></samp></li>
+ <li><code>mkdir src/modules/<em>mymodule</em></code></li>
- <li><samp>cp src/modules/example/*
- src/modules/<em>mymodule</em></samp></li>
+ <li><code>cp src/modules/example/*
+ src/modules/<em>mymodule</em></code></li>
<li>Modify the files in the new directory.</li>
<li>Follow steps [1] through [3] above, with appropriate
changes.</li>
</ol>
-
- <h2>Using the <samp>mod_example</samp> Module</h2>
+<h2>Using the <code>mod_example</code> Module</h2>
<p>To activate the example module, include a block similar to
- the following in your <samp>srm.conf</samp> file:</p>
-<pre>
- <Location /example-info>
- SetHandler example-handler
+ the following in your <code>srm.conf</code> file:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <Location /example-info><br>
+ SetHandler example-handler<br>
</Location>
-
-</pre>
+</code></td></tr></table></blockquote>
- <p>As an alternative, you can put the following into a <a
- href="core.html#accessfilename"><samp>.htaccess</samp></a> file
- and then request the file "test.example" from that
- location:</p>
-<pre>
+ <p>As an alternative, you can put the following into a <a href="core.html#accessfilename"><code>.htaccess</code></a> file
+ and then request the file "test.example" from that location:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
AddHandler example-handler .example
-
-</pre>
+</code></td></tr></table></blockquote>
<p>After reloading/restarting your server, you should be able
to browse to this location and see the brief display mentioned
earlier.</p>
- <hr />
-
- <h2><a id="example" name="example">Example directive</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Example<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> None<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Options<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_example<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- <samp>Example</samp> is only available in Apache 1.2 and
- later.</p>
-
- <p>The <samp>Example</samp> directive just sets a demonstration
+<hr/><h2><a name="Example">Example</a> <a name="example">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Demonstration directive to illustrate the Apache module
+API</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Example</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_example</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">Example</code> directive just sets a demonstration
flag which the example module's content handler displays. It
takes no arguments. If you browse to an URL to which the
example content-handler applies, you will get a display of the
routines within the module and how and in what order they were
called to service the document request. The effect of this
- directive one can observe under the point "<samp>Example
- directive declared here: YES/NO</samp>".</p>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
-
+ directive one can observe under the point "<code>Example
+ directive declared here: YES/NO</code>".</p>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Apache module mod_ext_filter</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
-
- <h1 align="CENTER">Module mod_ext_filter</h1>
-
- <p>This module provides the ability to pass the response body
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_ext_filter - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_ext_filter</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Pass the response body
through an external program before delivery to the
- client.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_ext_filter.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- ext_filter_module</p>
-
- <h2>Summary</h2>
-
+ client</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>ext_filter_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This is an <strong>experimental</strong> module and should
- be used with care. Test your <code>mod_ext_filter</code>
+ be used with care. Test your <code><a href="mod_ext_filter.html">mod_ext_filter</a></code>
configuration carefully to ensure that it performs the desired
function. You may wish to review <a href="../filter.html">
this information</a> for background on the Apache filtering
model.</p>
- <p><code>mod_ext_filter</code> presents a simple and familiar
+ <p><code><a href="mod_ext_filter.html">mod_ext_filter</a></code> presents a simple and familiar
programming model for filters. With this module, a program
which reads from stdin and writes to stdout (i.e., a Unix-style
filter command) can be a filter for Apache. This filtering
<p>Even when the performance characteristics are not suitable
for production use, <code>mod_ext_filter</code> can be used as
a prototype environment for filters.</p>
+</summary><h2>Directives</h2><ul><li><a href="#extfilterdefine">ExtFilterDefine</a></li><li><a href="#extfilteroptions">ExtFilterOptions</a></li></ul><h2>Examples</h2>
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#extfilterdefine">ExtFilterDefine</a></li>
-
- <li><a href="#extfilteroptions">ExtFilterOptions</a></li>
- </ul>
-
- <h2>Examples</h2>
-
- <h3>Generating HTML from some other type of response</h3>
+<h3>Generating HTML from some other type of response</h3>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
# mod_ext_filter directive to define a filter to HTML-ize text/c files
# using the external program /usr/bin/enscript, with the type of the
ExtFilterOptions DebugLevel=1
</Directory>
-
</pre>
+</code></td></tr></table></blockquote>
+
- <h3>Implementing a content encoding filter</h3>
+<h3>Implementing a content encoding filter</h3>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
# mod_ext_filter directive to define the external filter
ExtFilterDefine gzip mode=output cmd=/bin/gzip
Header set Content-Encoding gzip
</Location>
-
</pre>
+</code></td></tr></table></blockquote>
- <p>Note: this gzip example is just for the purposes of
- illustration. Please refer to <a href="mod_deflate.html">
- mod_deflate</a> for a practical implementation.</p>
+ <p>Note: this gzip example is just for the purposes of illustration.
+ Please refer to <code><a href="mod_deflate.html">mod_deflate</a></code> for a practical
+ implementation.</p>
- <h3>Slowing down the server</h3>
+
+<h3>Slowing down the server</h3>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<pre>
# mod_ext_filter directive to define a filter which runs everything
# through cat; cat doesn't modify anything; it just introduces extra
SetOutputFilter slowdown slowdown slowdown
</Location>
-
</pre>
- <hr />
-
- <h2><a id="extfilterdefine"
- name="extfilterdefine">ExtFilterDefine</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ExtFilterDefine
- <em>filtername</em> <em>parameters</em><br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>None</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> none<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_ext_filter</p>
-
- <p>The <code>ExtFilterDefine</code> directive defines the
+</code></td></tr></table></blockquote>
+
+
+<hr/><h2><a name="ExtFilterDefine">ExtFilterDefine</a> <a name="extfilterdefine">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ExtFilterDefine <em>filtername</em> <em>parameters</em></syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_ext_filter</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ExtFilterDefine</code> directive defines the
characteristics of an external filter, including the program to
run and its arguments.</p>
<dl>
<dt>cmd=<em>cmdline</em></dt>
- <dd>The <samp>cmd=</samp> keyword allows you to specify the
+ <dd>The <code>cmd=</code> keyword allows you to specify the
external command to run. If there are arguments after the
program name, the command line should be surrounded in
quotation marks.</dd>
<dt>PreservesContentLength</dt>
- <dd>The <samp>PreservesContentLength</samp> keyword specifies
+ <dd>The <code>PreservesContentLength</code> keyword specifies
that the filter preserves the content length. This is not the
default, as most filters change the content length. In the
event that the filter doesn't modify the length, this keyword
should be specified.</dd>
</dl>
- <hr />
-
- <h2><a id="extfilteroptions"
- name="extfilteroptions">ExtFilterOptions</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ExtFilterOptions
- <em>option</em> [<em>option</em>] ...<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>DebugLevel=0</em>
- <em>NoLogStderr</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> directory<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> none<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_ext_filter</p>
-
- <p>The <code>ExtFilterOptions</code> directive specifies
+</usage><hr/><h2><a name="ExtFilterOptions">ExtFilterOptions</a> <a name="extfilteroptions">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ExtFilterOptions
+ <em>option</em> [<em>option</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ExtFilterOptions DebugLevel=0 NoLogStderr</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_ext_filter</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ExtFilterOptions</code> directive specifies
special processing options for <code>mod_ext_filter</code>.
<em>Option</em> can be one of</p>
<dt>DebugLevel=<em>n</em></dt>
<dd>
- The <samp>DebugLevel</samp> keyword allows you to specify
+ The <code>DebugLevel</code> keyword allows you to specify
the level of debug messages generated by
<code>mod_ext_filter</code>. By default, no debug messages
are generated. This is equivalent to
- <samp>DebugLevel=0</samp>. With higher numbers, more debug
+ <code>DebugLevel=0</code>. With higher numbers, more debug
messages are generated, and server performance will be
degraded. The actual meanings of the numeric values are
described with the definitions of the DBGLVL_ constants
<dt>LogStderr | NoLogStderr</dt>
- <dd>The <samp>LogStderr</samp> keyword specifies that
+ <dd>The <code>LogStderr</code> keyword specifies that
messages written to standard error by the external filter
program will be saved in the Apache error log.
- <samp>NoLogStderr</samp> disables this feature.</dd>
+ <code>NoLogStderr</code> disables this feature.</dd>
</dl>
- <br />
- <br />
- Example:
-<pre>
- ExtFilterOptions LogStderr DebugLevel=0
-
-</pre>
- Messages written to the filter's standard error will be stored
- in the Apache error log. No debug messages will be generated by
- <code>mod_ext_filter</code>.
- <p><!--#include virtual="footer.html" -->
- </p>
- </body>
-</html>
+ <p>Example:</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ ExtFilterOptions LogStderr DebugLevel=0
+</code></td></tr></table></blockquote>
+ <p>Messages written to the filter's standard error will be stored
+ in the Apache error log. No debug messages will be generated by
+ <code><a href="mod_ext_filter.html">mod_ext_filter</a></code>. </p>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Apache module mod_file_cache</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
-
- <h1 align="CENTER">Module mod_file_cache</h1>
-
- <p><strong>This module should be used with care. You can easily
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_file_cache - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_file_cache</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Caches a static list of files in memory</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>file_cache_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+
+<blockquote><table><tr><td bgcolor="#ffe5f5">
+This module should be used with care. You can easily
create a broken site using mod_file_cache, so read this
- document carefully.</strong></p>
+ document carefully.
+</td></tr></table></blockquote>
<p><em>Caching</em> frequently requested files that change very
infrequently is a technique for reducing server load.
(specifically, the file I/O) for serving the file when the
server is started rather than during each request.</p>
- <p><code>mod_file_cache</code> is not compiled into the server
- by default. To use <code>mod_file_cache</code> you have to
- enable the following line in the server build
- <code>Configuration</code> file:</p>
-<pre>
- AddModule modules/experimental/mod_file_cache.o
-
-</pre>
- <br />
- <br />
-
-
<p>Notice: You cannot use this for speeding up CGI programs or
other files which are served by special content handlers. It
can only be used for regular files which are usually served by
<p>This module is an extension of and borrows heavily from the
mod_mmap_static module in Apache 1.3.</p>
-
- <h2>Summary</h2>
-
- <p><code>mod_file_cache</code> caches a list of statically
- configured files via <code>MMapFile</code> or
- <code>CacheFile</code> directives in the main server
- configuration.</p>
-
- <p>Not all platforms support both directives. For example,
- Apache on Windows does not currently support the MMapStatic
- directive, while other platforms, like AIX, support both. You
- will receive an error message in the server error log if you
- attempt to use an unsupported directive. If given an
- unsupported directive, the server will start but the file will
- not be cached. On platforms that support both directives, you
- should experiment with both to see which works best for
- you.</p>
-
- <h3><code>MmapFile</code> Directive</h3>
-
- <p>The <code>MmapFile</code> directive of
- <code>mod_file_cache</code> maps a list of statically
- configured files into memory through the system call
- <code>mmap()</code>. This system call is available on most
- modern Unix derivates, but not on all. There are sometimes
- system-specific limits on the size and number of files that can
- be mmap()d, experimentation is probably the easiest way to find
+</summary><h2>Directives</h2><ul><li><a href="#cachefile">CacheFile</a></li><li><a href="#mmapfile">MMapFile</a></li></ul><h2>Using mod_file_cache</h2>
+
+ <p><code><a href="mod_file_cache.html">mod_file_cache</a></code> caches a list of statically
+ configured files via <a href="#mmapfile" class="directive"><code class="directive">MMapFile</code></a> or <a href="#cachefile" class="directive"><code class="directive">CacheFile</code></a> directives in the
+ main server configuration.</p>
+
+ <p>Not all platforms support both directives. For example, Apache
+ on Windows does not currently support the <a href="#mmapstatic" class="directive"><code class="directive">MMapStatic</code></a> directive, while
+ other platforms, like AIX, support both. You will receive an error
+ message in the server error log if you attempt to use an
+ unsupported directive. If given an unsupported directive, the
+ server will start but the file will not be cached. On platforms
+ that support both directives, you should experiment with both to
+ see which works best for you.</p>
+
+<h3>MmapFile Directive</h3>
+
+ <p>The <a href="#mmapfile" class="directive"><code class="directive">MmapFile</code></a>
+ directive of <code><a href="mod_file_cache.html">mod_file_cache</a></code> maps a list of
+ statically configured files into memory through the system call
+ <code>mmap()</code>. This system call is available on most modern
+ Unix derivates, but not on all. There are sometimes
+ system-specific limits on the size and number of files that can be
+ mmap()d, experimentation is probably the easiest way to find
out.</p>
<p>This mmap()ing is done once at server start or restart,
only. So whenever one of the mapped files changes on the
- filesystem you <em>have</em> to restart the server (see the <a
- href="../stopping.html">Stopping and Restarting</a>
+ filesystem you <em>have</em> to restart the server (see the <a href="../stopping.html">Stopping and Restarting</a>
documentation). To reiterate that point: if the files are
modified <em>in place</em> without restarting the server you
may end up serving requests that are completely bogus. You
an extra <code>stat()</code> every time which is a waste and
against the intent of I/O reduction.</p>
- <h3><code>CacheFile</code> Directive</h3>
- <p>The <code>CacheFile</code> directive of
- <code>mod_file_cache</code> opens an active <em>handle</em> or
- <em>file descriptor</em> to the file (or files) listed in the
- configuration directive and places these open file handles in
- the cache. When the file is requested, the server retrieves the
- handle from the cache and passes it to the sendfile() (or
- TransmitFile() on Windows), socket API.</p>
+<h3>CacheFile Directive</h3>
+
+ <p>The <a href="#cachefile" class="directive"><code class="directive">CacheFile</code></a>
+ directive of <code><a href="mod_file_cache.html">mod_file_cache</a></code> opens an active
+ <em>handle</em> or <em>file descriptor</em> to the file (or files)
+ listed in the configuration directive and places these open file
+ handles in the cache. When the file is requested, the server
+ retrieves the handle from the cache and passes it to the
+ sendfile() (or TransmitFile() on Windows), socket API.</p>
<p>Insert more details about sendfile API...</p>
copy in place. Most tools such as <code>rdist</code> and
<code>mv</code> do this.</p>
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#mmapfile">MMapFile</a></li>
-
- <li><a href="#cachefile">CacheFile</a></li>
- </ul>
- <hr />
-
- <h2><a id="mmapfile" name="mmapfile">MMapFile</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> MMapFile
- <em>filename</em> [<em>filename</em>] ...<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>None</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server-config<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> <em>Not
- applicable</em><br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_file_cache<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Only in Apache
- 1.3 (via mod_mmap_statis) or later.</p>
-
- <p>The <code>MMapFile</code> directive maps one or more files
- (given as whitespace separated arguments) into memory at server
- startup time. They are automatically unmapped on a server
- shutdown. When the files have changed on the filesystem at
- least a HUP or USR1 signal should be send to the server to
- re-mmap them.</p>
- <p>Be careful with the <em>filename</em> arguments: They have
+<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p> Don't bother asking for a for a
+ directive which recursively caches all the files in a
+ directory. Try this instead... See the
+ <a href="core.html#include" class="directive"><code class="directive">Include</code></a> directive, and consider
+ this command:
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ find /www/htdocs -type f -print \ <br>
+ | sed -e 's/.*/mmapfile &/' > /www/conf/mmap.conf
+</code></td></tr></table></blockquote>
+</td></tr></table></blockquote>
+
+<hr/><h2><a name="CacheFile">CacheFile</a> <a name="cachefile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CacheFile
+ <em>file-path</em> [<em>file-path</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_file_cache</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">CacheFile</code> directive opens handles to
+ one or more files (given as whitespace separated arguments) and
+ places these handles into the cache at server startup
+ time. Handles to cached files are automatically closed on a server
+ shutdown. When the files have changed on the filesystem, the
+ server should be restarted to to re-cache them.</p>
+
+ <p>Be careful with the <em>file-path</em> arguments: They have
to literally match the filesystem path Apache's URL-to-filename
translation handlers create. We cannot compare inodes or other
stuff to match paths through symbolic links <em>etc.</em>
because that again would cost extra <code>stat()</code> system
calls which is not acceptable. This module may or may not work
- with filenames rewritten by <code>mod_alias</code> or
- <code>mod_rewrite</code>.</p>
- Example:
-<pre>
- MMapFile /usr/local/apache/htdocs/index.html
-
-</pre>
- <hr />
-
- <h2><a id="cachefile" name="cachefile">CacheFile</a></h2>
-
- <p><a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> CacheFile
- <em>filename</em> [<em>filename</em>] ...<br />
- <a href="directive-dict.html#Default"
- rel="Help"><strong>Default:</strong></a> <em>None</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server-config<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> <em>Not
- applicable</em><br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Experimental<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_file_cache<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Only available
- in Apache 2.0 or later.</p>
-
- <p>The <code>CacheFile</code> directive opens handles to one or
- more files (given as whitespace separated arguments) and places
- these handles into the cache at server startup time. Handles to
- cached files are automatically closed on a server shutdown.
- When the files have changed on the filesystem, the server
- should be restarted to to re-cache them.</p>
-
- <p>Be careful with the <em>filename</em> arguments: They have
+ with filenames rewritten by <code><a href="mod_alias.html">mod_alias</a></code> or
+ <code><a href="mod_rewrite.html">mod_rewrite</a></code>.</p>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
+ CacheFile /usr/local/apache/htdocs/index.html
+</code></td></tr></table></blockquote>
+</usage><hr/><h2><a name="MMapFile">MMapFile</a> <a name="mmapfile">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>MMapFile <em>file-path</em> [<em>file-path</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Experimental</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_file_cache</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">MMapFile</code> directive maps one or more files
+ (given as whitespace separated arguments) into memory at server
+ startup time. They are automatically unmapped on a server
+ shutdown. When the files have changed on the filesystem at
+ least a HUP or USR1 signal should be send to the server to
+ re-mmap them.</p>
+
+ <p>Be careful with the <em>file-path</em> arguments: They have
to literally match the filesystem path Apache's URL-to-filename
translation handlers create. We cannot compare inodes or other
stuff to match paths through symbolic links <em>etc.</em>
because that again would cost extra <code>stat()</code> system
calls which is not acceptable. This module may or may not work
- with filenames rewritten by <code>mod_alias</code> or
- <code>mod_rewrite</code>.</p>
- Example:
-<pre>
- CacheFile /usr/local/apache/htdocs/index.html
-
-</pre>
-
- <p><strong>Note</strong>: don't bother asking for a for a
- directive which recursively caches all the files in a
- directory. Try this instead... See the <a
- href="core.html#include">Include</a> directive, and consider
- this command:</p>
-<pre>
- find /www/htdocs -type f -print \
- | sed -e 's/.*/mmapfile &/' > /www/conf/mmap.conf
-
-</pre>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
+ with filenames rewritten by <code><a href="mod_alias.html">mod_alias</a></code> or
+ <code><a href="mod_rewrite.html">mod_rewrite</a></code>.</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
+ MMapFile /usr/local/apache/htdocs/index.html
+</code></td></tr></table></blockquote>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Apache module mod_headers</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
-
- <h1 align="CENTER">Module mod_headers</h1>
-
- <p>This module provides for the customization of HTTP request
- and response headers.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_headers.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- headers_module<br />
- <a href="module-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.2 and later. RequestHeader appeared in Apache 2.0.</p>
-
- <h2>Summary</h2>
- This module provides directives to control and modify HTTP
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_headers - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_headers</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Customization of HTTP request
+ and response headers</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>headers_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>RequestHeader is available only in Apache 2.0</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+ <p>This module provides directives to control and modify HTTP
request and response headers. Headers can be merged, replaced
- or removed.
-
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#requestheader">RequestHeader</a></li>
-
- <li><a href="#header">Header</a></li>
- </ul>
-
- <h2>Order of Processing</h2>
+ or removed.</p>
+</summary><h2>Directives</h2><ul><li><a href="#header">Header</a></li><li><a href="#requestheader">RequestHeader</a></li></ul><h2>Order of Processing</h2>
<p>The directives provided by mod_header can occur almost
anywhere within the server configuration. They are valid in the
<p>Order is important. These two headers have a different
effect if reversed:</p>
- <blockquote>
- <code>RequestHeader append MirrorID "mirror 12"<br />
- RequestHeader unset MirrorID</code>
- </blockquote>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+RequestHeader append MirrorID "mirror 12"<br>
+ RequestHeader unset MirrorID
+</code></td></tr></table></blockquote>
<p>This way round, the MirrorID header is not set. If reversed,
the MirrorID header is set to "mirror 12".</p>
-
- <h2>Examples</h2>
+<h2>Example</h2>
<ol>
<li>Copy all request headers that begin with "TS" to the
- response headers:</li>
+ response headers:
- <li style="list-style: none">
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Header echo ^TS*
-</pre>
- </li>
+</code></td></tr></table></blockquote></li>
<li>Add a header, MyHeader, to the response including a
timestamp for when the request was received and how long it
took to begin serving the request. This header can be used by
the client to intuit load on the server or in isolating
- bottlenecks between the client and the server.</li>
+ bottlenecks between the client and the server.
- <li style="list-style: none">
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Header add MyHeader "%D %t"
-</pre>
- results in this header being added to the response:
-<pre>
+</code></td></tr></table></blockquote>
+ results in this header being added to the response:
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
MyHeader: D=3775428 t=991424704447256
-</pre>
+</code></td></tr></table></blockquote>
</li>
- <li>Say hello to Joe</li>
+ <li>Say hello to Joe
- <li style="list-style: none">
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Header add MyHeader "Hello Joe. It took %D microseconds for Apache to serve this request."
-</pre>
+</code></td></tr></table></blockquote>
results in this header being added to the response:
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
MyHeader: Hello Joe. It took D=3775428 microseconds for Apache to serve this request.
-</pre>
+</code></td></tr></table></blockquote>
</li>
<li>Conditionally send MyHeader on the response if and only
if header "MyRequestHeader" is present on the request. This
is useful for constructing headers in response to some client
stimulus. Note that this example requires the services of the
- mod_setenvif module.</li>
+ mod_setenvif module.
- <li style="list-style: none">
-<pre>
- SetEnvIf MyRequestHeader value HAVE_MyRequestHeader<br />
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ SetEnvIf MyRequestHeader value HAVE_MyRequestHeader<br>
Header add MyHeader "%D %t mytext" env=HAVE_MyRequestHeader
-</pre>
+</code></td></tr></table></blockquote>
If the header "MyRequestHeader: value" is present on the
HTTP request, the response will contain the following
header:
-<pre>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
MyHeader: D=3775428 t=991424704447256 mytext
-</pre>
+</code></td></tr></table></blockquote>
</li>
</ol>
- <hr />
-
- <h2><a id="requestheader"
- name="requestheader">RequestHeader</a> directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RequestHeader
- set|append|add <em>header</em> <em>value</em><br />
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> RequestHeader unset
- <em>header</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, access.conf, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> FileInfo<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_header
-
- <p>This directive can replace, merge or remove HTTP request
- headers. The header is modified just before the content handler
- is run, allowing incoming headers to be modified. The action it
- performs is determined by the first argument. This can be one
- of the following values:</p>
-
- <ul>
- <li><strong>set</strong><br />
- The request header is set, replacing any previous header
- with this name</li>
-
- <li><strong>append</strong><br />
- The request header is appended to any existing header of the
- same name. When a new value is merged onto an existing header
- it is separated from the existing header with a comma. This
- is the HTTP standard way of giving a header multiple
- values.</li>
-
- <li><strong>add</strong><br />
- The request header is added to the existing set of headers,
- even if this header already exists. This can result in two
- (or more) headers having the same name. This can lead to
- unforeseen consequences, and in general "append" should be
- used instead.</li>
-
- <li><strong>unset</strong><br />
- The request header of this name is removed, if it exists. If
- there are multiple headers of the same name, all will be
- removed.</li>
- </ul>
-
- <p>This argument is followed by a header name, which can
- include the final colon, but it is not required. Case is
- ignored. For <code>add</code>, <code>append</code> and
- <code>set</code> a value is given as the third argument. If
- this value contains spaces, it should be surrounded by double
- quotes. For unset, no value should be given.</p>
-
- <p>The <code>RequestHeader</code> directive is processed just
- before the request is run by its handler in the fixup phase.
- This should allow headers generated by the browser, or by
- Apache input filters to be overridden or modified.</p>
- <hr />
-
- <h2><a id="header" name="header">Header</a> directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Header set|append|add
- <em>header</em> <em>value</em>
- <em>[env=[!]environment-variable]</em><br />
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Header unset
- <em>header</em><br />
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> Header echo
- <em>header</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, access.conf, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> FileInfo<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Extension<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_header
-
+<hr/><h2><a name="Header">Header</a> <a name="header">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configure HTTP response headers</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Header set|append|add|unset|echo <em>header</em>
+[<em>value</em>]</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_headers</td></tr></table></td></tr></table><usage>
<p>This directive can replace, merge or remove HTTP response
headers. The header is modified just after the content handler
and output filters are run, allowing outgoing headers to be
argument. This can be one of the following values:</p>
<ul>
- <li><strong>set</strong><br />
+ <li><strong>set</strong><br>
The response header is set, replacing any previous header
with this name. The <em>value</em> may be a format
string.</li>
- <li><strong>append</strong><br />
+ <li><strong>append</strong><br>
The response header is appended to any existing header of
the same name. When a new value is merged onto an existing
header it is separated from the existing header with a comma.
This is the HTTP standard way of giving a header multiple
values.</li>
- <li><strong>add</strong><br />
+ <li><strong>add</strong><br>
The response header is added to the existing set of headers,
even if this header already exists. This can result in two
(or more) headers having the same name. This can lead to
unforeseen consequences, and in general "append" should be
used instead.</li>
- <li><strong>unset</strong><br />
+ <li><strong>unset</strong><br>
The response header of this name is removed, if it exists.
If there are multiple headers of the same name, all will be
removed.</li>
- <li><strong>echo</strong><br />
+ <li><strong>echo</strong><br>
Request headers with this name are echoed back in the
response headers. <em>header</em> may be a regular
expression.</li>
variable</a> FOOBAR.</td></tr>
</table>
- <p>When the <code>Header</code> directive is used with the
+ <p>When the <code class="directive">Header</code> directive is used with the
<code>add</code>, <code>append</code>, or <code>set</code>
argument, a fourth argument may be used to specify conditions
- under which the action will be taken. If the <a
- href="../env.html">environment variable</a> specified in the
+ under which the action will be taken. If the <a href="../env.html">environment variable</a> specified in the
<code>env=...</code> argument exists (or if the environment
variable does not exist and <code>env=!...</code> is specified)
- then the action specified by the <code>Header</code> directive
+ then the action specified by the <code class="directive">Header</code> directive
will take effect. Otherwise, the directive will have no effect
on the request.</p>
is sent to the network. These means that it is possible to set
and/or override most headers, except for those headers added by
the header filter.</p>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
+</usage><hr/><h2><a name="RequestHeader">RequestHeader</a> <a name="requestheader">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configure HTTP request headers</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>RequestHeader set|append|add|unset <em>header</em>
+[<em>value</em>]</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_headers</td></tr></table></td></tr></table><usage>
+ <p>This directive can replace, merge or remove HTTP request
+ headers. The header is modified just before the content handler
+ is run, allowing incoming headers to be modified. The action it
+ performs is determined by the first argument. This can be one
+ of the following values:</p>
+
+ <ul>
+ <li><strong>set</strong><br>
+ The request header is set, replacing any previous header
+ with this name</li>
+
+ <li><strong>append</strong><br>
+ The request header is appended to any existing header of the
+ same name. When a new value is merged onto an existing header
+ it is separated from the existing header with a comma. This
+ is the HTTP standard way of giving a header multiple
+ values.</li>
+
+ <li><strong>add</strong><br>
+ The request header is added to the existing set of headers,
+ even if this header already exists. This can result in two
+ (or more) headers having the same name. This can lead to
+ unforeseen consequences, and in general "append" should be
+ used instead.</li>
+
+ <li><strong>unset</strong><br>
+ The request header of this name is removed, if it exists. If
+ there are multiple headers of the same name, all will be
+ removed.</li>
+ </ul>
+
+ <p>This argument is followed by a header name, which can
+ include the final colon, but it is not required. Case is
+ ignored. For <code>add</code>, <code>append</code> and
+ <code>set</code> a value is given as the third argument. If
+ this value contains spaces, it should be surrounded by double
+ quotes. For unset, no value should be given.</p>
+ <p>The <code class="directive">RequestHeader</code> directive is processed
+ just before the request is run by its handler in the fixup phase.
+ This should allow headers generated by the browser, or by Apache
+ input filters to be overridden or modified.</p>
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Apache module mod_imap</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
-
- <h1 align="CENTER">Module mod_imap</h1>
-
- <p>This module provides for server-side imagemap
- processing.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a> mod_imap.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- imap_module<br />
- <a href="module-dict.html#compatibility"
- rel="Help"><strong>Compatibility:</strong></a> Available in
- Apache 1.1 and later.</p>
-
- <h2>Summary</h2>
-
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--><title>mod_imap - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_imap</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Server-side imagemap processing</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>imap_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This module processes <code>.map</code> files, thereby
replacing the functionality of the <code>imagemap</code> CGI
program. Any directory or document type configured to use the
- handler <code>imap-file</code> (using either <code><a
- href="mod_mime.html#addhandler">AddHandler</a></code> or
- <code><a href="mod_mime.html#sethandler">SetHandler</a></code>)
+ handler <code>imap-file</code> (using either
+ <a href="mod_mime.html#addhandler" class="directive"><code class="directive">AddHandler</code></a> or
+ <a href="core.html#sethandler" class="directive"><code class="directive">SetHandler</code></a>)
will be processed by this module.</p>
<p>The following directive will activate files ending with
<code>.map</code> as imagemap files:</p>
- <blockquote>
- <code>AddHandler imap-file map</code>
- </blockquote>
- Note that the following is still supported:
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddHandler imap-file map</code></td></tr></table></blockquote>
- <blockquote>
- <code>AddType application/x-httpd-imap map</code>
- </blockquote>
- However, we are trying to phase out "magic MIME types" so we
- are deprecating this method.
+ <p>Note that the following is still supported:</p>
- <h2>Directives</h2>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddType application/x-httpd-imap map</code></td></tr></table></blockquote>
- <ul>
- <li><a href="#imapmenu">ImapMenu</a></li>
-
- <li><a href="#imapdefault">ImapDefault</a></li>
-
- <li><a href="#imapbase">ImapBase</a></li>
- </ul>
+ <p>However, we are trying to phase out "magic MIME types" so we
+ are deprecating this method.</p>
+</summary><h2>Directives</h2><ul><li><a href="#imapbase">ImapBase</a></li><li><a href="#imapdefault">ImapDefault</a></li><li><a href="#imapmenu">ImapMenu</a></li></ul><h2>New Features</h2>
- <h2>New Features</h2>
- The imagemap module adds some new features that were not
- possible with previously distributed imagemap programs.
+ <p>The imagemap module adds some new features that were not
+ possible with previously distributed imagemap programs.</p>
<ul>
<li>URL references relative to the Referer: information.</li>
<li>Configurable generation of imagemap menus.</li>
</ul>
+<h2>Imagemap File</h2>
- <h2>Imagemap File</h2>
- The lines in the imagemap files can have one of several
- formats:
+ <p>The lines in the imagemap files can have one of several
+ formats:</p>
- <blockquote>
- <code>directive value [x,y ...]</code><br />
- <code>directive value "Menu text" [x,y ...]</code><br />
- <code>directive value x,y ... "Menu text"</code><br />
- </blockquote>
- The directive is one of <code>base</code>,
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ directive value [x,y ...]<br>
+ directive value "Menu text" [x,y ...]<br>
+ directive value x,y ... "Menu text"
+</code></td></tr></table></blockquote>
+ <p>The directive is one of <code>base</code>,
<code>default</code>, <code>poly</code>, <code>circle</code>,
<code>rect</code>, or <code>point</code>. The value is an
absolute or relative URL, or one of the special values listed
below. The coordinates are <code>x,y</code> pairs separated by
whitespace. The quoted text is used as the text of the link if
a imagemap menu is generated. Lines beginning with '#' are
- comments.
+ comments.</p>
- <h3>Imagemap File Directives</h3>
- There are six directives allowed in the imagemap file. The
+<h3>Imagemap File Directives</h3>
+ <p>There are six directives allowed in the imagemap file. The
directives can come in any order, but are processed in the
- order they are found in the imagemap file.
+ order they are found in the imagemap file.</p>
<dl>
<dt><code>base</code> Directive</dt>
ImapBase as set in a .htaccess file or in the server
configuration files. In the absence of an ImapBase
configuration directive, <code>base</code> defaults to
- <code>http://server_name/</code>.<br />
+ <code>http://server_name/</code>.<br>
<code>base_uri</code> is synonymous with <code>base</code>.
Note that a trailing slash on the URL is significant.</dd>
valid coordinates are given.</dd>
</dl>
- <h3>Values</h3>
- The values for each of the directives can any of the following:
+
+<h3>Values</h3>
+
+ <p>The values for each of the directives can any of the following:</p>
<dl>
<dd>The URL can be relative or absolute URL. Relative URLs
can contain '..' syntax and will be resolved relative to the
- <code>base</code> value.<br />
+ <code>base</code> value.<br>
<code>base</code> itself will not resolved according to the
current value. A statement <code>base mailto:</code> will
work properly, though.</dd>
<code>default</code>.</dd>
</dl>
- <h3>Coordinates</h3>
+
+<h3>Coordinates</h3>
<dl>
<dt><code>0,0 200,200</code></dt>
- <dd>A coordinate consists of an <tt>x</tt> and a <tt>y</tt>
+ <dd>A coordinate consists of an <code>x</code> and a <code>y</code>
value separated by a comma. The coordinates are separated
from each other by whitespace. To accommodate the way Lynx
handles imagemaps, should a user select the coordinate
selected.</dd>
</dl>
- <h3>Quoted Text</h3>
+
+
+<h3>Quoted Text</h3>
<dl>
<dt><code>"Menu Text"</code></dt>
<dd>After the value or after the coordinates, the line
optionally may contain text within double quotes. This string
is used as the text for the link if a menu is
- generated:<br />
+ generated:<br>
<code><a HREF="http://foo.com/">Menu
- text</a></code><br />
+ text</a></code><br>
If no quoted text is present, the name of the link will be
- used as the text:<br />
+ used as the text:<br>
<code><a
- HREF="http://foo.com/">http://foo.com</a></code><br />
+ HREF="http://foo.com/">http://foo.com</a></code><br>
It is impossible to escape double quotes within this
text.</dd>
</dl>
- <h2>Example Mapfile</h2>
+<h2>Example Mapfile</h2>
- <blockquote>
- <code>#Comments are printed in a 'formatted' or
- 'semiformatted' menu.<br />
- #And can contain html tags. <hr><br />
- base referer<br />
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ #Comments are printed in a 'formatted' or
+ 'semiformatted' menu.<br>
+ #And can contain html tags. <hr><br>
+ base referer<br>
poly map "Could I have a menu, please?" 0,0 0,10 10,10
- 10,0<br />
- rect .. 0,0 77,27 "the directory of the referer"<br />
+ 10,0<br>
+ rect .. 0,0 77,27 "the directory of the referer"<br>
circle http://www.inetnebr.com/lincoln/feedback/ 195,0
- 305,27<br />
+ 305,27<br>
rect another_file "in same directory as referer" 306,0
- 419,27<br />
- point http://www.zyzzyva.com/ 100,100<br />
- point http://www.tripod.com/ 200,200<br />
- rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"<br />
- </code>
- </blockquote>
-
- <h2>Referencing your mapfile</h2>
-
- <blockquote>
- <code><A HREF="/maps/imagemap1.map"><br />
- <IMG ISMAP SRC="/images/imagemap1.gif"><br />
- </A></code>
- </blockquote>
- <hr />
-
- <h2><a id="imapmenu" name="imapmenu">ImapMenu</a>
- directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ImapMenu
- none|formatted|semiformatted|unformatted<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_imap<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ImapMenu is only
- available in Apache 1.1 and later.
-
- <p>The ImapMenu directive determines the action taken if an
- imagemap file is called without valid coordinates.</p>
+ 419,27<br>
+ point http://www.zyzzyva.com/ 100,100<br>
+ point http://www.tripod.com/ 200,200<br>
+ rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"<br>
+</code></td></tr></table></blockquote>
+
+<h2>Referencing your mapfile</h2>
+
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ <A HREF="/maps/imagemap1.map"><br>
+ <IMG ISMAP SRC="/images/imagemap1.gif"><br>
+ </A>
+</code></td></tr></table></blockquote>
+<hr/><h2><a name="ImapBase">ImapBase</a> <a name="imapbase">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Default base for imagemap files</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ImapBase map|referer|<em>URL</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ImapBase http://servername/</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_imap</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ImapBase</code> directive sets the default
+ <code>base</code> used in the imagemap files. Its value is
+ overridden by a <code>base</code> directive within the imagemap
+ file. If not present, the <code>base</code> defaults to
+ <code>http://servername/</code>.</p>
+</usage><hr/><h2><a name="ImapDefault">ImapDefault</a> <a name="imapdefault">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Default action when an imagemap is called with coordinates
+that are not explicitly mapped</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ImapDefault error|nocontent|map|referer|<em>URL</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ImapDefault nocontent</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_imap</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ImapDefault</code> directive sets the default
+ <code>default</code> used in the imagemap files. Its value is
+ overridden by a <code>default</code> directive within the
+ imagemap file. If not present, the <code>default</code> action
+ is <code>nocontent</code>, which means that a <code>204 No
+ Content</code> is sent to the client. In this case, the client
+ should continue to display the original page.</p>
+</usage><hr/><h2><a name="ImapMenu">ImapMenu</a> <a name="imapmenu">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Action if no coordinates are given when calling
+an imagemap</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>ImapMenu
+ none|formatted|semiformatted|unformatted</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_imap</td></tr></table></td></tr></table><usage>
+ <p>The <code class="directive">ImapMenu</code> directive determines the
+ action taken if an imagemap file is called without valid
+ coordinates.</p>
<dl>
<dt><code>none</code></dt>
of your menus, but requires you to treat your map files as
HTML instead of plaintext.</dd>
</dl>
- <hr />
-
- <h2><a id="imapdefault" name="imapdefault">ImapDefault</a>
- directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ImapDefault
- error|nocontent|map|referer|<em>URL</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_imap<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ImapDefault is
- only available in Apache 1.1 and later.
-
- <p>The ImapDefault directive sets the default
- <code>default</code> used in the imagemap files. Its value is
- overridden by a <code>default</code> directive within the
- imagemap file. If not present, the <code>default</code> action
- is <code>nocontent</code>, which means that a <code>204 No
- Content</code> is sent to the client. In this case, the client
- should continue to display the original page.</p>
- <hr />
-
- <h2><a id="imapbase" name="imapbase">ImapBase</a>
- directive</h2>
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ImapBase
- map|referer|<em>URL</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_imap<br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> ImapBase is only
- available in Apache 1.1 and later.
-
- <p>The ImapBase directive sets the default <code>base</code>
- used in the imagemap files. Its value is overridden by a
- <code>base</code> directive within the imagemap file. If not
- present, the <code>base</code> defaults to
- <code>http://servername/</code>.
- <!--#include virtual="footer.html" -->
- </p>
- </body>
-</html>
-
+</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
---><title>mod_speling - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_speling</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module attempts to correct misspellings of URLs that
-users might have entered, by ignoring capitalization and by
-allowing up to one misspelling.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>speling_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3 and later. Available as
-an External module in Apache 1.1 and later.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+--><title>mod_speling - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_speling</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Attempts to correct mistaken URLs that
+users might have entered by ignoring capitalization and by
+allowing up to one misspelling</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>speling_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>Requests to documents sometimes cannot be served by the core
apache server because the request was misspelled or
client can select the correct candidate.</li>
</ul>
-</summary><h2>Directives</h2><ul><li><a href="#checkspelling">CheckSpelling</a></li></ul><hr/><h2><a name="CheckSpelling">CheckSpelling</a> <a name="checkspelling">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>This directive enables or disables the spelling
-module
.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CheckSpelling on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>CheckSpelling Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_speling</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>CheckSpelling was available as a separately available
+</summary><h2>Directives</h2><ul><li><a href="#checkspelling">CheckSpelling</a></li></ul><hr/><h2><a name="CheckSpelling">CheckSpelling</a> <a name="checkspelling">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enables the spelling
+module</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>CheckSpelling on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>CheckSpelling Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_speling</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>CheckSpelling was available as a separately available
module for Apache 1.1, but was limited to miscapitalizations. As
of Apache 1.3, it is part of the Apache distribution. Prior to Apache
1.3.2, the CheckSpelling directive was only available in the
directory names.</li>
<li>spelling corrections apply strictly to existing files, so
- a request for the <samp><Location /status></samp> may
+ a request for the <code><Location /status></code> may
get incorrectly treated as the negotiated file
- "<samp>/stats.html</samp>".</li>
+ "<code>/stats.html</code>".</li>
</ul>
</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="../images/index.gif"/></a><a href="../"><img alt="Home" src="../images/home.gif"/></a></blockquote></body></html>
\ No newline at end of file
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
---><title>mod_status - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_status</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides information on server activity and
-performance.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>status_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.1 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+--><title>mod_status - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_status</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Provides information on server activity and
+performance</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>status_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<blockquote><table><tr><td bgcolor="#e0e5f5">
<strong>Warning:</strong> This document has not been updated
<li>The current hosts and requests being processed (*)</li>
</ul>
- A compile-time option must be used to display the details
+ <p>A compile-time option must be used to display the details
marked "(*)" as the instrumentation required for obtaining
- these statistics does not exist within standard Apache.
+ these statistics does not exist within standard Apache.</p>
</summary><h2>Directives</h2><ul><li><a href="#extendedstatus">ExtendedStatus</a></li></ul><h2>Enabling Status Support</h2>
- To enable status reports only for browsers from the foo.com
+ <p>To enable status reports only for browsers from the foo.com
domain add this code to your <code>httpd.conf</code>
- configuration file
+ configuration file</p>
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
<Location /server-status><br>
SetHandler server-status<br>
<h2>Automatic Updates</h2>
- You can get the status page to update itself automatically if
+ <p>You can get the status page to update itself automatically if
you have a browser that supports "refresh". Access the page
<code>http://your.server.name/server-status?refresh=N</code> to
- refresh the page every N seconds.
+ refresh the page every N seconds.</p>
<h2>Machine Readable Status File</h2>
- A machine-readable version of the status file is available by
+ <p>A machine-readable version of the status file is available by
accessing the page
<code>http://your.server.name/server-status?auto</code>. This
is useful when automatically run, see the Perl program in the
<code>/support</code> directory of Apache,
- <code>log_server_status</code>.
+ <code>log_server_status</code>.</p>
<blockquote><table><tr><td bgcolor="#e0e5f5">
<strong>It should be noted that if <code><a href="mod_status.html">mod_status</a></code> is
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
---><title>mod_suexec - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_suexec</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module allows CGI scripts to run as a specified user
-and Group
.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>suexec_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 2.0 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+--><title>mod_suexec - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_suexec</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Allows CGI scripts to run as a specified user
+and Group</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>suexec_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 2.0 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This module allows CGI scripts to run as a specified user
and Group.</p>
</summary><h2>Directives</h2><ul><li><a href="#suexecusergroup">SuexecUserGroup</a></li></ul><hr/><h2><a name="SuexecUserGroup">SuexecUserGroup</a> <a name="suexecusergroup">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>SuexecUserGroup <em>User Group</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>None</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_suexec</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>SuexecUserGroup is only available in 2.0 and
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
---><title>mod_unique_id - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_unique_id</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides an environment variable with a unique
-identifier for each request.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>unique_id_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3 and later.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+--><title>mod_unique_id - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_unique_id</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Provides an environment variable with a unique
+identifier for each request</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>unique_id_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This module provides a magic token for each request which is
guaranteed to be unique across "all" requests under very
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
---><title>mod_userdir - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_userdir</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides for user-specific
-directories
.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>userdir_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
+--><title>mod_userdir - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_userdir</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Provides for user-specific
+directories</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>userdir_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
</summary><h2>Directives</h2><ul><li><a href="#userdir">UserDir</a></li></ul><hr/><h2><a name="UserDir">UserDir</a> <a name="userdir">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the directory from which to serve files when requests
for a particular user are received, denoted by requests containing
~username, such as
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
---><title>mod_vhost_alias - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_vhost_alias</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>
This module provides support for <a href="../vhosts/mass.html">dynamically configured mass virtual
-hosting</a>.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>vhost_alias_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3.7 and later.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
+--><title>mod_vhost_alias - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_vhost_alias</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>
Provides for <a href="../vhosts/mass.html">dynamically configured mass virtual
+hosting</a></description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>vhost_alias_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
<p>This module creates dynamically configured virtual hosts, by
allowing the IP address and/or the <code>Host:</code> header of
determine what files to serve. This allows for easy use of a
huge number of virtual hosts with similar configurations.</p>
- <seealso>See also: <a href="core.html#usecanonicalname" class="directive"><code class="directive">UseCanonicalName</code></a>.</seealso>
-</summary><h2>Directives</h2><ul><li><a href="#virtualdocumentroot">VirtualDocumentRoot</a></li><li><a href="#virtualdocumentrootip">VirtualDocumentRootIP</a></li><li><a href="#virtualscriptalias">VirtualScriptAlias</a></li><li><a href="#virtualscriptaliasip">VirtualScriptAliasIP</a></li></ul><h2>Directory Name Interpolation</h2>
+</summary><
p><strong>See also </strong></p><ul><li><a href="core.html#usecanonicalname" class="directive"><code class="directive">UseCanonicalName</code></a>.</li></ul><h2>Directives</h2><ul><li><a href="#virtualdocumentroot">VirtualDocumentRoot</a></li><li><a href="#virtualdocumentrootip">VirtualDocumentRootIP</a></li><li><a href="#virtualscriptalias">VirtualScriptAlias</a></li><li><a href="#virtualscriptaliasip">VirtualScriptAliasIP</a></li></ul><h2>Directory Name Interpolation</h2>
<p>All the directives in this module interpolate a string into
directives <code>%V</code> and <code>%A</code> are useful
in conjunction with this module.</p>
<hr/><h2><a name="VirtualDocumentRoot">VirtualDocumentRoot</a> <a name="virtualdocumentroot">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the document root
-for a given virtual host
.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualDocumentRoot <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualDocumentRoot is only available in 1.3.7 and
+for a given virtual host</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualDocumentRoot <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualDocumentRoot is only available in 1.3.7 and
later.</td></tr></table></td></tr></table><usage>
<p>The <code>VirtualDocumentRoot</code> directive allows you to
directive, except that it uses the IP address of the server end
of the connection instead of the server name.</p>
</usage><hr/><h2><a name="VirtualScriptAlias">VirtualScriptAlias</a> <a name="virtualscriptalias">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the CGI directory for
-a given virtual host
.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualScriptAlias <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualScriptAlias is only available in 1.3.7
+a given virtual host</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualScriptAlias <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualScriptAlias is only available in 1.3.7
and later.</td></tr></table></td></tr></table><usage>
<p>The <code>VirtualScriptAlias</code> directive allows you to
<code>/cgi-bin/</code> would.</p>
</usage><hr/><h2><a name="VirtualScriptAliasIP">VirtualScriptAliasIP</a> <a name="virtualscriptaliasip">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the cgi directory for
-a given virtual host
.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualScriptAliasIP <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualScriptAliasIP is only available in 1.3.7
+a given virtual host</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualScriptAliasIP <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualScriptAliasIP is only available in 1.3.7
and later.</td></tr></table></td></tr></table><usage>
<p>The <code>VirtualScriptAliasIP</code> directive is like the
projects / apache / commitdiff