<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.xsl"?>
<modulesynopsis>
<name>mod_include</name>
+<description>Server-parsed html documents (Server Side Includes)</description>
<status>Base</status>
+<sourcefile>mod_include.c</sourcefile>
<identifier>include_module</identifier>
-<source>mod_include.c</source>
-<compatibility></compatibility>
-<description>This module provides for server-parsed html
-documents.</description>
<summary>
inclusion other files or programs, as well as the setting and
printing of environment variables.</p>
- <seealso><strong>See also</strong>:
- <directive module="core">Options</directive>,
- <directive module="core">SetOutputFilter</directive>
- and <directive module="core">AcceptPathInfo</directive>.</seealso>
-
</summary>
+ <seealso><directive module="core">Options</directive></seealso>
+ <seealso><directive module="core">SetOutputFilter</directive></seealso>
+ <seealso><directive module="core">AcceptPathInfo</directive></seealso>
<section id="enabling">
<title>Enabling Server-Side Includes</title>
<code>text/x-server-parsed-html3</code> (and the resulting
output will have the mime type <code>text/html</code>).</p>
- <
seealso>For more information, see our <a
+ <
p>For more information, see our <a
href="../howto/ssi.html">Tutorial on Server Side
- Includes</a>.</seealso>
+ Includes</a>.</p>
</section>
<section id="basic">
<p>The value will often be enclosed in double quotes; many
commands only allow a single attribute-value pair. Note that
- the comment terminator (<samp>--></samp>) should be preceded
+ the comment terminator (<code>--></code>) should be preceded
by whitespace to ensure that it isn't considered part of an SSI
token. </p>
</dl>
</dd>
- <dt><strong><a id="echo" name="echo">echo</a></strong></dt>
+ <dt><strong><a name="echo">echo</a></strong></dt>
<dd>
<p>This command prints one of the <a href="#includevars">include
<section id="includevars">
<title>Include Variables</title>
- In addition to the variables in the standard CGI environment,
+ <p>In addition to the variables in the standard CGI environment,
these are available for the <code>echo</code> command, for
<code>if</code> and <code>elif</code>, and to any program
- invoked by the document.
+ invoked by the document.</p>
<dl>
<dt>DATE_GMT</dt>
<p>Variable substitution is done within quoted strings in most
cases where they may reasonably occur as an argument to an SSI
- directive. This includes the <samp>config</samp>,
- <samp>exec</samp>, <samp>flastmod</samp>, <samp>fsize</samp>,
- <samp>include</samp>, and <samp>set</samp> directives, as well
+ directive. This includes the <code>config</code>,
+ <code>exec</code>, <code>flastmod</code>, <code>fsize</code>,
+ <code>include</code>, and <code>set</code> directives, as well
as the arguments to conditional operators. You can insert a
literal dollar sign into the string using backslash
quoting:</p>
<!--#set var="Zed" value="${REMOTE_HOST}_${REQUEST_METHOD}" -->
</example>
- <p>This will result in the <samp>Zed</samp> variable being set
- to "<samp>X_Y</samp>" if <samp>REMOTE_HOST</samp> is
- "<samp>X</samp>" and <samp>REQUEST_METHOD</samp> is
- "<samp>Y</samp>".</p>
+ <p>This will result in the <code>Zed</code> variable being set
+ to "<code>X_Y</code>" if <code>REMOTE_HOST</code> is
+ "<code>X</code>" and <code>REQUEST_METHOD</code> is
+ "<code>Y</code>".</p>
<p>EXAMPLE: the below example will print "in foo" if the
DOCUMENT_URI is /foo/file.html, "in bar" if it is
</example>
</section>
-<section>
- <title id="flowctrl">Flow Control Elements</title>
+<section id="flowctrl">
+ <title>Flow Control Elements</title>
- These are available in Apache 1.2 and above. The basic flow
- control elements are:
+ <p>These are available in Apache 1.2 and above. The basic flow
+ control elements are:</p>
<example>
<!--#if expr="<em>test_condition</em>" --><br />
<dd>Compare string1 with string 2. If string2 has the form
<em>/string/</em> then it is compared as a regular
expression. Regular expressions have the same syntax as those
- found in the Unix <samp>egrep</samp> command.</dd>
+ found in the Unix <code>egrep</code> command.</dd>
<dt>( <em>test_condition</em> )</dt>
<section>
<title>Using Server Side Includes for ErrorDocuments</title>
- There is <a href="../misc/custom_errordocs.html">a document</a>
+
<p>There is <a href="../misc/custom_errordocs.html">a document</a>
which describes how to use the features of mod_include to offer
- internationalized customized server error documents.
+ internationalized customized server error documents.</p>
- <h2>PATH_INFO with Server Side Includes</h2>
+</section>
+
+<section><title>PATH_INFO with Server Side Includes</title>
<p>Files processed for server-side includes no longer accept
requests with PATH_INFO (trailing pathname information) by
<p>This directive changes the string that mod_include looks for
to mark the end of a include command.</p>
- <seealso>See also: <directive>SSIStartTag</directive>.</seealso>
</usage>
+<seealso><directive>SSIStartTag</directive></seealso>
</directivesynopsis>
+
<directivesynopsis>
<name>SSIUndefinedEcho</name>
<description>Changes the string that mod_include displays when
<usage>
<p>This directive changes the string that mod_include displays
- when a variable is not set and "echoed"
+ when a variable is not set and "echoed".</p>
</usage>
</directivesynopsis>
output of a file each processing different commands (possibly at
different times).</p>
- <seealso>See also: <directive>SSIEndTag</directive></seealso>
-
</usage>
+<seealso><directive>SSIEndTag</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<directivesynopsis>
<name>XBitHack</name>
+<description>Parse SSI directives in files with the execute
+bit set</description>
<syntax>XBitHack on|off|full</syntax>
<default>XBitHack off</default>
<contextlist>
</contextlist>
<override>Options</override>
<compatibility></compatibility>
-<description>Parse SSI directives in files with the execute
-bit set</description>
<usage>
<p>The XBitHack directives controls the parsing of ordinary
<modulesynopsis>
<name>mod_mime</name>
-<description>This module associates the request filename's extensions
+<description>Associates the request filename's extensions
(e.g. .html) with the file's behavior (handlers and filters)
and content (mime-type, language, character set and
- encoding.)
-</description>
+ encoding)</description>
+<status>Base</status>
<sourcefile>mod_mime.c</sourcefile>
<identifier>mime_module</identifier>
-<status>Base</status>
<summary>
<p>This module is used to associate various bits of "meta
<seealso>See also: <directive
module="mod_mime_magic">MimeMagicFile</directive></seealso>
-<section>
-<title id="multipleext">Files with Multiple Extensions</title>
+<section id="multipleext">
+<title>Files with Multiple Extensions</title>
<p>Files can have more than one extension, and the order of the
extensions is <em>normally</em> irrelevant. For example, if the
file.</p>
</section>
-<section><title id="contentencoding">Content encoding</title>
+<section id="contentencoding"><title>Content encoding</title>
<p>A file of a particular MIME type can additionally be encoded a
particular way to simplify transmission over the Internet.
While this usually will refer to compression, such as
- <samp>gzip</samp>, it can also refer to encryption, such a
- <samp>pgp</samp> or to an encoding such as UUencoding, which is
+ <code>gzip</code>, it can also refer to encryption, such a
+ <code>pgp</code> or to an encoding such as UUencoding, which is
designed for transmitting a binary file in an ASCII (text)
format.</p>
<p>For example, you may have a file which is a Microsoft Word
document, which is pkzipped to reduce its size. If the
- <samp>.doc</samp> extension is associated with the Microsoft
- Word file type, and the <samp>.zip</samp> extension is
+ <code>.doc</code> extension is associated with the Microsoft
+ Word file type, and the <code>.zip</code> extension is
associated with the pkzip file encoding, then the file
- <samp>Resume.doc.zip</samp>would be known to be a pkzip'ed Word
+ <code>Resume.doc.zip</code>would be known to be a pkzip'ed Word
document.</p>
- <p>Apache send a <samp>Content-encoding</samp> header with the
+ <p>Apache send a <code>Content-encoding</code> header with the
resource, in order to tell the client browser about the
encoding method.</p>
<title>Charset</title>
<p>To convey this further information, Apache optionally sends
- a <samp>Content-Language</samp> header, to specify the language
+ a <code>Content-Language</code> header, to specify the language
that the document is in, and can append additional information
- onto the <samp>Content-Type</samp> header to indicate the
+ onto the <code>Content-Type</code> header to indicate the
particular character set that should be used to correctly
render the information.</p>
</example>
<p>The language specification is the two-letter abbreviation
- for the language. The <samp>charset</samp> is the name of the
+ for the language. The <code>charset</code> is the name of the
particular character set which should be used.</p>
</section>
</section>
<directivesynopsis>
<name>AddCharset</name>
+<description>Maps the given filename extensions
+ to the specified content charset</description>
<syntax>AddCharset <em>charset extension</em>
[<em>extension</em>] ...</syntax>
<default>None</default>
<override>FileInfo</override>
<compatibility>AddCharset is only available in Apache
1.3.10 and later</compatibility>
-<description>Maps the given filename extensions
- to the specified content charset</description>
<usage>
<p>The AddCharset directive maps the given filename extensions
- to the specified content charset. <i>charset</i> is the MIME
- charset parameter of filenames containing <i>extension</i>.
+ to the specified content charset. <em>charset</em> is the MIME
+ charset parameter of filenames containing <em>extension</em>.
This mapping is added to any already in force, overriding any
- mappings that already exist for the same <i>extension</i>.</p>
+ mappings that already exist for the same <em>extension</em>.</p>
<p>Example:</p>
<example>
<p>The <em>extension</em> argument is case-insensitive, and can
be specified with or without a leading dot.</p>
- <seealso><strong>See also</strong>:
- <module>mod_negotiation</module></seealso>
-
</usage>
+<seealso><module>mod_negotiation</module></seealso>
</directivesynopsis>
<directivesynopsis>
<name>AddEncoding</name>
+<description>Maps the given filename extensions
+ to the specified encoding type</description>
<syntax>AddEncoding
<em>MIME-enc extension</em> [<em>extension</em>] ...</syntax>
<default>None</default>
<context>virtual host</context>
<context>directory</context>
<context>.htaccess</context>
-<override>FileInfo</override>
</contextlist>
-<description>Maps the given filename extensions
- to the specified encoding type</description>
+<override>FileInfo</override>
+
<usage>
<p>The <em>extension</em> argument is case-insensitive, and can
be specified with or without a leading dot.</p>
- <seealso><strong>See also</strong>: <a href="#multipleext">Files with
- multiple extensions</a></seealso>
</usage>
+<seealso><a href="#multipleext">Files with
+ multiple extensions</a></seealso>
</directivesynopsis>
<directivesynopsis>
<name>AddHandler</name>
+<description>AddHandler maps the filename extensions
+to the <a href="../handler.html">handler</a>
+<em>handler-name</em></description>
<syntax>AddHandler
<em>handler-name extension</em> [<em>extension</em>] ...</syntax>
<default>None</default>
</contextlist>
<override>FileInfo</override>
<compatibility></compatibility>
-<description>AddHandler maps the filename extensions <em>extension</em>
-to the <a href="../handler.html">handler</a> <em>handler-name</em>.
-</description>
<usage>
<p>This mapping is added to any already in
<p>The <em>extension</em> argument is case-insensitive, and can
be specified with or without a leading dot.</p>
- <seealso><strong>See also</strong>: <a href="#multipleext">Files with
- multiple extensions</a></seealso>
</usage>
+ <seealso><a href="#multipleext">Files with
+ multiple extensions</a></seealso>
</directivesynopsis>
<directivesynopsis>
<name>AddInputFilter</name>
+<description>Maps the filename extensions
+ to the filter or filters which will process
+ client requests</description>
<syntax>AddInputFilter
<em>filter</em>[<em>;filter</em>...] extension
[<em>extension</em> ...]</syntax>
</contextlist>
<compatibility>AddInputFilter
is only available in Apache 2.0.26 and later.</compatibility>
-<description>Maps the filename extensions
- <em>extension</em> to the filter or filters which will process
- client requests and POST input when they are received by the
- server.</description>
<usage>
case-insensitive, and the extension may be specified with or
without a leading dot.</p>
- <seealso>See also the <a href="../filter.html">Filters</a>
- documentation.</seealso>
</usage>
+<seealso><a href="../filter.html">Filters</a>
+ documentation.</seealso>
</directivesynopsis>
<directivesynopsis>
<name>AddLanguage</name>
+<description>Maps the given filename extension
+to the specified content language</description>
<syntax>AddLanguage
<em>MIME-lang extension</em> [<em>extension</em>] ...</syntax>
<default>None</default>
<context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
-<description>maps the given filename extension
-to the specified content language.</description>
<usage>
<p>The <em>extension</em> argument is case-insensitive, and can
be specified with or without a leading dot.</p>
- <seealso><strong>See also</strong>: <a href="#multipleext">Files with
- multiple extensions</a>, <module>mod_negotiation</module></seealso>
</usage>
+<seealso><a href="#multipleext">Files with
+ multiple extensions</a></seealso>
+<seealso><module>mod_negotiation</module></seealso>
</directivesynopsis>
<directivesynopsis>
<name>AddOutputFilter</name>
+<description>maps the filename
+extensions to the filters that will process
+responses from the server</description>
<syntax>AddOutputFilter
<em>filter</em>[<em>;filter</em>...] extension
[<em>extension</em> ...]</syntax>
<override></override>
<compatibility>AddOutputFilter
is only available in Apache 2.0.26 and later.</compatibility>
-<description>maps the filename
-extensions <em>extension</em> to the filters which will process
-responses from the server before they are sent to the
-client.</description>
<usage>
case-insensitive, and the extension may be specified with or
without a leading dot.</p>
- <seealso>See also the <a href="../filter.html">Filters</a>
- documentation.</seealso>
-
</usage>
+<seealso><a href="../filter.html">Filters</a> documentation</seealso>
+
</directivesynopsis>
<directivesynopsis>
<name>AddType</name>
+<description>Maps the given filename extensions
+onto the specified content type</description>
<syntax>AddType <em>MIME-type
extension</em> [<em>extension</em>] ...</syntax>
<default>None</default>
<context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
-<description>maps the given filename extensions
-onto the specified content type.</description>
<usage>
<p>The <em>extension</em> argument is case-insensitive, and can
be specified with or without a leading dot.</p>
- <seealso><strong>See also</strong>: <a href="#multipleext">Files with
- multiple extensions</a></seealso>
</usage>
+<seealso><a href="#multipleext">Files with
+ multiple extensions</a></seealso>
</directivesynopsis>
<directivesynopsis>
<directivesynopsis>
<name>DefaultLanguage</name>
+<description>Sets all files in the given scope to the
+specified language</description>
<syntax>DefaultLanguage
<em>MIME-lang</em></syntax>
<default>None</default>
<override>FileInfo</override>
<compatibility>DefaultLanguage
is only available in Apache 1.3.4 and later.</compatibility>
-<description>Sets all files in the given scope to the
-specified language</description>
<usage>
<p>The DefaultLanguage directive tells Apache that all files in
the directive's scope (<em>e.g.</em>, all files covered by the
current <code><Directory></code> container) that don't
- have an explicit language extension (such as <samp>.fr</samp>
- or <samp>.de</samp> as configured by <samp>AddLanguage</samp>)
+ have an explicit language extension (such as <code>.fr</code>
+ or <code>.de</code> as configured by <code>AddLanguage</code>)
should be considered to be in the specified <em>MIME-lang</em>
language. This allows entire directories to be marked as
containing Dutch content, for instance, without having to
rename each file. Note that unlike using extensions to specify
- languages, <samp>DefaultLanguage</samp> can only specify a
+ languages, <code>DefaultLanguage</code> can only specify a
single language.</p>
- <p>If no <samp>DefaultLanguage</samp> directive is in force,
+ <p>If no <code>DefaultLanguage</code> directive is in force,
and a file does not have any language extensions as configured
- by <samp>AddLanguage</samp>, then that file will be considered
+ by <code>AddLanguage</code>, then that file will be considered
to have no language attribute.</p>
- <seealso><strong>See also</strong>: <a href="#multipleext">Files with
- multiple extensions</a>, <module>mod_negotiation</module></seealso>
</usage>
+<seealso><a href="#multipleext">Files with
+ multiple extensions</a></seealso>
+<seealso><module>mod_negotiation</module></seealso>
</directivesynopsis>
only available in Apache 2.0.24 and later.</compatibility>
<usage>
- <p>The <samp>RemoveCharset</samp> directive removes any
+ <p>The <code>RemoveCharset</code> directive removes any
character set associations for files with the given extensions.
This allows <code>.htaccess</code> files in subdirectories to
undo any associations inherited from parent directories or the
<usage>
- <p>The <samp>RemoveEncoding</samp> directive removes any
+ <p>The <code>RemoveEncoding</code> directive removes any
encoding associations for files with the given extensions. This
allows <code>.htaccess</code> files in subdirectories to undo
any associations inherited from parent directories or the
encoded with the gzip method, but <code>foo.gz.asc</code> as an
unencoded plaintext file.</p>
- <p><b>Note:</b>RemoveEncoding directives are processed
- <i>after</i> any AddEncoding directives, so it is possible they
+ <p><strong>Note:</strong>RemoveEncoding directives are processed
+ <em>after</em> any AddEncoding directives, so it is possible they
may undo the effects of the latter if both occur within the
same directory configuration.</p>
<usage>
- <p>The <samp>RemoveHandler</samp> directive removes any handler
+ <p>The <code>RemoveHandler</code> directive removes any handler
associations for files with the given extensions. This allows
<code>.htaccess</code> files in subdirectories to undo any
associations inherited from parent directories or the server
</dl>
</example>
- <p>This has the effect of returning <samp>.html</samp> files in
- the <samp>/foo/bar</samp> directory to being treated as normal
+ <p>This has the effect of returning <code>.html</code> files in
+ the <code>/foo/bar</code> directory to being treated as normal
files, rather than as candidates for parsing (see the <a
- href="mod_include.html"><samp>mod_include</samp></a>
+ href="mod_include.html"><code>mod_include</code></a>
module).</p>
<p>The <em>extension</em> argument is case-insensitive, and can
<usage>
- <p>The <samp>RemoveInputFilter</samp> directive removes any
+ <p>The <code>RemoveInputFilter</code> directive removes any
input filter associations for files with the given extensions.
This allows <code>.htaccess</code> files in subdirectories to
undo any associations inherited from parent directories or the
<usage>
- <p>The <samp>RemoveLanguage</samp> directive removes any
+ <p>The <code>RemoveLanguage</code> directive removes any
language associations for files with the given extensions. This
allows <code>.htaccess</code> files in subdirectories to undo
any associations inherited from parent directories or the
<usage>
- <p>The <samp>RemoveOutputFilter</samp> directive removes any
+ <p>The <code>RemoveOutputFilter</code> directive removes any
output filter associations for files with the given extensions.
This allows <code>.htaccess</code> files in subdirectories to
undo any associations inherited from parent directories or the
causing the files to be treated as being of the <a
href="core.html#defaulttype">default type</a>.</p>
- <note><b>Note:</b><module>RemoveType</module> directives are processed
- <i>after</i> any <module>AddType</module> directives, so it is
- possible they may undo the effects of the latter if both occur
- within the same directory configuration.</note>
+ <note><strong>Note:</strong><module>RemoveType</module> directives
+ are processed <em>after</em> any <module>AddType</module>
+ directives, so it is possible they may undo the effects of the
+ latter if both occur within the same directory
+ configuration.</note>
<p>The <em>extension</em> argument is case-insensitive, and can
be specified with or without a leading dot.</p>
projects / apache / commitdiff