]> git.ipfire.org Git - thirdparty/apache/httpd.git/commitdiff
Fix some typos, whitespace, and formatting. Make sure all options are
authorChris Darroch <chrisd@apache.org>
Thu, 23 Aug 2007 18:44:07 +0000 (18:44 +0000)
committerChris Darroch <chrisd@apache.org>
Thu, 23 Aug 2007 18:44:07 +0000 (18:44 +0000)
listed in appropriate locations.  Deprecate "add" in favour of "set"
throughout.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.2.x@569115 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/mod/mod_headers.xml

index c370737d62e299607d749c2144a7d232eaefd312..93c4f93b8d22f896eeb4e790ec661e2a396bc635 100644 (file)
@@ -99,7 +99,7 @@ is available only in Apache 2.0</compatibility>
         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>
@@ -113,7 +113,7 @@ is available only in Apache 2.0</compatibility>
         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>
 
@@ -127,32 +127,34 @@ is available only in Apache 2.0</compatibility>
 
       <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>
 
@@ -188,8 +190,8 @@ is available only in Apache 2.0</compatibility>
     <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
@@ -206,10 +208,10 @@ is available only in Apache 2.0</compatibility>
 
     <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>,
@@ -277,8 +279,8 @@ is available only in Apache 2.0</compatibility>
     <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.
@@ -287,7 +289,7 @@ is available only in Apache 2.0</compatibility>
 
     <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>
 
@@ -301,14 +303,15 @@ is available only in Apache 2.0</compatibility>
 
     <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>
@@ -346,7 +349,7 @@ is available only in Apache 2.0</compatibility>
       +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>,