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