svn commit: r1371903 - /httpd/httpd/trunk/docs/manual/mod/mod_headers.xml

[rj...@apache.org]

Author: rjung
Date: Sat Aug 11 10:25:46 2012
New Revision: 1371903

URL: http://svn.apache.org/viewvc?rev=1371903&view=rev
Log:
Fix mod_headers documentation:
- add expr= to syntax rule
- add optional replacement argument to Header syntax
- add "edit*" command to Header syntax
- add "edit*" explanation to Header directive

Modified:
    httpd/httpd/trunk/docs/manual/mod/mod_headers.xml

Modified: httpd/httpd/trunk/docs/manual/mod/mod_headers.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_headers.xml?rev=1371903&r1=1371902&r2=1371903&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_headers.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_headers.xml Sat Aug 11 10:25:46 2012
@@ -192,8 +192,10 @@ Header merge Cache-Control no-store env=
 <directivesynopsis>
 <name>RequestHeader</name>
 <description>Configure HTTP request headers</description>
-<syntax>RequestHeader add|append|edit|edit*|merge|set|unset <var>header</var>
-[<var>value</var>] [<var>replacement</var>] [early|env=[!]<var>variable</var>]</syntax>
+<syntax>RequestHeader add|append|edit|edit*|merge|set|unset
+<var>header</var> [<var>value</var>] [<var>replacement</var>]
+[early|env=[!]<var>variable</var>]|expr=<var>expression</var>]
+</syntax>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context></contextlist>
 <override>FileInfo</override>
@@ -294,8 +296,10 @@ Header merge Cache-Control no-store env=
 <directivesynopsis>
 <name>Header</name>
 <description>Configure HTTP response headers</description>
-<syntax>Header [<var>condition</var>] add|append|echo|edit|merge|set|unset
-<var>header</var> [<var>value</var>] [early|env=[!]<var>variable</var>]</syntax>
+<syntax>Header [<var>condition</var>] add|append|echo|edit|edit*|merge|set|unset
+<var>header</var> [<var>value</var>] [<var>replacement</var>]
+[early|env=[!]<var>variable</var>]|expr=<var>expression</var>]
+</syntax>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context></contextlist>
 <override>FileInfo</override>
@@ -359,11 +363,16 @@ Header merge Cache-Control no-store env=
     <var>value</var> must be omitted.</dd>
 
     <dt><code>edit</code></dt>
+    <dt><code>edit*</code></dt>
     <dd>If this response header exists, its value is transformed according
     to a <glossary ref="regex">regular expression</glossary>
     search-and-replace.  The <var>value</var> argument is a <glossary
     ref="regex">regular expression</glossary>, and the <var>replacement</var>
-    is a replacement string, which may contain backreferences.</dd>
+    is a replacement string, which may contain backreferences.
+    The <code>edit</code> form will match and replace exactly once
+    in a header value, whereas the <code>edit*</code> form will replace
+    <em>every</em> instance of the search pattern if it appears more
+    than once.</dd>
 
     <dt><code>merge</code></dt>
     <dd>The response header is appended to any existing header of