diff options
Diffstat (limited to 'docs/manual/mod/mod_include.html.en')
| -rw-r--r-- | docs/manual/mod/mod_include.html.en | 85 |
1 files changed, 56 insertions, 29 deletions
diff --git a/docs/manual/mod/mod_include.html.en b/docs/manual/mod/mod_include.html.en index 3a70dd72..1b5ea74d 100644 --- a/docs/manual/mod/mod_include.html.en +++ b/docs/manual/mod/mod_include.html.en @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- +<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> +<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> +<!-- XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --> -<title>mod_include - Apache HTTP Server</title> +<title>mod_include - Apache HTTP Server Version 2.4</title> <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" /> @@ -17,7 +19,7 @@ <div id="page-header"> <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p> <p class="apache">Apache HTTP Server Version 2.4</p> -<img alt="" src="../images/feather.gif" /></div> +<img alt="" src="../images/feather.png" /></div> <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> <div id="path"> <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Modules</a></div> @@ -41,7 +43,16 @@ inclusion of other files or programs, as well as the setting and printing of environment variables.</p> </div> -<div id="quickview"><h3 class="directives">Directives</h3> +<div id="quickview"><h3>Topics</h3> +<ul id="topics"> +<li><img alt="" src="../images/down.gif" /> <a href="#enabling">Enabling Server-Side Includes</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#pathinfo">PATH_INFO with Server Side Includes</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#elements">Available Elements</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#includevars">Include Variables</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#substitution">Variable Substitution</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#flowctrl">Flow Control Elements</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#legacyexpr">Legacy expression syntax</a></li> +</ul><h3 class="directives">Directives</h3> <ul id="toc"> <li><img alt="" src="../images/down.gif" /> <a href="#ssiendtag">SSIEndTag</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#ssierrormsg">SSIErrorMsg</a></li> @@ -53,22 +64,13 @@ <li><img alt="" src="../images/down.gif" /> <a href="#ssiundefinedecho">SSIUndefinedEcho</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#xbithack">XBitHack</a></li> </ul> -<h3>Topics</h3> -<ul id="topics"> -<li><img alt="" src="../images/down.gif" /> <a href="#enabling">Enabling Server-Side Includes</a></li> -<li><img alt="" src="../images/down.gif" /> <a href="#pathinfo">PATH_INFO with Server Side Includes</a></li> -<li><img alt="" src="../images/down.gif" /> <a href="#elements">Available Elements</a></li> -<li><img alt="" src="../images/down.gif" /> <a href="#includevars">Include Variables</a></li> -<li><img alt="" src="../images/down.gif" /> <a href="#substitution">Variable Substitution</a></li> -<li><img alt="" src="../images/down.gif" /> <a href="#flowctrl">Flow Control Elements</a></li> -<li><img alt="" src="../images/down.gif" /> <a href="#legacyexpr">Legacy expression syntax</a></li> -</ul><h3>See also</h3> +<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_include">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_include">Report a bug</a></li></ul><h3>See also</h3> <ul class="seealso"> <li><code class="directive"><a href="../mod/core.html#options">Options</a></code></li> <li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li> <li><a href="../filter.html">Filters</a></li> <li><a href="../howto/ssi.html">SSI Tutorial</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +<li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="enabling" id="enabling">Enabling Server-Side Includes</a></h2> @@ -136,6 +138,8 @@ AddOutputFilter INCLUDES .shtml</pre> <table class="bordered"> <tr><th>Element</th><th>Description</th></tr> + <tr><td><code><a href="#element.comment">comment</a></code></td> + <td>SSI comment</td></tr> <tr><td><code><a href="#element.config">config</a></code></td> <td>configure output formats</td></tr> <tr><td><code><a href="#element.echo">echo</a></code></td> @@ -159,19 +163,29 @@ AddOutputFilter INCLUDES .shtml</pre> <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, and will only be available if this module is loaded.</p> + <h3><a name="element.comment" id="element.comment">The comment Element</a></h3> + <p>This command doesn't output anything. Its only use is to + add comments within a file. These comments are not printed.</p> + + <p>This syntax is available in version 2.4.21 and later.</p> + + <div class="example"><p><code> + <!--#comment Blah Blah Blah --> + </code></p></div> + + <h3><a name="element.config" id="element.config">The config Element</a></h3> <p>This command controls various aspects of the parsing. The valid attributes are:</p> <dl> <dt><code>echomsg</code> (<em>Apache 2.1 and later</em>)</dt> - <dd> - <p>The value is a message that is sent back to the + <dd><p>The value is a message that is sent back to the client if the <code><a href="#element.echo">echo</a></code> element attempts to echo an undefined variable. This overrides any <code class="directive"><a href="#ssiundefinedecho">SSIUndefinedEcho</a></code> directives.</p> <div class="example"><p><code> - <!--#config errmsg="[Value Undefined]" --> + <!--#config echomsg="[Value Undefined]" --> </code></p></div> </dd> @@ -179,7 +193,7 @@ AddOutputFilter INCLUDES .shtml</pre> <dd><p>The value is a message that is sent back to the client if an error occurs while parsing the document. This overrides any <code class="directive"><a href="#ssierrormsg">SSIErrorMsg</a></code> directives.</p> - + <div class="example"><p><code> <!--#config errmsg="[Oops, something broke.]" --> </code></p></div> @@ -195,19 +209,19 @@ AddOutputFilter INCLUDES .shtml</pre> <div class="example"><p><code> <!--#config sizefmt="abbrev" --> </code></p></div> + </dd> <dt><code>timefmt</code></dt> <dd><p>The value is a string to be used by the <code>strftime(3)</code> library routine when printing dates.</p> - + <div class="example"><p><code> <!--#config timefmt=""%R, %B %d, %Y"" --> </code></p></div> </dd> - </dl> @@ -360,7 +374,7 @@ AddOutputFilter INCLUDES .shtml</pre> </code></p></div> The value of <code>file</code> cannot start with a slash - (<code>/</code>), nor can it contain <code>../</code> so as to + (<code>/</code>), nor can it contain <code>../</code> so as to refer to a file above the current directory or outside of the document root. Attempting to so will result in the error message: <code>The given path was above the root path</code>. @@ -544,6 +558,16 @@ AddOutputFilter INCLUDES .shtml</pre> <dt><code>DATE_LOCAL</code></dt> <dd>The current date in the local time zone.</dd> + <dt><code>DOCUMENT_ARGS</code></dt> + <dd>This variable contains the query string of the active SSI + document, or the empty string if a query string is not + included. For subrequests invoked through the + <code>include</code> SSI directive, <code>QUERY_STRING</code> + will represent the query string of the subrequest and + <code>DOCUMENT_ARGS</code> will represent the query string of + the SSI document. (Available in Apache HTTP Server 2.4.19 and + later.)</dd> + <dt><code>DOCUMENT_NAME</code></dt> <dd>The filename (excluding directories) of the document requested by the user.</dd> @@ -560,10 +584,13 @@ AddOutputFilter INCLUDES .shtml</pre> the user.</dd> <dt><code>QUERY_STRING_UNESCAPED</code></dt> - <dd>If a query string is present, this variable contains the - (%-decoded) query string, which is <em>escaped</em> for shell - usage (special characters like <code>&</code> etc. are - preceded by backslashes).</dd> + <dd>If a query string is present in the request for the active + SSI document, this variable contains the (%-decoded) query + string, which is <em>escaped</em> for shell usage (special + characters like <code>&</code> etc. are preceded by + backslashes). It is not set if a query string is not + present. Use <code>DOCUMENT_ARGS</code> if shell escaping + is not desired.</dd> </dl> </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> @@ -970,8 +997,8 @@ server.</td></tr> output of a file each processing different commands (possibly at different times).</p> - <pre class="prettyprint lang-config"> SSIStartTag "<%"<br /> - SSIEndTag "%>"</pre> + <pre class="prettyprint lang-config">SSIStartTag "<%" +SSIEndTag "%>"</pre> <p>The example given above, which also specifies a matching @@ -1105,7 +1132,7 @@ var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_include.html } })(window, document); //--><!]]></script></div><div id="footer"> -<p class="apache">Copyright 2014 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> +<p class="apache">Copyright 2016 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- if (typeof(prettyPrint) !== 'undefined') { prettyPrint(); |