summaryrefslogtreecommitdiffstats
path: root/docs/manual/mod/mod_headers.xml
diff options
context:
space:
mode:
authorChris Darroch <chrisd@apache.org>2007-08-21 23:05:46 +0200
committerChris Darroch <chrisd@apache.org>2007-08-21 23:05:46 +0200
commit3d51f859bdac439a1679d66094b8694b8e78b970 (patch)
tree2414389d91de021b57446d2738500b3a3fc1089b /docs/manual/mod/mod_headers.xml
parentDBDPersist takes On or Off (diff)
downloadapache2-3d51f859bdac439a1679d66094b8694b8e78b970.tar.xz
apache2-3d51f859bdac439a1679d66094b8694b8e78b970.zip
Fix some typos, whitespace, and formatting. Make sure all options are
listed in appropriate locations. Deprecate "add" in favour of "set" throughout. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@568283 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod/mod_headers.xml')
-rw-r--r--docs/manual/mod/mod_headers.xml71
1 files changed, 37 insertions, 34 deletions
diff --git a/docs/manual/mod/mod_headers.xml b/docs/manual/mod/mod_headers.xml
index a25740db85..4cc57b6005 100644
--- a/docs/manual/mod/mod_headers.xml
+++ b/docs/manual/mod/mod_headers.xml
@@ -97,7 +97,7 @@ headers</description>
bottlenecks between the client and the server.
<example>
- Header add MyHeader "%D %t"
+ Header set MyHeader "%D %t"
</example>
<p>results in this header being added to the response:</p>
@@ -111,7 +111,7 @@ headers</description>
Say hello to Joe
<example>
- Header add MyHeader "Hello Joe. It took %D microseconds \<br />
+ Header set MyHeader "Hello Joe. It took %D microseconds \<br />
for Apache to serve this request."
</example>
@@ -125,32 +125,34 @@ headers</description>
<li>
Conditionally send <code>MyHeader</code> on the response if and
- only if header "MyRequestHeader" is present on the request. This
- is useful for constructing headers in response to some client
+ only if header <code>MyRequestHeader</code> is present on the request.
+ This is useful for constructing headers in response to some client
stimulus. Note that this example requires the services of the
<module>mod_setenvif</module> module.
<example>
- SetEnvIf MyRequestHeader value HAVE_MyRequestHeader<br />
- Header add MyHeader "%D %t mytext" env=HAVE_MyRequestHeader<br />
- </example>
+ SetEnvIf MyRequestHeader myvalue HAVE_MyRequestHeader<br />
+ Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader
+ </example>
- <p>If the header <code>MyRequestHeader: value</code> is present on
- the HTTP request, the response will contain the following header:</p>
+ <p>If the header <code>MyRequestHeader: myvalue</code> is present on
+ the HTTP request, the response will contain the following header:</p>
- <example>
- MyHeader: D=3775428 t=991424704447256 mytext
- </example>
- </li>
- <li>Enable DAV to work with Apache running HTTP through SSL hardware
- (<a href="http://svn.haxx.se/users/archive-2006-03/0549.shtml"
- >problem description</a>) by replacing <var>https:</var> with
- <var>http:</var> in the <var>Destination</var> header:
- <example>
- RequestHeader edit Destination ^https: http: early
- </example>
+ <example>
+ MyHeader: D=3775428 t=991424704447256 mytext
+ </example>
</li>
+ <li>
+ Enable DAV to work with Apache running HTTP through SSL hardware
+ (<a href="http://svn.haxx.se/users/archive-2006-03/0549.shtml">problem
+ description</a>) by replacing <var>https:</var> with
+ <var>http:</var> in the <var>Destination</var> header:
+
+ <example>
+ RequestHeader edit Destination ^https: http: early
+ </example>
+ </li>
</ol>
</section>
@@ -186,8 +188,8 @@ headers</description>
<dd>The request header is added to the existing set of headers,
even if this header already exists. This can result in two
(or more) headers having the same name. This can lead to
- unforeseen consequences, and in general <code>append</code> should be
- used instead.</dd>
+ unforeseen consequences, and in general <code>set</code> or
+ <code>append</code> should be used instead.</dd>
<dt><code>unset</code></dt>
<dd>The request header of this name is removed, if it exists. If
@@ -204,10 +206,10 @@ headers</description>
<p>This argument is followed by a header name, which can
include the final colon, but it is not required. Case is
- ignored. For <code>add</code>, <code>append</code> and
- <code>set</code> a <var>value</var> is given as the third argument. If a
+ ignored. For <code>set</code>, <code>append</code> and
+ <code>add</code> a <var>value</var> is given as the third argument. If a
<var>value</var> contains spaces, it should be surrounded by double
- quotes. For unset, no <var>value</var> should be given.
+ quotes. For <code>unset</code>, no <var>value</var> should be given.
<var>value</var> may be a character string, a string containing format
specifiers or a combination of both. The supported format specifiers
are the same as for the <directive module="mod_headers">Header</directive>,
@@ -275,8 +277,8 @@ headers</description>
<dd>The response header is added to the existing set of headers,
even if this header already exists. This can result in two
(or more) headers having the same name. This can lead to
- unforeseen consequences, and in general "append" should be
- used instead.</dd>
+ unforeseen consequences, and in general <code>set</code> or
+ <code>append</code> should be used instead.</dd>
<dt><code>unset</code></dt>
<dd>The response header of this name is removed, if it exists.
@@ -285,7 +287,7 @@ headers</description>
<dt><code>echo</code></dt>
<dd>Request headers with this name are echoed back in the
- response headers. <var>header</var> may be a
+ response headers. <var>header</var> may be a
<glossary ref="regex">regular expression</glossary>.
<var>value</var> must be omitted.</dd>
@@ -299,14 +301,15 @@ headers</description>
<p>This argument is followed by a <var>header</var> name, which
can include the final colon, but it is not required. Case is
- ignored for <code>set</code>, <code>append</code>, <code>add</code>
- and <code>unset</code>. The <var>header</var> name for <code>echo</code>
- is case sensitive and may be a <glossary ref="regex">regular
+ ignored for <code>set</code>, <code>append</code>, <code>add</code>,
+ <code>unset</code>, and <code>edit</code>.
+ The <var>header</var> name for <code>echo</code>
+ is case sensitive and may be a <glossary ref="regex">regular
expression</glossary>.</p>
- <p>For <code>add</code>, <code>append</code> and <code>set</code> a
+ <p>For <code>set</code>, <code>append</code> and <code>add</code> a
<var>value</var> is specified as the third argument. If <var>value</var>
- contains spaces, it should be surrounded by doublequotes.
+ contains spaces, it should be surrounded by double quotes.
<var>value</var> may be a character string, a string containing format
specifiers or a combination of both. The following format specifiers
are supported in <var>value</var>:</p>
@@ -344,7 +347,7 @@ headers</description>
+StdEnvVars</code>. If <code>SSLOptions +StdEnvVars</code> must
be enabled anyway for some other reason, <code>%e</code> will be
more efficient than <code>%s</code>.</p>
- </note>
+ </note>
<p>For <code>edit</code> there is both a <var>value</var> argument
which is a <glossary ref="regex">regular expression</glossary>,