mod_include.html revision 65a1588701f9e5d0f62261d0da85733a23edc92f
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <meta name="generator" content="HTML Tidy, see www.w3.org" />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#include virtual="header.html" -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>This module provides for server-parsed html documents.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj include_module</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>This module provides a filter which will process files
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj before they are sent to the client. The processing is
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj controlled by specially formated SGML comments, referred to as
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <em>elements</em>. These elements allow conditional text, the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj inclusion other files or programs, as well as the setting and
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj printing of environment variables.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>See also: <a href="core.html#options">Options</a>, <a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj href="core.html.html#SetOutputFilter">SetOutputFilter</a>,
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj and <a href="core.html#acceptpathinfo">AcceptPathInfo</a>.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>Server Side Includes are implemented by the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <code>INCLUDES</code> <a href="/filter.html">filter</a>. If
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj documents containing server-side include directives are given
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj the extension .shtml, the following directives will make Apache
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj parse them and assign the resulting document the mime type of
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <blockquote>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj AddOutputFilter INCLUDES .shtml</code>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj </blockquote>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>The following directive must be given for the directories
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj containing the shtml files (typically in a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <code><Directory></code> section, but this directive is
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj also valid .htaccess files if <code>AllowOverride
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <blockquote>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj </blockquote>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>For backwards compatibility, the <code>server-parsed</code>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj INCLUDES filter. As well, Apache will activate the INCLUDES
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj filter for any document with mime type
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <code>text/x-server-parsed-html3</code> (and the resulting
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj output will have the mime type <code>text/html</code>).</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj href="/howto/ssi.html">Tutorial on Server Side
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj The document is parsed as an HTML document, with special
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj commands embedded as SGML comments. A command has the syntax:
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <blockquote>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj </blockquote>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj The value will often be enclosed in double quotes; many
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj commands only allow a single attribute-value pair. Note that
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj the comment terminator (<samp>--></samp>) should be preceded
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj by whitespace to ensure that it isn't considered part of an SSI
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj This command controls various aspects of the parsing. The
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj valid attributes are:
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The value is a message that is sent back to the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj client if an error occurs whilst parsing the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj document.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The value sets the format to be used which displaying
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj the size of a file. Valid values are <code>bytes</code>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj for a count in bytes, or <code>abbrev</code> for a count
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj in Kb or Mb as appropriate.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The value is a string to be used by the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj dates.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dt><strong><a id="echo" name="echo">echo</a></strong></dt>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj This command prints one of the include variables, defined
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj below. If the variable is unset, it is printed as
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <code>(none)</code>. Any dates printed are subject to the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The value is the name of the variable to print.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>Specifies how Apache should encode special characters
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj contained in the variable before outputting them. If set
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj to "none", no encoding will be done. If set to "url",
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj then URL encoding (also known as %-encoding; this is
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj appropriate for use within URLs in links, etc.) will be
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj performed. At the start of an <code>echo</code> element,
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj the default is set to "entity", resulting in entity
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj encoding (which is appropriate in the context of a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj block-level HTML element, eg. a paragraph of text). This
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj attribute, which will remain in effect until the next
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj element ends, whichever comes first. Note that the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <code>encoding</code> attribute must <em>precede</em> the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj corresponding <code>var</code> attribute to be effective,
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj and that only special characters as defined in the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj ISO-8859-1 character encoding will be encoded. This
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj encoding process may not have the desired result if a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj different character encoding is in use. Apache 1.3.12 and
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj above; previous versions do no encoding.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj The exec command executes a given shell command or CGI
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj script. The IncludesNOEXEC <a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj href="core.html#options">Option</a> disables this command
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj completely. The valid attributes are:
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj The value specifies a (%-encoded) URL relative path to
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj the CGI script. If the path does not begin with a (/),
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj then it is taken to be relative to the current
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj document. The document referenced by this path is
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj invoked as a CGI script, even if the server would not
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj normally recognize it as such. However, the directory
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj containing the script must be enabled for CGI scripts
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>The CGI script is given the PATH_INFO and query
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj string (QUERY_STRING) of the original request from the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj client; these cannot be specified in the URL path. The
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj include variables will be available to the script in
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj addition to the standard <a href="mod_cgi.html">CGI</a>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj environment.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>If the script returns a Location: header instead of
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj output, then this will be translated into an HTML
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj anchor.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The server will execute the given string using
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <code>/bin/sh</code>. The include variables are available
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj to the command.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj This command prints the size of the specified file, subject
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj Attributes:
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The value is a path relative to the directory
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj containing the current document being parsed.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The value is a (%-encoded) URL-path relative to the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj current document being parsed. If it does not begin with
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj a slash (/) then it is taken to be relative to the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj current document.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>This command prints the last modification date of the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj specified file, subject to the <code>timefmt</code> format
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj specification. The attributes are the same as for the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj This command inserts the text of another document or file
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj into the parsed file. Any included file is subject to the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj usual access control. If the directory containing the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj parsed file has the <a href="core.html#options">Option</a>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj IncludesNOEXEC set, and the including the document would
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj cause a program to be executed, then it will not be
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj included; this prevents the execution of CGI scripts.
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj Otherwise CGI scripts are invoked as normal using the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj complete URL given in the command, including any query
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--%plaintext <?INDEX CGI scripts, {\tt include} element and> -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>An attribute defines the location of the document; the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj inclusion is done for each attribute given to the include
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj command. The valid attributes are:</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The value is a path relative to the directory
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj containing the current document being parsed. It cannot
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj contain <code>../</code>, nor can it be an absolute path.
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj The <code>virtual</code> attribute should always be used
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj in preference to this one.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The value is a (%-encoded) URL relative to the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj current document being parsed. The URL cannot contain a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj scheme or hostname, only a path and an optional query
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj string. If it does not begin with a slash (/) then it is
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj taken to be relative to the current document.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj A URL is constructed from the attribute, and the output the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj server would return if the URL were accessed by the client
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj is included in the parsed output. Thus included files can
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj be nested.
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>This prints out a listing of all existing variables and
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj their values. Starting with Apache 1.3.12, special characters
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj are entity encoded (see the <a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj href="#echo"><code>echo</code></a> element for details)
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj before being output. No attributes.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>For example: <code><!--#printenv --></code></dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj This sets the value of a variable. Attributes:
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj For example: <code><!--#set var="category" value="help"
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj --></code>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj In addition to the variables in the standard CGI environment,
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj these are available for the <code>echo</code> command, for
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <code>if</code> and <code>elif</code>, and to any program
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj invoked by the document.
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The filename (excluding directories) of the document
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj requested by the user.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The (%-decoded) URL path of the document requested by the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj user. Note that in the case of nested include files, this is
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>The last modification date of the document requested by
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj the user.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>Variable substitution is done within quoted strings in most
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj cases where they may reasonably occur as an argument to an SSI
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <samp>exec</samp>, <samp>flastmod</samp>, <samp>fsize</samp>,
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <samp>include</samp>, and <samp>set</samp> directives, as well
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj as the arguments to conditional operators. You can insert a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj literal dollar sign into the string using backslash
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj quoting:</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#if expr="$a = \$test" -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>If a variable reference needs to be substituted in the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj middle of a character sequence that might otherwise be
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj considered a valid identifier in its own right, it can be
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj disambiguated by enclosing the reference in braces,
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#set var="Zed" value="${REMOTE_HOST}_${REQUEST_METHOD}" -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>This will result in the <samp>Zed</samp> variable being set
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>EXAMPLE: the below example will print "in foo" if the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#if expr="\"$DOCUMENT_URI\" = \"/foo/file.html\"" -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#elif expr="\"$DOCUMENT_URI\" = \"/bar/file.html\"" -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#else -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj in neither
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#endif -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj These are available in Apache 1.2 and above. The basic flow
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj control elements are:
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#else -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#endif -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>The <strong><code>if</code></strong> element works like an
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj if statement in a programming language. The test condition is
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj evaluated and if the result is true, then the text until the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <strong><code>endif</code></strong> element is included in the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj output stream.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <strong><code>else</code></strong> statements are be used the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj put text into the output stream if the original test_condition
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj was false. These elements are optional.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>The <strong><code>endif</code></strong> element ends the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <strong><code>if</code></strong> element and is required.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p><em>test_condition</em> is one of the following:</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>Compare string1 with string 2. If string2 has the form
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj expression. Regular expressions have the same syntax as those
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dt><em>test_condition1</em> || <em>test_condition2</em></dt>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>"<em>=</em>" and "<em>!=</em>" bind more tightly than
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj "<em>&&</em>" and "<em>||</em>". "<em>!</em>" binds
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj most tightly. Thus, the following are equivalent:</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#if expr="$a = test1 && $b = test2" -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <!--#if expr="($a = test1) && ($b = test2)" -->
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>Anything that's not recognized as a variable or an operator
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj is treated as a string. Strings can also be quoted:
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <em>'string'</em>. Unquoted strings can't contain whitespace
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj (blanks and tabs) because it is used to separate tokens such as
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj variables. If multiple strings are found in a row, they are
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj concatenated using blanks. So,</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <em>string1 string2</em> results in <em>string1 string2</em>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <em>'string1 string2'</em> results in <em>string1 string2</em>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj There is <a href="/misc/custom_errordocs.html">a document</a>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj which describes how to use the features of mod_include to offer
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj internationalized customized server error documents.
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>Files processed for server-side includes no longer accept
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj requests with PATH_INFO (trailing pathname information) by
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj default. You can use the <a
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj href="core.html#AcceptPathInfo">AcceptPathInfo</a> directive to
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj configure the server to accept requests with PATH_INFO.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Syntax:</strong></a> SSIEndTag <em>tag</em><br
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Default:</strong></a> <code>SSIEndTag
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj href="directive-dict.html#Context"
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Context:</strong></a> server config, virtual
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Module:</strong></a> mod_include<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj Available in version 2.0.30 and later.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>This directive changes the string that mod_include looks for
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj to mark the end of a include command.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>See also: <a href="#ssistarttag">SSIStartTag</a>.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <h2><a id="ssierrormsg" name="ssierrormsg">SSIErrorMsg</a>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj directive</h2>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Default:</strong></a> <code>SSIErrorMsg
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj "[an error occurred while processing this directive]"</code><br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Context:</strong></a> server config, virtual
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj host, directory, .htaccess<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Module:</strong></a> mod_include<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj Available in version 2.0.30 and later.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>The SSIErrorMsg directive changes the error message displayed
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj when mod_include encounters an error. For production servers you
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj may consider changing the default error message to
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <code>"<-- Error -->"</code> so that the message
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj is not presented to the user.
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>This directive has the same effect as the <code><--#config
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <h2><a id="ssistarttag" name="ssistarttag">SSIStartTag</a>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj directive</h2>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Default:</strong></a> <code>SSIStartTag
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Context:</strong></a> server config, virtual
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj host<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Module:</strong></a> mod_include<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj Available in version 2.0.30 and later.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>This directive changes the string that mod_include looks for
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj to mark an include element to process.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>You may want to use this option if have 2 servers parsing the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj output of a file each processing different commands (possibly at
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj different times).</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <h2><a id="ssitimeformat" name="ssitimeformat">SSITimeFormat</a>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj directive</h2>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Default:</strong></a> <code>SSITimeFormat
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Context:</strong></a> server config, virtual
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj host, directory, .htaccess<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Module:</strong></a> mod_include<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj Available in version 2.0.30 and later.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>This directive changes the format in which date strings are displayed
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj when echoing DATE environment variables. The <em>formatstring</em>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj is as in strftime(3) from the C standard library.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>This directive has the same effect as the <code><--#config
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj timefmt=<em>formatstring</em> --></code> element.</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj directive</h2>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj on|off|full<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Default:</strong></a> <code>XBitHack
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Context:</strong></a> server config, virtual
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj host, directory, .htaccess<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj rel="Help"><strong>Override:</strong></a> Options<br />
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p>The XBitHack directives controls the parsing of ordinary
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj html documents. This directive only affects files associated
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj with the MIME type <code>text/html</code>. XBitHack can take on
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj the following values:</p>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <dd>Any text/html file that has the user-execute bit set will
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj be treated as a server-parsed html document.</dd>
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj As for <code>on</code> but also test the group-execute bit.
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj If it is set, then set the Last-modified date of the
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj returned file to be the last modified time of the file. If
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj it is not set, then no last-modified date is sent. Setting
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj this bit allows clients and proxies to cache the result of
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj the request.
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj <p><strong>Note:</strong> you would not want to use the full
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj option, unless you assure the group-execute bit is unset for
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj every SSI script which might <code>#include</code> a CGI
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj or otherwise produces different output on each hit (or could
2eeaed14a5e2ed9bd811643ad5bffc3510ca0310robj potentially change on subsequent requests).</p>