From: Igor Galić <igalic@apache.org>
Date: Sat, 20 Nov 2010 21:47:53 +0000 (+0000)
Subject: Adding SetEnvIfExpr documentation, and more references to expr.html
X-Git-Tag: 2.3.9~16
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2faa163a27b299a52333249e49983b6385ff4faf;p=apache

Adding SetEnvIfExpr documentation, and more references to expr.html

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1037339 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/expr.xml b/docs/manual/expr.xml
index b3ef8e9305..4a86f5acc6 100644
--- a/docs/manual/expr.xml
+++ b/docs/manual/expr.xml
@@ -22,7 +22,7 @@
 
 <manualpage metafile="expr.xml.meta">
 
-  <title>Expressions in Apache</title>
+  <title>Expressions in Apache HTTP Server</title>
 
   <summary>
     <p>Historically, there are several syntax variants for expressions used to express
@@ -299,7 +299,7 @@ listfunction ::= listfuncname "<strong>(</strong>" word "<strong>)</strong>"
     <tr><td><code>note</code></td>
         <td>Lookup request environment variable</td></tr>
     <tr><td><code>env</code></td>
-        <td>Reqturn first match of <code>note</code>, <code>reqenv</code>,
+        <td>Return first match of <code>note</code>, <code>reqenv</code>,
             <code>osenv</code></td></tr>
     <tr><td><code>tolower</code></td>
         <td>Convert string to lower case</td></tr>
diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml
index 57838f24cb..33a955bc86 100644
--- a/docs/manual/mod/core.xml
+++ b/docs/manual/mod/core.xml
@@ -1594,6 +1594,8 @@ satisfied by a request at runtime</description>
 
 </usage>
 
+<seealso><a href="../expr.html">Expressions in Apache HTTP Server</a>,
+for a complete reference and more examples.</seealso>
 <seealso><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
     &lt;Files&gt; sections work</a> for an explanation of how these
     different sections are combined when a request is received.
diff --git a/docs/manual/mod/mod_filter.xml b/docs/manual/mod/mod_filter.xml
index 2a9880d79d..9e6ccf46b9 100644
--- a/docs/manual/mod/mod_filter.xml
+++ b/docs/manual/mod/mod_filter.xml
@@ -359,10 +359,13 @@
     <code>ap_register_output_filter</code>.
     </p>
 
-    <p><var>expression</var> is described in the
+    <p><var>expression</var> is an
     <a href="../expr.html">ap_expr documentation</a>.</p>
 
 </usage>
+<seealso><a href="../expr.html">Expressions in Apache HTTP Server</a>,
+for a complete reference and examples.</seealso>
+<seealso><module>mod_include</module></seealso>
 </directivesynopsis>
 
 <directivesynopsis>
diff --git a/docs/manual/mod/mod_include.xml b/docs/manual/mod/mod_include.xml
index f843718a77..c817ae7b6f 100644
--- a/docs/manual/mod/mod_include.xml
+++ b/docs/manual/mod/mod_include.xml
@@ -712,6 +712,11 @@
      <p>All slashes which are not intended to act as delimiters in your regex must
      be escaped.  This is regardless of their meaning to the regex engine.</p>
     </note>
+
+    <note><title>Reference Documentation</title>
+    <p>See also: <a href="../expr.html">Expressions in Apache HTTP Server</a>,
+    for a complete reference and examples.</p>
+    </note>
 </section>
 
 <directivesynopsis>
diff --git a/docs/manual/mod/mod_setenvif.xml b/docs/manual/mod/mod_setenvif.xml
index 6c0c92a9d9..ef639a0a2c 100644
--- a/docs/manual/mod/mod_setenvif.xml
+++ b/docs/manual/mod/mod_setenvif.xml
@@ -254,6 +254,49 @@ for additional examples.
 </seealso>
 </directivesynopsis>
 
+
+<directivesynopsis>
+
+<name>SetEnvIfExpr</name>
+<description>Sets environment variables based on an expression</description>
+<syntax>SetEnvIfExpr <em>expr
+    [!]env-variable</em>[=<em>value</em>]
+    [[!]<em>env-variable</em>[=<em>value</em>]] ...</syntax>
+<contextlist><context>server config</context>
+<context>virtual host</context><context>directory</context>
+<context>.htaccess</context></contextlist>
+<override>FileInfo</override>
+
+<usage>
+    <p>The <directive>SetEnvIfExpr</directive> directive defines
+    environment variables based on an <directive type="section">If</directive>
+    <code>ap_expr</code>. These expressions will be evaluated at runtime,
+    and applied <em>env-variable</em> in the same fashion as <directive
+    >SetEnvIf</directive>.</p>
+
+<example>
+    SetEnvIfExpr "tolower(%req['X-Sendfile']) = 'D:\images\very_big.iso')" iso_delivered
+</example>
+
+    <p>This would set the environment variable <code>iso_delivered</code>
+    every time our application attempts to send it via <code>X-Sendfile</code></p>
+
+    <p>For a more useful example, consider the <code>Referer</code>
+    example from above for a site with more than one domain:</p>
+
+<example>
+    SetEnvIfExpr "${HTTP_REFERER} in www.example.com,example.com,w2.example3.org" intra_site_referral
+</example>
+</usage>
+
+<seealso><a href="../expr.html">Expressions in Apache HTTP Server</a>,
+for a complete reference and more examples.</seealso>
+<seealso><directive type="section">If</directive> can be used to achive similar
+results.</seealso>
+<seealso><module>mod_filter</module></seealso>
+<seealso><module>mod_include></module></seealso>
+</directivesynopsis>
+
 <directivesynopsis>
 <name>SetEnvIfNoCase</name>
 <description>Sets environment variables based on attributes of the request