granicus.if.org Git - apache/blob - docs/manual/mod/mod_headers.html.en

   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_headers - 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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_headers</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_headers.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_headers.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ja/mod/mod_headers.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="../ko/mod/mod_headers.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Customization of HTTP request and response
  33 headers</td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>headers_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_headers.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>This module provides directives to control and modify HTTP
  40     request and response headers. Headers can be merged, replaced
  41     or removed.</p>
  42 </div>
  43 <div id="quickview"><h3 class="directives">Directives</h3>
  44 <ul id="toc">
  45 <li><img alt="" src="../images/down.gif" /> <a href="#header">Header</a></li>
  46 <li><img alt="" src="../images/down.gif" /> <a href="#requestheader">RequestHeader</a></li>
  47 </ul>
  48 <h3>Topics</h3>
  49 <ul id="topics">
  50 <li><img alt="" src="../images/down.gif" /> <a href="#order">Order of Processing</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#early">Early and Late Processing</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  53 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  54 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  55 <div class="section">
  56 <h2><a name="order" id="order">Order of Processing</a></h2>
  57
  58     <p>The directives provided by <code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code> can
  59     occur almost anywhere within the server configuration, and can be
  60     limited in scope by enclosing them in <a href="../sections.html">configuration sections</a>.</p>
  61
  62     <p>Order of processing is important and is affected both by the
  63     order in the configuration file and by placement in <a href="../sections.html#mergin">configuration sections</a>. These
  64     two directives have a different effect if reversed:</p>
  65
  66     <pre class="prettyprint lang-config">
  67 RequestHeader append MirrorID "mirror 12"
  68 RequestHeader unset MirrorID
  69     </pre>
  70
  71
  72     <p>This way round, the <code>MirrorID</code> header is not set. If
  73     reversed, the MirrorID header is set to "mirror 12".</p>
  74 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  75 <div class="section">
  76 <h2><a name="early" id="early">Early and Late Processing</a></h2>
  77     <p><code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code> can be applied either early or late
  78     in the request.  The normal mode is late, when <em>Request</em> Headers are
  79     set immediately before running the content generator and <em>Response</em>
  80     Headers just as the response is sent down the wire.  Always use
  81     Late mode in an operational server.</p>
  82
  83     <p>Early mode is designed as a test/debugging aid for developers.
  84     Directives defined using the <code>early</code> keyword are set
  85     right at the beginning of processing the request.  This means
  86     they can be used to simulate different requests and set up test
  87     cases, but it also means that headers may be changed at any time
  88     by other modules before generating a Response.</p>
  89
  90     <p>Because early directives are processed before the request path's
  91     configuration is traversed, early headers can only be set in a
  92     main server or virtual host context.  Early directives cannot depend
  93     on a request path, so they will fail in contexts such as
  94     <code>&lt;Directory&gt;</code> or <code>&lt;Location&gt;</code>.</p>
  95 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  96 <div class="section">
  97 <h2><a name="examples" id="examples">Examples</a></h2>
  98
  99     <ol>
 100       <li>
 101         Copy all request headers that begin with "TS" to the
 102         response headers:
 103
 104         <pre class="prettyprint lang-config">
 105           Header echo ^TS
 106         </pre>
 107
 108       </li>
 109
 110       <li>
 111         Add a header, <code>MyHeader</code>, to the response including a
 112         timestamp for when the request was received and how long it
 113         took to begin serving the request. This header can be used by
 114         the client to intuit load on the server or in isolating
 115         bottlenecks between the client and the server.
 116
 117         <pre class="prettyprint lang-config">
 118           Header set MyHeader "%D %t"
 119         </pre>
 120
 121
 122         <p>results in this header being added to the response:</p>
 123
 124         <div class="example"><p><code>
 125           MyHeader: D=3775428 t=991424704447256
 126         </code></p></div>
 127       </li>
 128
 129       <li>
 130         Say hello to Joe
 131
 132         <pre class="prettyprint lang-config">
 133 Header set MyHeader "Hello Joe. It took %D microseconds for Apache to serve this request."
 134         </pre>
 135
 136
 137         <p>results in this header being added to the response:</p>
 138
 139         <div class="example"><p><code>
 140           MyHeader: Hello Joe. It took D=3775428 microseconds for Apache
 141           to serve this request.
 142         </code></p></div>
 143       </li>
 144
 145       <li>
 146         Conditionally send <code>MyHeader</code> on the response if and
 147         only if header <code>MyRequestHeader</code> is present on the request.
 148         This is useful for constructing headers in response to some client
 149         stimulus. Note that this example requires the services of the
 150         <code class="module"><a href="../mod/mod_setenvif.html">mod_setenvif</a></code> module.
 151
 152         <pre class="prettyprint lang-config">
 153 SetEnvIf MyRequestHeader myvalue HAVE_MyRequestHeader
 154 Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader
 155         </pre>
 156
 157
 158         <p>If the header <code>MyRequestHeader: myvalue</code> is present on
 159         the HTTP request, the response will contain the following header:</p>
 160
 161         <div class="example"><p><code>
 162           MyHeader: D=3775428 t=991424704447256 mytext
 163         </code></p></div>
 164       </li>
 165
 166       <li>
 167         Enable DAV to work with Apache running HTTP through SSL hardware
 168         (<a href="http://svn.haxx.se/users/archive-2006-03/0549.shtml">problem
 169         description</a>) by replacing <var>https:</var> with
 170         <var>http:</var> in the <var>Destination</var> header:
 171
 172         <pre class="prettyprint lang-config">
 173           RequestHeader edit Destination ^https: http: early
 174         </pre>
 175
 176       </li>
 177
 178       <li>
 179         Set the same header value under multiple non-exclusive conditions,
 180         but do not duplicate the value in the final header.
 181         If all of the following conditions applied to a request (i.e.,
 182         if the <code>CGI</code>, <code>NO_CACHE</code> and
 183         <code>NO_STORE</code> environment variables all existed for the
 184         request):
 185
 186         <pre class="prettyprint lang-config">
 187 Header merge Cache-Control no-cache env=CGI
 188 Header merge Cache-Control no-cache env=NO_CACHE
 189 Header merge Cache-Control no-store env=NO_STORE
 190         </pre>
 191
 192
 193         <p>then the response would contain the following header:</p>
 194
 195         <div class="example"><p><code>
 196           Cache-Control: no-cache, no-store
 197         </code></p></div>
 198
 199         <p>If <code>append</code> was used instead of <code>merge</code>,
 200         then the response would contain the following header:</p>
 201
 202         <div class="example"><p><code>
 203           Cache-Control: no-cache, no-cache, no-store
 204         </code></p></div>
 205       </li>
 206       <li>
 207         Set a test cookie if and only if the client didn't send us a cookie
 208         <pre class="prettyprint lang-config">
 209           Header set Set-Cookie testcookie "expr=-z %{req:Cookie}"
 210         </pre>
 211
 212       </li>
 213     </ol>
 214 </div>
 215 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 216 <div class="directive-section"><h2><a name="Header" id="Header">Header</a> <a name="header" id="header">Directive</a></h2>
 217 <table class="directive">
 218 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure HTTP response headers</td></tr>
 219 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Header [<var>condition</var>] add|append|echo|edit|edit*|merge|set|unset
 220 <var>header</var> [<var>value</var>] [<var>replacement</var>]
 221 [early|env=[!]<var>variable</var>]|expr=<var>expression</var>]
 222 </code></td></tr>
 223 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 224 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 225 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 226 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_headers</td></tr>
 227 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Default condition was temporarily changed to "always" in 2.3.9 and 2.3.10</td></tr>
 228 </table>
 229     <p>This directive can replace, merge or remove HTTP response
 230     headers. The header is modified just after the content handler
 231     and output filters are run, allowing outgoing headers to be
 232     modified.</p>
 233
 234     <p> The optional <var>condition</var> argument determines which internal
 235     table of responses headers this directive will operate against.  Other
 236     components of the server may have stored their response headers in either
 237     the table that corresponds to <code>onsuccess</code> or the table that
 238     corresponds to <code>always</code>.  "Always" in this context refers to
 239     whether headers you add will be sent during both a successful and unsucessful
 240     response, but if your action is a function of an existing header, you
 241     will have to read on for further complications.</p>
 242
 243     <p> The default value of <code>onsuccess</code> may need to be changed to
 244     <code>always</code> under the circumstances similar to those listed below.
 245     Note also that repeating this directive with both conditions makes sense in
 246     some scenarios because <code>always</code> is not a superset of
 247     <code>onsuccess</code> with respect to existing headers:</p>
 248
 249     <ul>
 250        <li> You're adding a header to a non-success (non-2xx) response, such
 251             as a redirect, in which case only the table corresponding to
 252             <code>always</code> is used in the ultimate response.</li>
 253        <li> You're modifying or removing a header generated by a CGI script,
 254             in which case the CGI scripts are in the table corresponding to
 255             <code>always</code> and not in the default table.</li>
 256        <li> You're modifying or removing a header generated by some piece of
 257             the server but that header is not being found by the default
 258             <code>onsuccess</code> condition.</li>
 259     </ul>
 260
 261     <p>The action it performs is determined by the first
 262     argument (second argument if a <var>condition</var> is specified).
 263     This can be one of the following values:</p>
 264
 265     <dl>
 266     <dt><code>add</code></dt>
 267     <dd>The response header is added to the existing set of headers,
 268     even if this header already exists. This can result in two
 269     (or more) headers having the same name. This can lead to
 270     unforeseen consequences, and in general <code>set</code>,
 271     <code>append</code> or <code>merge</code> should be used instead.</dd>
 272
 273     <dt><code>append</code></dt>
 274     <dd>The response header is appended to any existing header of
 275     the same name. When a new value is merged onto an existing
 276     header it is separated from the existing header with a comma.
 277     This is the HTTP standard way of giving a header multiple values.</dd>
 278
 279     <dt><code>echo</code></dt>
 280     <dd>Request headers with this name are echoed back in the
 281     response headers. <var>header</var> may be a
 282     <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>.
 283     <var>value</var> must be omitted.</dd>
 284
 285     <dt><code>edit</code></dt>
 286     <dt><code>edit*</code></dt>
 287     <dd>If this response header exists, its value is transformed according
 288     to a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
 289     search-and-replace.  The <var>value</var> argument is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>, and the <var>replacement</var>
 290     is a replacement string, which may contain backreferences.
 291     The <code>edit</code> form will match and replace exactly once
 292     in a header value, whereas the <code>edit*</code> form will replace
 293     <em>every</em> instance of the search pattern if it appears more
 294     than once.</dd>
 295
 296     <dt><code>merge</code></dt>
 297     <dd>The response header is appended to any existing header of
 298     the same name, unless the value to be appended already appears in the
 299     header's comma-delimited list of values.  When a new value is merged onto
 300     an existing header it is separated from the existing header with a comma.
 301     This is the HTTP standard way of giving a header multiple values.
 302     Values are compared in a case sensitive manner, and after
 303     all format specifiers have been processed.  Values in double quotes
 304     are considered different from otherwise identical unquoted values.</dd>
 305
 306     <dt><code>set</code></dt>
 307     <dd>The response header is set, replacing any previous header
 308     with this name. The <var>value</var> may be a format string.</dd>
 309
 310     <dt><code>unset</code></dt>
 311     <dd>The response header of this name is removed, if it exists.
 312     If there are multiple headers of the same name, all will be
 313     removed. <var>value</var> must be omitted.</dd>
 314     </dl>
 315
 316     <p>This argument is followed by a <var>header</var> name, which
 317     can include the final colon, but it is not required. Case is
 318     ignored for <code>set</code>, <code>append</code>, <code>merge</code>,
 319     <code>add</code>, <code>unset</code> and <code>edit</code>.
 320     The <var>header</var> name for <code>echo</code>
 321     is case sensitive and may be a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular
 322     expression</a>.</p>
 323
 324     <p>For <code>set</code>, <code>append</code>, <code>merge</code> and
 325     <code>add</code> a <var>value</var> is specified as the next argument.
 326     If <var>value</var>
 327     contains spaces, it should be surrounded by double quotes.
 328     <var>value</var> may be a character string, a string containing format
 329     specifiers or a combination of both. The following format specifiers
 330     are supported in <var>value</var>:</p>
 331
 332     <table class="bordered"><tr class="header"><th>Format</th><th>Description</th></tr>
 333 <tr><td><code>%%</code></td>
 334         <td>The percent sign</td></tr>
 335 <tr class="odd"><td><code>%t</code></td>
 336         <td>The time the request was received in Universal Coordinated Time
 337         since the epoch (Jan. 1, 1970) measured in microseconds. The value
 338         is preceded by <code>t=</code>.</td></tr>
 339 <tr><td><code>%D</code></td>
 340         <td>The time from when the request was received to the time the
 341         headers are sent on the wire. This is a measure of the duration
 342         of the request. The value is preceded by <code>D=</code>.
 343         The value is measured in microseconds.</td></tr>
 344 <tr class="odd"><td><code>%l</code></td>
 345         <td>The current load averages of the actual server itself. It is
 346         designed to expose the values obtained by <code>getloadavg()</code>
 347         and this represents the current load average, the 5 minute average, and
 348         the 15 minute average. The value is preceded by <code>l=</code> with each
 349         average separated by <code>/</code>.
 350         </td></tr>
 351 <tr><td><code>%i</code></td>
 352         <td>The current idle percentage of httpd (0 to 100) based on available
 353         processes and threads. The value is preceded by <code>i=</code>.
 354         </td></tr>
 355 <tr class="odd"><td><code>%b</code></td>
 356         <td>The current busy percentage of httpd (0 to 100) based on available
 357         processes and threads. The value is preceded by <code>b=</code>.
 358         </td></tr>
 359 <tr><td><code>%{VARNAME}e</code></td>
 360         <td>The contents of the <a href="../env.html">environment
 361         variable</a> <code>VARNAME</code>.</td></tr>
 362 <tr class="odd"><td><code>%{VARNAME}s</code></td>
 363         <td>The contents of the <a href="mod_ssl.html#envvars">SSL environment
 364         variable</a> <code>VARNAME</code>, if <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is enabled.</td></tr>
 365 </table>
 366
 367     <div class="note"><h3>Note</h3>
 368       <p>The <code>%s</code> format specifier is only available in
 369       Apache 2.1 and later; it can be used instead of <code>%e</code>
 370       to avoid the overhead of enabling <code>SSLOptions
 371       +StdEnvVars</code>.  If <code>SSLOptions +StdEnvVars</code> must
 372       be enabled anyway for some other reason, <code>%e</code> will be
 373       more efficient than <code>%s</code>.</p>
 374     </div>
 375
 376     <p>For <code>edit</code> there is both a <var>value</var> argument
 377     which is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>,
 378     and an additional <var>replacement</var> string.</p>
 379
 380     <p>The <code class="directive">Header</code> directive may be followed by
 381     an additional argument, which may be any of:</p>
 382     <dl>
 383     <dt><code>early</code></dt>
 384     <dd>Specifies <a href="#early">early processing</a>.</dd>
 385     <dt><code>env=[!]<var>varname</var></code></dt>
 386     <dd>The directive is applied if and only if the <a href="../env.html">environment variable</a> <code>varname</code> exists.
 387         A <code>!</code> in front of <code>varname</code> reverses the test,
 388         so the directive applies only if <code>varname</code> is unset.</dd>
 389     <dt><code>expr=<var>expression</var></code></dt>
 390     <dd>The directive is applied if and only if <var>expression</var>
 391         evaluates to true. Details of expression syntax and evaluation are
 392         documented in the <a href="../expr.html">ap_expr</a> documentation.</dd>
 393     </dl>
 394
 395     <p>Except in <a href="#early">early</a> mode, the
 396     <code class="directive">Header</code> directives are processed just
 397     before the response is sent to the network. These means that it is
 398     possible to set and/or override most headers, except for those headers
 399     added by the HTTP header filter, such as Content-Type.</p>
 400
 401 </div>
 402 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 403 <div class="directive-section"><h2><a name="RequestHeader" id="RequestHeader">RequestHeader</a> <a name="requestheader" id="requestheader">Directive</a></h2>
 404 <table class="directive">
 405 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure HTTP request headers</td></tr>
 406 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestHeader add|append|edit|edit*|merge|set|unset
 407 <var>header</var> [<var>value</var>] [<var>replacement</var>]
 408 [early|env=[!]<var>variable</var>]|expr=<var>expression</var>]
 409 </code></td></tr>
 410 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 411 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 412 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 413 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_headers</td></tr>
 414 </table>
 415     <p>This directive can replace, merge, change or remove HTTP request
 416     headers. The header is modified just before the content handler
 417     is run, allowing incoming headers to be modified. The action it
 418     performs is determined by the first argument. This can be one
 419     of the following values:</p>
 420
 421     <dl>
 422
 423     <dt><code>add</code></dt>
 424     <dd>The request header is added to the existing set of headers,
 425     even if this header already exists. This can result in two
 426     (or more) headers having the same name. This can lead to
 427     unforeseen consequences, and in general <code>set</code>,
 428     <code>append</code> or <code>merge</code> should be used instead.</dd>
 429
 430     <dt><code>append</code></dt>
 431     <dd>The request header is appended to any existing header of the
 432     same name. When a new value is merged onto an existing header
 433     it is separated from the existing header with a comma. This
 434     is the HTTP standard way of giving a header multiple
 435     values.</dd>
 436
 437     <dt><code>edit</code></dt>
 438     <dt><code>edit*</code></dt>
 439     <dd>If this request header exists, its value is transformed according
 440     to a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
 441     search-and-replace.  The <var>value</var> argument is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>, and the <var>replacement</var>
 442     is a replacement string, which may contain backreferences.
 443     The <code>edit</code> form will match and replace exactly once
 444     in a header value, whereas the <code>edit*</code> form will replace
 445     <em>every</em> instance of the search pattern if it appears more
 446     than once.</dd>
 447
 448     <dt><code>merge</code></dt>
 449     <dd>The request header is appended to any existing header of
 450     the same name, unless the value to be appended already appears in the
 451     existing header's comma-delimited list of values.  When a new value is
 452     merged onto an existing header it is separated from the existing header
 453     with a comma.  This is the HTTP standard way of giving a header multiple
 454     values.  Values are compared in a case sensitive manner, and after
 455     all format specifiers have been processed.  Values in double quotes
 456     are considered different from otherwise identical unquoted values.</dd>
 457
 458     <dt><code>set</code></dt>
 459     <dd>The request header is set, replacing any previous header
 460     with this name</dd>
 461
 462     <dt><code>unset</code></dt>
 463     <dd>The request header of this name is removed, if it exists. If
 464     there are multiple headers of the same name, all will be removed.
 465     <var>value</var> must be omitted.</dd>
 466     </dl>
 467
 468     <p>This argument is followed by a header name, which can
 469     include the final colon, but it is not required. Case is
 470     ignored. For <code>set</code>, <code>append</code>, <code>merge</code> and
 471     <code>add</code> a <var>value</var> is given as the third argument. If a
 472     <var>value</var> contains spaces, it should be surrounded by double
 473     quotes. For <code>unset</code>, no <var>value</var> should be given.
 474     <var>value</var> may be a character string, a string containing format
 475     specifiers or a combination of both. The supported format specifiers
 476     are the same as for the <code class="directive"><a href="#header">Header</a></code>,
 477     please have a look there for details.  For <code>edit</code> both
 478     a <var>value</var> and a <var>replacement</var> are required, and are
 479     a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a> and a
 480     replacement string respectively.</p>
 481
 482     <p>The <code class="directive">RequestHeader</code> directive may be followed by
 483     an additional argument, which may be any of:</p>
 484     <dl>
 485     <dt><code>early</code></dt>
 486     <dd>Specifies <a href="#early">early processing</a>.</dd>
 487     <dt><code>env=[!]<var>varname</var></code></dt>
 488     <dd>The directive is applied if and only if the <a href="../env.html">environment variable</a> <code>varname</code> exists.
 489         A <code>!</code> in front of <code>varname</code> reverses the test,
 490         so the directive applies only if <code>varname</code> is unset.</dd>
 491     <dt><code>expr=<var>expression</var></code></dt>
 492     <dd>The directive is applied if and only if <var>expression</var>
 493         evaluates to true. Details of expression syntax and evaluation are
 494         documented in the <a href="../expr.html">ap_expr</a> documentation.</dd>
 495     </dl>
 496
 497     <p>Except in <a href="#early">early</a> mode, the
 498     <code class="directive">RequestHeader</code> directive is processed
 499     just before the request is run by its handler in the fixup phase.
 500     This should allow headers generated by the browser, or by Apache
 501     input filters to be overridden or modified.</p>
 502
 503 </div>
 504 </div>
 505 <div class="bottomlang">
 506 <p><span>Available Languages: </span><a href="../en/mod/mod_headers.html" title="English">&nbsp;en&nbsp;</a> |
 507 <a href="../fr/mod/mod_headers.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 508 <a href="../ja/mod/mod_headers.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 509 <a href="../ko/mod/mod_headers.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 510 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 511 <script type="text/javascript"><!--//--><![CDATA[//><!--
 512 var comments_shortname = 'httpd';
 513 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_headers.html';
 514 (function(w, d) {
 515     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 516         d.write('<div id="comments_thread"><\/div>');
 517         var s = d.createElement('script');
 518         s.type = 'text/javascript';
 519         s.async = true;
 520         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 521         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 522     }
 523     else {
 524         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 525     }
 526 })(window, document);
 527 //--><!]]></script></div><div id="footer">
 528 <p class="apache">Copyright 2012 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>
 529 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 530 if (typeof(prettyPrint) !== 'undefined') {
 531     prettyPrint();
 532 }
 533 //--><!]]></script>
 534 </body></html>