home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278065_mod_include.html.en < prev    next >
Extensible Markup Language  |  2004-09-04  |  40KB  |  776 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mod_include - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_include</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_include.html" title="English"> en </a> |
  25. <a href="../ja/mod/mod_include.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
  26. </div>
  27. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Server-parsed html documents (Server Side Includes)</td></tr>
  28. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  29. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>include_module</td></tr>
  30. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_include.c</td></tr>
  31. <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Implemented as an output filter since Apache
  32. 2.0</td></tr></table>
  33. <h3>Summary</h3>
  34.  
  35.     <p>This module provides a filter which will process files
  36.     before they are sent to the client. The processing is
  37.     controlled by specially formatted SGML comments, referred to as
  38.     <dfn>elements</dfn>. These elements allow conditional text, the
  39.     inclusion of other files or programs, as well as the setting and
  40.     printing of environment variables.</p>
  41. </div>
  42. <div id="quickview"><h3 class="directives">Directives</h3>
  43. <ul id="toc">
  44. <li><img alt="" src="../images/down.gif" /> <a href="#ssiendtag">SSIEndTag</a></li>
  45. <li><img alt="" src="../images/down.gif" /> <a href="#ssierrormsg">SSIErrorMsg</a></li>
  46. <li><img alt="" src="../images/down.gif" /> <a href="#ssistarttag">SSIStartTag</a></li>
  47. <li><img alt="" src="../images/down.gif" /> <a href="#ssitimeformat">SSITimeFormat</a></li>
  48. <li><img alt="" src="../images/down.gif" /> <a href="#ssiundefinedecho">SSIUndefinedEcho</a></li>
  49. <li><img alt="" src="../images/down.gif" /> <a href="#xbithack">XBitHack</a></li>
  50. </ul>
  51. <h3>Topics</h3>
  52. <ul id="topics">
  53. <li><img alt="" src="../images/down.gif" /> <a href="#enabling">Enabling Server-Side Includes</a></li>
  54. <li><img alt="" src="../images/down.gif" /> <a href="#pathinfo">PATH_INFO with Server Side Includes</a></li>
  55. <li><img alt="" src="../images/down.gif" /> <a href="#elements">Basic Elements</a></li>
  56. <li><img alt="" src="../images/down.gif" /> <a href="#includevars">Include Variables</a></li>
  57. <li><img alt="" src="../images/down.gif" /> <a href="#substitution">Variable Substitution</a></li>
  58. <li><img alt="" src="../images/down.gif" /> <a href="#flowctrl">Flow Control Elements</a></li>
  59. </ul><h3>See also</h3>
  60. <ul class="seealso">
  61. <li><code class="directive"><a href="../mod/core.html#options">Options</a></code></li>
  62. <li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li>
  63. <li><a href="../misc/custom_errordocs.html">International Customized
  64. Server Error Messages</a></li>
  65. <li><a href="../filter.html">Filters</a></li>
  66. <li><a href="../howto/ssi.html">SSI Tutorial</a></li>
  67. </ul></div>
  68. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  69. <div class="section">
  70. <h2><a name="enabling" id="enabling">Enabling Server-Side Includes</a></h2>
  71.     
  72.  
  73.     <p>Server Side Includes are implemented by the
  74.     <code>INCLUDES</code> <a href="../filter.html">filter</a>. If
  75.     documents containing server-side include directives are given
  76.     the extension .shtml, the following directives will make Apache
  77.     parse them and assign the resulting document the mime type of
  78.     <code>text/html</code>:</p>
  79.  
  80.     <div class="example"><p><code>
  81.       AddType text/html .shtml<br />
  82.       AddOutputFilter INCLUDES .shtml
  83.     </code></p></div>
  84.  
  85.     <p>The following directive must be given for the directories
  86.     containing the shtml files (typically in a
  87.     <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> section,
  88.     but this directive is also valid in <code>.htaccess</code> files if
  89.     <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> <code>Options</code>
  90.     is set):</p>
  91.  
  92.     <div class="example"><p><code>
  93.       Options +Includes
  94.     </code></p></div>
  95.  
  96.     <p>For backwards compatibility, the <code>server-parsed</code>
  97.     <a href="../handler.html">handler</a> also activates the
  98.     INCLUDES filter. As well, Apache will activate the INCLUDES
  99.     filter for any document with mime type
  100.     <code>text/x-server-parsed-html</code> or
  101.     <code>text/x-server-parsed-html3</code> (and the resulting
  102.     output will have the mime type <code>text/html</code>).</p>
  103.  
  104.     <p>For more information, see our <a href="../howto/ssi.html">Tutorial on Server Side Includes</a>.</p>
  105. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  106. <div class="section">
  107. <h2><a name="pathinfo" id="pathinfo">PATH_INFO with Server Side Includes</a></h2>
  108.     
  109.  
  110.     <p>Files processed for server-side includes no longer accept
  111.     requests with <code>PATH_INFO</code> (trailing pathname information)
  112.     by default.  You can use the <code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code> directive to
  113.     configure the server to accept requests with <code>PATH_INFO</code>.</p>
  114. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  115. <div class="section">
  116. <h2><a name="elements" id="elements">Basic Elements</a></h2>
  117.     <p>The document is parsed as an HTML document, with special
  118.     commands embedded as SGML comments. A command has the syntax: </p>
  119.  
  120.     <div class="example"><p><code>
  121.       <!--#<var>element</var> <var>attribute</var>=<var>value</var>
  122.       <var>attribute</var>=<var>value</var> ... -->
  123.     </code></p></div>
  124.  
  125.     <p>The value will often be enclosed in double quotes, but single
  126.     quotes (<code>'</code>) and backticks (<code>`</code>) are also
  127.     possible. Many commands only allow a single attribute-value pair.
  128.     Note that the comment terminator (<code>--></code>) should be
  129.     preceded by whitespace to ensure that it isn't considered part of
  130.     an SSI token. Note that the leading <code><!--#</code> is <em>one</em>
  131.     token and may not contain any whitespaces.</p>
  132.  
  133.     <p>The allowed elements are listed in the following table:</p>
  134.  
  135.     <table class="bordered">
  136.     <tr><th>Element</th><th>Description</th></tr>
  137.     <tr><td><code><a href="#element.config">config</a></code></td>
  138.         <td>configure output formats</td></tr>
  139.     <tr><td><code><a href="#element.echo">echo</a></code></td>
  140.         <td>print variables</td></tr>
  141.     <tr><td><code><a href="#element.exec">exec</a></code></td>
  142.         <td>execute external programs</td></tr>
  143.     <tr><td><code><a href="#element.fsize">fsize</a></code></td>
  144.         <td>print size of a file</td></tr>
  145.     <tr><td><code><a href="#element.flastmod">flastmod</a></code></td>
  146.         <td>print last modification time of a file</td></tr>
  147.     <tr><td><code><a href="#element.include">include</a></code></td>
  148.         <td>include a file</td></tr>
  149.     <tr><td><code><a href="#element.printenv">printenv</a></code></td>
  150.         <td>print all available variables</td></tr>
  151.     <tr><td><code><a href="#element.set">set</a></code></td>
  152.         <td>set a value of a variable</td></tr>
  153.     </table>
  154.  
  155.     <p>SSI elements may be defined by modules other than
  156.     <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>. In fact, the <code><a href="#element.exec">exec</a></code> element is provided by
  157.     <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, and will only be available if this
  158.     module is loaded.</p>
  159.  
  160.     <h3><a name="element.config" id="element.config">The config Element</a></h3>
  161.       <p>This command controls various aspects of the parsing. The
  162.       valid attributes are:</p>
  163.  
  164.       <dl>
  165.       <dt><code>errmsg</code></dt>
  166.       <dd>The value is a message that is sent back to the
  167.       client if an error occurs while parsing the
  168.       document. This overrides any <code class="directive"><a href="#ssierrormsg">SSIErrorMsg</a></code> directives.</dd>
  169.  
  170.       <dt><code>sizefmt</code></dt>
  171.       <dd>The value sets the format to be used which displaying
  172.       the size of a file. Valid values are <code>bytes</code>
  173.       for a count in bytes, or <code>abbrev</code> for a count
  174.       in Kb or Mb as appropriate, for example a size of 1024 bytes
  175.       will be printed as "1K".</dd>
  176.  
  177.       <dt><code>timefmt</code></dt>
  178.       <dd>The value is a string to be used by the
  179.       <code>strftime(3)</code> library routine when printing
  180.       dates.</dd>
  181.       </dl>
  182.      
  183.  
  184.     <h3><a name="element.echo" id="element.echo">The echo Element</a></h3>
  185.       <p>This command prints one of the <a href="#includevars">include
  186.       variables</a>, defined below. If the variable is unset, the result is
  187.       determined by the <code class="directive"><a href="#ssiundefinedecho">SSIUndefinedEcho</a></code> directive. Any dates printed are
  188.       subject to the currently configured <code>timefmt</code>.</p>
  189.  
  190.       <p>Attributes:</p> 
  191.  
  192.       <dl>
  193.       <dt><code>var</code></dt>
  194.       <dd>The value is the name of the variable to print.</dd>
  195.  
  196.       <dt><code>encoding</code></dt>
  197.       <dd><p>Specifies how Apache should encode special characters
  198.       contained in the variable before outputting them. If set
  199.       to <code>none</code>, no encoding will be done. If set to
  200.       <code>url</code>, then URL encoding (also known as %-encoding;
  201.       this is appropriate for use within URLs in links, etc.) will be
  202.       performed. At the start of an <code>echo</code> element,
  203.       the default is set to <code>entity</code>, resulting in entity
  204.       encoding (which is appropriate in the context of a block-level
  205.       HTML element, <em>e.g.</em> a paragraph of text). This can be
  206.       changed by adding an <code>encoding</code> attribute, which will
  207.       remain in effect until the next <code>encoding</code> attribute
  208.       is encountered or the element ends, whichever comes first.</p>
  209.  
  210.       <p>The <code>encoding</code> attribute must <em>precede</em> the
  211.       corresponding <code>var</code> attribute to be effective, and 
  212.       only special characters as defined in the ISO-8859-1 character
  213.       encoding will be encoded. This encoding process may not have the
  214.       desired result if a different character encoding is in use.</p>
  215.  
  216.       <div class="warning">
  217.         In order to avoid cross-site scripting issues, you should
  218.         <em>always</em> encode user supplied data.
  219.       </div>
  220.       </dd>
  221.       </dl>
  222.      
  223.  
  224.     <h3><a name="element.exec" id="element.exec">The exec Element</a></h3>
  225.       <p>The <code>exec</code> command executes a given shell command or
  226.       CGI script. It requires <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> to be present
  227.       in the server. If <code class="directive"><a href="../mod/core.html#options">Options</a></code>
  228.       <code>IncludesNOEXEC</code> is set, this command is completely
  229.       disabled. The valid attributes are:</p>
  230.  
  231.       <dl>
  232.       <dt><code>cgi</code></dt>
  233.       <dd><p>The value specifies a (%-encoded) URL-path to
  234.       the CGI script. If the path does not begin with a slash (/),
  235.       then it is taken to be relative to the current
  236.       document. The document referenced by this path is
  237.       invoked as a CGI script, even if the server would not
  238.       normally recognize it as such. However, the directory
  239.       containing the script must be enabled for CGI scripts
  240.       (with <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>
  241.       or <code class="directive"><a href="../mod/core.html#options">Options</a></code>
  242.       <code>ExecCGI</code>).</p>
  243.  
  244.       <p>The CGI script is given the <code>PATH_INFO</code> and query
  245.       string (<code>QUERY_STRING</code>) of the original request from the
  246.       client; these <em>cannot</em> be specified in the URL path. The
  247.       include variables will be available to the script in addition to
  248.       the standard <a href="mod_cgi.html">CGI</a> environment.</p>
  249.  
  250.       <div class="example"><h3>Example</h3><p><code>
  251.         <!--#exec cgi="/cgi-bin/example.cgi" -->
  252.       </code></p></div>
  253.  
  254.       <p>If the script returns a <code>Location:</code> header instead of
  255.       output, then this will be translated into an HTML anchor.</p>
  256.  
  257.       <p>The <code><a href="#includevirtual">include virtual</a></code>
  258.       element should be used in preference to <code>exec cgi</code>. In
  259.       particular, if you need to pass additional arguments to a CGI program,
  260.       using the query string, this cannot be done with <code>exec
  261.       cgi</code>, but can be done with <code>include virtual</code>, as
  262.       shown here:</p>
  263.  
  264.       <div class="example"><p><code>
  265.         <!--#include virtual="/cgi-bin/example.cgi?argument=value" -->
  266.       </code></p></div>
  267.       </dd>
  268.  
  269.       <dt><code>cmd</code></dt>
  270.       <dd><p>The server will execute the given string using
  271.       <code>/bin/sh</code>. The <a href="#includevars">include variables</a> are available to the command, in addition
  272.       to the usual set of CGI variables.</p>
  273.  
  274.       <p>The use of <code><a href="#includevirtual">#include virtual</a></code> is almost always prefered to using
  275.       either <code>#exec cgi</code> or <code>#exec cmd</code>. The former
  276.       (<code>#include virtual</code>) uses the standard Apache sub-request
  277.       mechanism to include files or scripts. It is much better tested and
  278.       maintained.</p>
  279.  
  280.       <p>In addition, on some platforms, like Win32, and on unix when
  281.       using <a href="../suexec.html">suexec</a>, you cannot pass arguments
  282.       to a command in an <code>exec</code> directive, or otherwise include
  283.       spaces in the command. Thus, while the following will work under a
  284.       non-suexec configuration on unix, it will not produce the desired
  285.       result under Win32, or when running suexec:</p>
  286.  
  287.       <div class="example"><p><code>
  288.         <!--#exec cmd="perl /path/to/perlscript arg1 arg2" -->
  289.       </code></p></div>
  290.       </dd>
  291.       </dl>
  292.      
  293.  
  294.     <h3><a name="element.fsize" id="element.fsize">The fsize Element</a></h3>
  295.       <p>This command prints the size of the specified file, subject
  296.       to the <code>sizefmt</code> format specification. Attributes:</p>
  297.  
  298.       <dl>
  299.       <dt><code>file</code></dt>
  300.       <dd>The value is a path relative to the directory
  301.       containing the current document being parsed.</dd>
  302.  
  303.       <dt><code>virtual</code></dt>
  304.       <dd>The value is a (%-encoded) URL-path. If it does not begin with
  305.       a slash (/) then it is taken to be relative to the current document.
  306.       Note, that this does <em>not</em> print the size of any CGI output,
  307.       but the size of the CGI script itself.</dd>
  308.       </dl>
  309.      
  310.  
  311.     <h3><a name="element.flastmod" id="element.flastmod">The flastmod Element</a></h3>
  312.       <p>This command prints the last modification date of the
  313.       specified file, subject to the <code>timefmt</code> format
  314.       specification. The attributes are the same as for the
  315.       <code><a href="#element.fsize">fsize</a></code> command.</p>
  316.      
  317.  
  318.     <h3><a name="element.include" id="element.include">The include Element</a></h3>
  319.       <p>This command inserts the text of another document or file
  320.       into the parsed file. Any included file is subject to the
  321.       usual access control. If the directory containing the
  322.       parsed file has <a href="core.html#options">Options</a>
  323.       <code>IncludesNOEXEC</code> set, then only documents with
  324.       a text MIME type (<code>text/plain</code>, <code>text/html</code>
  325.       etc.) will be included. Otherwise CGI scripts are invoked as normal
  326.       using the complete URL given in the command, including any query
  327.       string.</p>
  328.  
  329.       <p>An attribute defines the location of the document; the
  330.       inclusion is done for each attribute given to the include
  331.       command. The valid attributes are:</p>
  332.  
  333.       <dl>
  334.       <dt><code>file</code></dt>
  335.       <dd>The value is a path relative to the directory
  336.       containing the current document being parsed. It cannot
  337.       contain <code>../</code>, nor can it be an absolute path.
  338.       Therefore, you cannot include files that are outside of the
  339.       document root, or above the current document in the directory
  340.       structure. The <code>virtual</code> attribute should always be
  341.       used in preference to this one.</dd>
  342.  
  343.       <dt><code><a id="includevirtual" name="includevirtual">virtual</a></code></dt>
  344.       <dd><p>The value is a (%-encoded) URL-path. The URL cannot contain a
  345.       scheme or hostname, only a path and an optional query string. If it
  346.       does not begin with a slash (/) then it is taken to be relative to the
  347.       current document.</p>
  348.  
  349.       <p>A URL is constructed from the attribute, and the output the
  350.       server would return if the URL were accessed by the client is
  351.       included in the parsed output. Thus included files can be nested.</p>
  352.  
  353.       <p>If the specified URL is a CGI program, the program will be
  354.       executed and its output inserted in place of the directive in the
  355.       parsed file. You may include a query string in a CGI url:</p>
  356.      
  357.       <div class="example"><p><code>
  358.         <!--#include virtual="/cgi-bin/example.cgi?argument=value" -->
  359.       </code></p></div>
  360.            
  361.       <p><code>include virtual</code> should be used in preference
  362.       to <code>exec cgi</code> to include the output of CGI programs
  363.       into an HTML document.</p>
  364.       </dd>
  365.       </dl>
  366.      
  367.  
  368.     <h3><a name="element.printenv" id="element.printenv">The printenv Element</a></h3>
  369.       <p>This prints out a listing of all existing variables and
  370.       their values. Special characters are entity encoded (see the <code><a href="#element.echo">echo</a></code> element for details)
  371.       before being output. There are no attributes.</p>
  372.  
  373.       <div class="example"><h3>Example</h3><p><code>
  374.         <!--#printenv -->
  375.       </code></p></div>
  376.      
  377.  
  378.     <h3><a name="element.set" id="element.set">The set Element</a></h3>
  379.       <p>This sets the value of a variable. Attributes:</p>
  380.  
  381.       <dl>
  382.       <dt><code>var</code></dt>
  383.       <dd>The name of the variable to set.</dd>
  384.  
  385.       <dt><code>value</code></dt>
  386.       <dd>The value to give a variable.</dd>
  387.       </dl>
  388.  
  389.       <div class="example"><h3>Example</h3><p><code>
  390.         <!--#set var="category" value="help" -->
  391.       </code></p></div>
  392.      
  393. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  394. <div class="section">
  395. <h2><a name="includevars" id="includevars">Include Variables</a></h2>
  396.     
  397.  
  398.     <p>In addition to the variables in the standard CGI environment,
  399.     these are available for the <code>echo</code> command, for
  400.     <code>if</code> and <code>elif</code>, and to any program
  401.     invoked by the document.</p>
  402.  
  403.     <dl>
  404.       <dt><code>DATE_GMT</code></dt>
  405.       <dd>The current date in Greenwich Mean Time.</dd>
  406.  
  407.       <dt><code>DATE_LOCAL</code></dt>
  408.       <dd>The current date in the local time zone.</dd>
  409.  
  410.       <dt><code>DOCUMENT_NAME</code></dt>
  411.       <dd>The filename (excluding directories) of the document
  412.       requested by the user.</dd>
  413.  
  414.       <dt><code>DOCUMENT_URI</code></dt>
  415.       <dd>The (%-decoded) URL path of the document requested by the
  416.       user. Note that in the case of nested include files, this is
  417.       <em>not</em> the URL for the current document.</dd>
  418.  
  419.       <dt><code>LAST_MODIFIED</code></dt>
  420.       <dd>The last modification date of the document requested by
  421.       the user.</dd>
  422.  
  423.       <dt><code>QUERY_STRING_UNESCAPED</code></dt>
  424.       <dd>If a query string is present, this variable contains the
  425.       (%-decoded) query string, which is <em>escaped</em> for shell
  426.       usage (special characters like <code>&</code> etc. are
  427.       preceded by backslashes).</dd>
  428.     </dl>
  429. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  430. <div class="section">
  431. <h2><a name="substitution" id="substitution">Variable Substitution</a></h2>
  432.  
  433.     <p>Variable substitution is done within quoted strings in most
  434.     cases where they may reasonably occur as an argument to an SSI
  435.     directive. This includes the <code>config</code>,
  436.     <code>exec</code>, <code>flastmod</code>, <code>fsize</code>,
  437.     <code>include</code>, <code>echo</code>, and <code>set</code>
  438.     directives, as well as the arguments to conditional operators.
  439.     You can insert a literal dollar sign into the string using backslash
  440.     quoting:</p>
  441.  
  442.     <div class="example"><p><code>
  443.       <!--#if expr="$a = \$test" -->
  444.     </code></p></div>
  445.  
  446.     <p>If a variable reference needs to be substituted in the
  447.     middle of a character sequence that might otherwise be
  448.     considered a valid identifier in its own right, it can be
  449.     disambiguated by enclosing the reference in braces,
  450.     <em>a la</em> shell substitution:</p>
  451.  
  452.     <div class="example"><p><code>
  453.       <!--#set var="Zed" value="${REMOTE_HOST}_${REQUEST_METHOD}" -->
  454.     </code></p></div>
  455.  
  456.     <p>This will result in the <code>Zed</code> variable being set
  457.     to "<code>X_Y</code>" if <code>REMOTE_HOST</code> is
  458.     "<code>X</code>" and <code>REQUEST_METHOD</code> is
  459.     "<code>Y</code>".</p>
  460.  
  461.     <p>The below example will print "in foo" if the
  462.     <code>DOCUMENT_URI</code> is <code>/foo/file.html</code>, "in bar"
  463.     if it is <code>/bar/file.html</code> and "in neither" otherwise:</p>
  464.  
  465.     <div class="example"><p><code>
  466.       <!--#if expr='"$DOCUMENT_URI" = "/foo/file.html"' --><br />
  467.       <span class="indent">
  468.         in foo<br />
  469.       </span>
  470.       <!--#elif expr='"$DOCUMENT_URI" = "/bar/file.html"' --><br />
  471.       <span class="indent">
  472.         in bar<br />
  473.       </span>
  474.       <!--#else --><br />
  475.       <span class="indent">
  476.         in neither<br />
  477.       </span>
  478.       <!--#endif -->
  479.     </code></p></div>
  480. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  481. <div class="section">
  482. <h2><a name="flowctrl" id="flowctrl">Flow Control Elements</a></h2>
  483.     
  484.  
  485.     <p>The basic flow control elements are:</p>
  486.  
  487.     <div class="example"><p><code>
  488.       <!--#if expr="<var>test_condition</var>" --><br />
  489.       <!--#elif expr="<var>test_condition</var>" --><br />
  490.       <!--#else --><br />
  491.       <!--#endif -->
  492.     </code></p></div>
  493.  
  494.     <p>The <code>if</code> element works like an if statement in a
  495.     programming language. The test condition is evaluated and if
  496.     the result is true, then the text until the next <code>elif</code>,
  497.     <code>else</code> or <code>endif</code> element is included in the
  498.     output stream.</p>
  499.  
  500.     <p>The <code>elif</code> or <code>else</code> statements are be used
  501.     to put text into the output stream if the original
  502.     <var>test_condition</var> was false. These elements are optional.</p>
  503.  
  504.     <p>The <code>endif</code> element ends the <code>if</code> element
  505.     and is required.</p>
  506.  
  507.     <p><var>test_condition</var> is one of the following:</p>
  508.  
  509.     <dl>
  510.       <dt><code><var>string</var></code></dt>
  511.       <dd>true if <var>string</var> is not empty</dd>
  512.  
  513.       <dt><code><var>string1</var> = <var>string2</var><br />
  514.       <var>string1</var> != <var>string2</var></code></dt>
  515.       
  516.       <dd><p>Compare <var>string1</var> with <var>string2</var>. If
  517.       <var>string2</var> has the form <code>/<var>string2</var>/</code>
  518.       then it is treated as a regular expression. Regular expressions are
  519.       implemented by the <a href="http://www.pcre.org">PCRE</a> engine and
  520.       have the same syntax as those in <a href="http://www.perl.com">perl
  521.       5</a>.</p>
  522.  
  523.       <p>If you are matching positive (<code>=</code>), you can capture
  524.       grouped parts of the regular expression. The captured parts are
  525.       stored in the special variables <code>$1</code> ..
  526.       <code>$9</code>.</p>
  527.  
  528.       <div class="example"><h3>Example</h3><p><code>
  529.         <!--#if expr="$QUERY_STRING = /^sid=([a-zA-Z0-9]+)/" --><br />
  530.         <span class="indent">
  531.           <!--#set var="session" value="$1" --><br />
  532.         </span>
  533.         <!--#endif -->
  534.       </code></p></div>
  535.       </dd>
  536.  
  537.       <dt><code><var>string1</var> < <var>string2</var><br />
  538.        <var>string1</var> <= <var>string2</var><br />
  539.        <var>string1</var> > <var>string2</var><br />
  540.        <var>string1</var> >= <var>string2</var></code></dt>
  541.  
  542.       <dd>Compare <var>string1</var> with <var>string2</var>. Note, that
  543.       strings are compared <em>literally</em> (using
  544.       <code>strcmp(3)</code>). Therefore the string "100" is less than
  545.       "20".</dd>
  546.  
  547.       <dt><code>( <var>test_condition</var> )</code></dt>
  548.       <dd>true if <var>test_condition</var> is true</dd>
  549.  
  550.       <dt><code>! <var>test_condition</var></code></dt>
  551.       <dd>true if <var>test_condition</var> is false</dd>
  552.  
  553.       <dt><code><var>test_condition1</var> &&
  554.         <var>test_condition2</var></code></dt>
  555.       <dd>true if both <var>test_condition1</var> and
  556.       <var>test_condition2</var> are true</dd>
  557.  
  558.       <dt><code><var>test_condition1</var> ||
  559.         <var>test_condition2</var></code></dt>
  560.       <dd>true if either <var>test_condition1</var> or
  561.       <var>test_condition2</var> is true</dd>
  562.     </dl>
  563.  
  564.     <p>"<code>=</code>" and "<code>!=</code>" bind more tightly than
  565.     "<code>&&</code>" and "<code>||</code>". "<code>!</code>" binds
  566.     most tightly. Thus, the following are equivalent:</p>
  567.  
  568.     <div class="example"><p><code>
  569.       <!--#if expr="$a = test1 && $b = test2" --><br />
  570.       <!--#if expr="($a = test1) && ($b = test2)" -->
  571.     </code></p></div>
  572.  
  573.     <p>The boolean operators <code>&&</code> and <code>||</code>
  574.     share the same priority. So if you want to bind such an operator more
  575.     tightly, you should use parentheses.</p>
  576.  
  577.     <p>Anything that's not recognized as a variable or an operator
  578.     is treated as a string. Strings can also be quoted:
  579.     <code>'string'</code>. Unquoted strings can't contain whitespace
  580.     (blanks and tabs) because it is used to separate tokens such as
  581.     variables. If multiple strings are found in a row, they are
  582.     concatenated using blanks. So,</p>
  583.  
  584.     <div class="example"><p><code><var>string1</var>    <var>string2</var></code> results in <code><var>string1</var> <var>string2</var></code><br />
  585.       <br />
  586.       and<br />
  587.       <br />
  588.       <code>'<var>string1</var>    <var>string2</var>'</code> results in <code><var>string1</var>    <var>string2</var></code>.</p></div>
  589. </div>
  590. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  591. <div class="directive-section"><h2><a name="SSIEndTag" id="SSIEndTag">SSIEndTag</a> <a name="ssiendtag" id="ssiendtag">Directive</a></h2>
  592. <table class="directive">
  593. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>String that ends an include element</td></tr>
  594. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSIEndTag <var>tag</var></code></td></tr>
  595. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSIEndTag "-->"</code></td></tr>
  596. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  597. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  598. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_include</td></tr>
  599. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.30 and later.</td></tr>
  600. </table>
  601.     <p>This directive changes the string that <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
  602.     looks for to mark the end of an include element.</p>
  603.  
  604.     <div class="example"><h3>Example</h3><p><code>
  605.       SSIEndTag "%>"
  606.     </code></p></div>
  607.  
  608.  
  609. <h3>See also</h3>
  610. <ul>
  611. <li><code class="directive"><a href="#ssistarttag">SSIStartTag</a></code></li>
  612. </ul>
  613. </div>
  614. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  615. <div class="directive-section"><h2><a name="SSIErrorMsg" id="SSIErrorMsg">SSIErrorMsg</a> <a name="ssierrormsg" id="ssierrormsg">Directive</a></h2>
  616. <table class="directive">
  617. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Error message displayed when there is an SSI
  618. error</td></tr>
  619. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSIErrorMsg <var>message</var></code></td></tr>
  620. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSIErrorMsg "[an error occurred while processing this
  621. directive]"</code></td></tr>
  622. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  623. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
  624. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  625. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_include</td></tr>
  626. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.30 and later.</td></tr>
  627. </table>
  628.     <p>The <code class="directive">SSIErrorMsg</code> directive changes the error
  629.     message displayed when <code class="module"><a href="../mod/mod_include.html">mod_include</a></code> encounters an
  630.     error. For production servers you may consider changing the default
  631.     error message to <code>"<!-- Error -->"</code> so that
  632.     the message is not presented to the user.</p>
  633.  
  634.     <p>This directive has the same effect as the <code><!--#config
  635.     errmsg=<var>message</var> --></code> element.</p>
  636.  
  637.     <div class="example"><h3>Example</h3><p><code>
  638.       SSIErrorMsg "<!-- Error -->"
  639.     </code></p></div>
  640.  
  641. </div>
  642. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  643. <div class="directive-section"><h2><a name="SSIStartTag" id="SSIStartTag">SSIStartTag</a> <a name="ssistarttag" id="ssistarttag">Directive</a></h2>
  644. <table class="directive">
  645. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>String that starts an include element</td></tr>
  646. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSIStartTag <var>tag</var></code></td></tr>
  647. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSIStartTag "<!--#"</code></td></tr>
  648. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  649. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  650. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_include</td></tr>
  651. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.30 and later.</td></tr>
  652. </table>
  653.     <p>This directive changes the string that <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
  654.     looks for to mark an include element to process.</p>
  655.  
  656.     <p>You may want to use this option if you have 2 servers parsing the
  657.     output of a file each processing different commands (possibly at
  658.     different times).</p> 
  659.  
  660.     <div class="example"><h3>Example</h3><p><code>
  661.       SSIStartTag "<%"<br />
  662.       SSIEndTag   "%>"
  663.     </code></p></div>
  664.  
  665.     <p>The example given above, which also specifies a matching
  666.     <code class="directive"><a href="#ssiendtag">SSIEndTag</a></code>, will 
  667.     allow you to use SSI directives as shown in the example 
  668.     below:</p>
  669.  
  670.     <div class="example"><h3>SSI directives with alternate start and end tags</h3><p><code>
  671.       <%printenv %>
  672.     </code></p></div>
  673.  
  674. <h3>See also</h3>
  675. <ul>
  676. <li><code class="directive"><a href="#ssiendtag">SSIEndTag</a></code></li>
  677. </ul>
  678. </div>
  679. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  680. <div class="directive-section"><h2><a name="SSITimeFormat" id="SSITimeFormat">SSITimeFormat</a> <a name="ssitimeformat" id="ssitimeformat">Directive</a></h2>
  681. <table class="directive">
  682. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the format in which date strings are
  683. displayed</td></tr>
  684. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSITimeFormat <var>formatstring</var></code></td></tr>
  685. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSITimeFormat "%A, %d-%b-%Y %H:%M:%S %Z"</code></td></tr>
  686. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  687. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
  688. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  689. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_include</td></tr>
  690. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.30 and later.</td></tr>
  691. </table>
  692. <p>This directive changes the format in which date strings are displayed 
  693.     when echoing <code>DATE</code> environment variables. The
  694.     <var>formatstring</var> is as in <code>strftime(3)</code> from the
  695.     C standard library.</p>
  696.  
  697.     <p>This directive has the same effect as the <code><!--#config
  698.     timefmt=<var>formatstring</var> --></code> element.</p>
  699.  
  700.     <div class="example"><h3>Example</h3><p><code>
  701.       SSITimeFormat "%R, %B %d, %Y"
  702.     </code></p></div>
  703.  
  704.     <p>The above directive would cause times to be displayed in the
  705.     format "22:26, June 14, 2002".</p>
  706.  
  707. </div>
  708. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  709. <div class="directive-section"><h2><a name="SSIUndefinedEcho" id="SSIUndefinedEcho">SSIUndefinedEcho</a> <a name="ssiundefinedecho" id="ssiundefinedecho">Directive</a></h2>
  710. <table class="directive">
  711. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>String displayed when an unset variable is echoed</td></tr>
  712. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSIUndefinedEcho <var>string</var></code></td></tr>
  713. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSIUndefinedEcho "(none)"</code></td></tr>
  714. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  715. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  716. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_include</td></tr>
  717. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.34 and later.</td></tr>
  718. </table>
  719.     <p>This directive changes the string that <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
  720.     displays when a variable is not set and "echoed".</p>
  721.  
  722.     <div class="example"><h3>Example</h3><p><code>
  723.       SSIUndefinedEcho "<!-- undef -->"
  724.     </code></p></div>
  725.  
  726. </div>
  727. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  728. <div class="directive-section"><h2><a name="XBitHack" id="XBitHack">XBitHack</a> <a name="xbithack" id="xbithack">Directive</a></h2>
  729. <table class="directive">
  730. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Parse SSI directives in files with the execute bit
  731. set</td></tr>
  732. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>XBitHack on|off|full</code></td></tr>
  733. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>XBitHack off</code></td></tr>
  734. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  735. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
  736. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  737. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_include</td></tr>
  738. </table>
  739.     <p>The <code class="directive">XBitHack</code> directive controls the parsing
  740.     of ordinary html documents. This directive only affects files associated
  741.     with the MIME type <code>text/html</code>. <code class="directive">XBitHack</code> can take on the following values:</p>
  742.  
  743.     <dl>
  744.       <dt><code>off</code></dt>
  745.       <dd>No special treatment of executable files.</dd>
  746.  
  747.       <dt><code>on</code></dt>
  748.       <dd>Any <code>text/html</code> file that has the user-execute bit
  749.       set will be treated as a server-parsed html document.</dd>
  750.  
  751.       <dt><code>full</code></dt>
  752.       <dd>As for <code>on</code> but also test the group-execute bit.
  753.       If it is set, then set the <code>Last-modified</code> date of the
  754.       returned file to be the last modified time of the file. If
  755.       it is not set, then no last-modified date is sent. Setting
  756.       this bit allows clients and proxies to cache the result of
  757.       the request. 
  758.  
  759.       <div class="note"><h3>Note</h3>
  760.       <p>You would not want to use the full option, unless you assure the
  761.       group-execute bit is unset for every SSI script which might <code>#include</code> a CGI or otherwise produces different output on
  762.       each hit (or could potentially change on subsequent requests).</p>
  763.       </div>
  764.       </dd>
  765.     </dl>
  766.  
  767.     
  768. </div>
  769. </div>
  770. <div class="bottomlang">
  771. <p><span>Available Languages: </span><a href="../en/mod/mod_include.html" title="English"> en </a> |
  772. <a href="../ja/mod/mod_include.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
  773. </div><div id="footer">
  774. <p class="apache">Copyright 1999-2004 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>
  775. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  776. </body></html>