]> granicus.if.org Git - apache/blobdiff - docs/manual/mod/mod_headers.html.en
Merge in APR[-util] macros from branches/trunk-buildconf-noapr
[apache] / docs / manual / mod / mod_headers.html.en
index 768dc5d3b4e8c049a948dd446ac8464a761f6adc..997edd7a6369b0d99b98db2212bb26187d528671 100644 (file)
@@ -1,6 +1,8 @@
 <?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
@@ -17,7 +19,7 @@
 <div id="page-header">
 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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.5</p>
-<img alt="" src="../images/feather.gif" /></div>
+<img alt="" src="../images/feather.png" /></div>
 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
 <div id="path">
 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
@@ -40,17 +42,19 @@ headers</td></tr>
     request and response headers. Headers can be merged, replaced
     or removed.</p>
 </div>
-<div id="quickview"><h3 class="directives">Directives</h3>
-<ul id="toc">
-<li><img alt="" src="../images/down.gif" /> <a href="#header">Header</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#requestheader">RequestHeader</a></li>
-</ul>
-<h3>Topics</h3>
+<div id="quickview"><h3>Topics</h3>
 <ul id="topics">
 <li><img alt="" src="../images/down.gif" /> <a href="#order">Order of Processing</a></li>
 <li><img alt="" src="../images/down.gif" /> <a href="#early">Early and Late Processing</a></li>
 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
-</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
+</ul><h3 class="directives">Directives</h3>
+<ul id="toc">
+<li><img alt="" src="../images/down.gif" /> <a href="#header">Header</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#requestheader">RequestHeader</a></li>
+</ul>
+<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__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_headers">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_headers">Report a bug</a></li></ul><h3>See also</h3>
+<ul class="seealso">
+<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="order" id="order">Order of Processing</a></h2>
@@ -165,7 +169,7 @@ Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader</pre>
       </li>
 
       <li>
-        Set the same header value under multiple non-exclusive conditions,
+        Set the same header value under multiple nonexclusive conditions,
         but do not duplicate the value in the final header.
         If all of the following conditions applied to a request (i.e.,
         if the <code>CGI</code>, <code>NO_CACHE</code> and
@@ -208,14 +212,14 @@ Header merge Cache-Control no-store env=NO_STORE</pre>
 <table class="directive">
 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure HTTP response headers</td></tr>
 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Header [<var>condition</var>] add|append|echo|edit|edit*|merge|set|setifempty|unset|note
-<var>header</var> [[expr=]<var>value</var> [<var>replacement</var>
-[early|env=[!]<var>varname</var>|expr=<var>expression</var>]]]
+<var>header</var> [[expr=]<var>value</var> [<var>replacement</var>]
+[early|env=[!]<var>varname</var>|expr=<var>expression</var>]]
 </code></td></tr>
 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_headers</td></tr>
-<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>SetIfEmpty available in 2.4.7 and later, expr=value 
+<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>SetIfEmpty available in 2.4.7 and later, expr=value
 available in 2.4.10 and later</td></tr>
 </table>
     <p>This directive can replace, merge or remove HTTP response
@@ -225,7 +229,7 @@ available in 2.4.10 and later</td></tr>
 
     <p> The optional <var>condition</var> argument determines which internal
     table of responses headers this directive will operate against. Despite the
-    name, the default value of <code>onsuccess</code> does <em>not</em> limit 
+    name, the default value of <code>onsuccess</code> does <em>not</em> limit
     an <var>action</var> to responses with a 2xx status code.  Headers set under
     this condition are still used when, for example, a request is <em>successfully</em>
     proxied or generated by CGI, even when they have generated a failing status code.</p>
@@ -233,7 +237,7 @@ available in 2.4.10 and later</td></tr>
     <p>When your action is a function of an existing header, you may need to specify
     a condition of <code>always</code>, depending on which internal table the
     original header was set in.  The table that corresponds to <code>always</code> is
-    used for locally generated error responses as well as successful responses.  
+    used for locally generated error responses as well as successful responses.
     Note also that repeating this directive with both conditions makes sense in
     some scenarios because <code>always</code> is not a superset of
     <code>onsuccess</code> with respect to existing headers:</p>
@@ -250,8 +254,8 @@ available in 2.4.10 and later</td></tr>
             <code>onsuccess</code> condition.</li>
     </ul>
 
-    <p>Separately from the <var>condition</var> paramete described above, you 
-    can limit an action based on HTTP status codes for e.g. proxied or CGI 
+    <p>Separately from the <var>condition</var> parameter described above, you
+    can limit an action based on HTTP status codes for e.g. proxied or CGI
     requests. See the example that uses %{REQUEST_STATUS} in the section above.</p>
 
     <p>The action it performs is determined by the first
@@ -305,8 +309,16 @@ available in 2.4.10 and later</td></tr>
 
     <dt><code>setifempty</code></dt>
     <dd>The request header is set, but only if there is no previous header
-    with this name.<br />
-    Available in 2.4.7 and later.</dd>
+    with this name.
+    <div class="note">
+    The Content-Type header is a special use case since there might be
+    the chance that its value have been determined but the header is not part
+    of the response when <code>setifempty</code> is evaluated.
+    It is safer to use <code>set</code> for this use case like in the
+    following example:
+    <pre class="prettyprint lang-config">Header set Content-Type "text/plain" "expr=-z %{CONTENT_TYPE}"</pre>
+
+    </div></dd>
 
     <dt><code>unset</code></dt>
     <dd>The response header of this name is removed, if it exists.
@@ -334,11 +346,11 @@ available in 2.4.10 and later</td></tr>
     <code>add</code> a <var>value</var> is specified as the next argument.
     If <var>value</var>
     contains spaces, it should be surrounded by double quotes.
-    <var>value</var> may be a character string, a string containing 
-    <code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code> specific format specifiers (and character 
+    <var>value</var> may be a character string, a string containing
+    <code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code> specific format specifiers (and character
     literals), or an <a href="../expr.html">ap_expr</a> expression prefixed
     with <em>expr=</em></p>
-    
+
     <p> The following format specifiers are supported in <var>value</var>:</p>
 
     <table class="bordered"><tr class="header"><th>Format</th><th>Description</th></tr>
@@ -388,6 +400,24 @@ available in 2.4.10 and later</td></tr>
       more efficient than <code>%s</code>.</p>
     </div>
 
+    <div class="note"><h3>Note on expression values</h3>
+    <p> When the value parameter uses the <a href="../expr.html">ap_expr</a>
+    parser, some expression syntax will differ from examples that evaluate
+    <em>boolean</em> expressions such as &lt;If&gt;:</p>
+    <ul>
+      <li>The starting point of the grammar is 'string' rather than 'expr'.</li>
+      <li>Function calls use the %{funcname:arg} syntax rather than
+          funcname(arg).</li>
+      <li>Multi-argument functions are not currently accessible from this
+          starting point</li>
+      <li>Quote the entire parameter, such as
+          <pre class="prettyprint lang-config">Header set foo-checksum "expr=%{md5:foo}"</pre>
+
+       </li>
+
+    </ul>
+    </div>
+
     <p>For <code>edit</code> there is both a <var>value</var> argument
     which is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>,
     and an additional <var>replacement</var> string. As of version 2.4.7
@@ -405,14 +435,18 @@ available in 2.4.10 and later</td></tr>
     <dt><code>expr=<var>expression</var></code></dt>
     <dd>The directive is applied if and only if <var>expression</var>
         evaluates to true. Details of expression syntax and evaluation are
-        documented in the <a href="../expr.html">ap_expr</a> documentation.</dd>
+        documented in the <a href="../expr.html">ap_expr</a> documentation.
+        <pre class="prettyprint lang-config"># This delays the evaluation of the condition clause compared to &lt;If&gt;
+Header always set CustomHeader my-value "expr=%{REQUEST_URI} =~ m#^/special_path.php$#"</pre>
+   
+        </dd>
     </dl>
 
     <p>Except in <a href="#early">early</a> mode, the
     <code class="directive">Header</code> directives are processed just
-    before the response is sent to the network. These means that it is
+    before the response is sent to the network. This means that it is
     possible to set and/or override most headers, except for some headers
-    added by the HTTP header filter.  Prior to 2.2.12, it was not possible 
+    added by the HTTP header filter.  Prior to 2.2.12, it was not possible
     to change the Content-Type header with this directive.</p>
 
 
@@ -422,14 +456,14 @@ available in 2.4.10 and later</td></tr>
 <table class="directive">
 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure HTTP request headers</td></tr>
 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestHeader add|append|edit|edit*|merge|set|setifempty|unset
-<var>header</var> [[expr=]<var>value</var> [<var>replacement</var>
-[early|env=[!]<var>varname</var>|expr=<var>expression</var>]]]
+<var>header</var> [[expr=]<var>value</var> [<var>replacement</var>]
+[early|env=[!]<var>varname</var>|expr=<var>expression</var>]]
 </code></td></tr>
 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_headers</td></tr>
-<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>SetIfEmpty available in 2.4.7 and later, expr=value 
+<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>SetIfEmpty available in 2.4.7 and later, expr=value
 available in 2.4.10 and later</td></tr>
 </table>
     <p>This directive can replace, merge, change or remove HTTP request
@@ -550,7 +584,7 @@ var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_headers.ht
     }
 })(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 2017 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/quickreference.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();