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 / F278311_mod_include.xml < prev    next >
Extensible Markup Language  |  2004-09-04  |  32KB  |  761 lines

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