Skip to content

Commit

Permalink
Put the arguments to Header, RequestHeader, in alphabetic order.
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@723560 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
rbowen committed Dec 5, 2008
1 parent eb4334d commit e987e86
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 82 deletions.
81 changes: 41 additions & 40 deletions docs/manual/mod/mod_headers.html.en
Expand Up @@ -199,7 +199,7 @@ headers</td></tr>
<div class="directive-section"><h2><a name="Header" id="Header">Header</a> <a name="header" id="header">Directive</a></h2>
<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>] set|append|merge|add|unset|echo|edit
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Header [<var>condition</var>] add|append|echo|edit|merge|set|unset
<var>header</var> [<var>value</var>] [early|env=[!]<var>variable</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>
Expand All @@ -222,16 +222,32 @@ headers</td></tr>
argument. This can be one of the following values:</p>

<dl>
<dt><code>set</code></dt>
<dd>The response header is set, replacing any previous header
with this name. The <var>value</var> may be a format string.</dd>
<dt><code>add</code></dt>
<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 <code>set</code>,
<code>append</code> or <code>merge</code> should be used instead.</dd>

<dt><code>append</code></dt>
<dd>The response header is appended to any existing header of
the same name. When a new value is merged onto an existing
header it is separated from the existing header with a comma.
This is the HTTP standard way of giving a header multiple values.</dd>

<dt><code>echo</code></dt>
<dd>Request headers with this name are echoed back in the
response headers. <var>header</var> may be a
<a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>.
<var>value</var> must be omitted.</dd>

<dt><code>edit</code></dt>
<dd>If this request header exists, its value is transformed according
to a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
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>
is a replacement string, which may contain backreferences.</dd>
</dl>

<dt><code>merge</code></dt>
<dd>The response header is appended to any existing header of
the same name, unless the value to be appended already appears in the
Expand All @@ -242,31 +258,15 @@ headers</td></tr>
all format specifiers have been processed. Values in double quotes
are considered different from otherwise identical unquoted values.</dd>

<dt><code>add</code></dt>
<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 <code>set</code>,
<code>append</code> or <code>merge</code> should be used instead.</dd>
<dt><code>set</code></dt>
<dd>The response header is set, replacing any previous header
with this name. The <var>value</var> may be a format string.</dd>

<dt><code>unset</code></dt>
<dd>The response header of this name is removed, if it exists.
If there are multiple headers of the same name, all will be
removed. <var>value</var> must be omitted.</dd>

<dt><code>echo</code></dt>
<dd>Request headers with this name are echoed back in the
response headers. <var>header</var> may be a
<a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>.
<var>value</var> must be omitted.</dd>

<dt><code>edit</code></dt>
<dd>If this request header exists, its value is transformed according
to a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
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>
is a replacement string, which may contain backreferences.</dd>
</dl>

<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>merge</code>,
Expand Down Expand Up @@ -337,7 +337,7 @@ headers</td></tr>
<div class="directive-section"><h2><a name="RequestHeader" id="RequestHeader">RequestHeader</a> <a name="requestheader" id="requestheader">Directive</a></h2>
<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 set|append|merge|add|unset|edit <var>header</var>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestHeader add|append|edit|merge|set|unset <var>header</var>
[<var>value</var>] [<var>replacement</var>] [early|env=[!]<var>variable</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>
Expand All @@ -351,9 +351,13 @@ headers</td></tr>
of the following values:</p>

<dl>
<dt><code>set</code></dt>
<dd>The request header is set, replacing any previous header
with this name</dd>

<dt><code>add</code></dt>
<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>set</code>,
<code>append</code> or <code>merge</code> should be used instead.</dd>

<dt><code>append</code></dt>
<dd>The request header is appended to any existing header of the
Expand All @@ -362,6 +366,13 @@ headers</td></tr>
is the HTTP standard way of giving a header multiple
values.</dd>

<dt><code>edit</code></dt>
<dd>If this request header exists, its value is transformed according
to a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
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>
is a replacement string, which may contain backreferences.</dd>
</dl>

<dt><code>merge</code></dt>
<dd>The response header is appended to any existing header of
the same name, unless the value to be appended already appears in the
Expand All @@ -372,25 +383,15 @@ headers</td></tr>
all format specifiers have been processed. Values in double quotes
are considered different from otherwise identical unquoted values.</dd>

<dt><code>add</code></dt>
<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>set</code>,
<code>append</code> or <code>merge</code> should be used instead.</dd>
<dt><code>set</code></dt>
<dd>The request header is set, replacing any previous header
with this name</dd>

<dt><code>unset</code></dt>
<dd>The request header of this name is removed, if it exists. If
there are multiple headers of the same name, all will be removed.
<var>value</var> must be omitted.</dd>

<dt><code>edit</code></dt>
<dd>If this request header exists, its value is transformed according
to a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
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>
is a replacement string, which may contain backreferences.</dd>
</dl>

<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>set</code>, <code>append</code>, <code>merge</code> and
Expand Down
85 changes: 43 additions & 42 deletions docs/manual/mod/mod_headers.xml
Expand Up @@ -187,7 +187,7 @@ headers</description>
<directivesynopsis>
<name>RequestHeader</name>
<description>Configure HTTP request headers</description>
<syntax>RequestHeader set|append|merge|add|unset|edit <var>header</var>
<syntax>RequestHeader add|append|edit|merge|set|unset <var>header</var>
[<var>value</var>] [<var>replacement</var>] [early|env=[!]<var>variable</var>]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
Expand All @@ -201,9 +201,13 @@ headers</description>
of the following values:</p>

<dl>
<dt><code>set</code></dt>
<dd>The request header is set, replacing any previous header
with this name</dd>

<dt><code>add</code></dt>
<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>set</code>,
<code>append</code> or <code>merge</code> should be used instead.</dd>

<dt><code>append</code></dt>
<dd>The request header is appended to any existing header of the
Expand All @@ -212,6 +216,14 @@ headers</description>
is the HTTP standard way of giving a header multiple
values.</dd>

<dt><code>edit</code></dt>
<dd>If this request 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>
</dl>

<dt><code>merge</code></dt>
<dd>The response header is appended to any existing header of
the same name, unless the value to be appended already appears in the
Expand All @@ -222,26 +234,15 @@ headers</description>
all format specifiers have been processed. Values in double quotes
are considered different from otherwise identical unquoted values.</dd>

<dt><code>add</code></dt>
<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>set</code>,
<code>append</code> or <code>merge</code> should be used instead.</dd>
<dt><code>set</code></dt>
<dd>The request header is set, replacing any previous header
with this name</dd>

<dt><code>unset</code></dt>
<dd>The request header of this name is removed, if it exists. If
there are multiple headers of the same name, all will be removed.
<var>value</var> must be omitted.</dd>

<dt><code>edit</code></dt>
<dd>If this request 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>
</dl>

<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>set</code>, <code>append</code>, <code>merge</code> and
Expand Down Expand Up @@ -278,7 +279,7 @@ headers</description>
<directivesynopsis>
<name>Header</name>
<description>Configure HTTP response headers</description>
<syntax>Header [<var>condition</var>] set|append|merge|add|unset|echo|edit
<syntax>Header [<var>condition</var>] add|append|echo|edit|merge|set|unset
<var>header</var> [<var>value</var>] [early|env=[!]<var>variable</var>]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
Expand All @@ -301,16 +302,33 @@ headers</description>
argument. This can be one of the following values:</p>

<dl>
<dt><code>set</code></dt>
<dd>The response header is set, replacing any previous header
with this name. The <var>value</var> may be a format string.</dd>
<dt><code>add</code></dt>
<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 <code>set</code>,
<code>append</code> or <code>merge</code> should be used instead.</dd>

<dt><code>append</code></dt>
<dd>The response header is appended to any existing header of
the same name. When a new value is merged onto an existing
header it is separated from the existing header with a comma.
This is the HTTP standard way of giving a header multiple values.</dd>

<dt><code>echo</code></dt>
<dd>Request headers with this name are echoed back in the
response headers. <var>header</var> may be a
<glossary ref="regex">regular expression</glossary>.
<var>value</var> must be omitted.</dd>

<dt><code>edit</code></dt>
<dd>If this request 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>
</dl>

<dt><code>merge</code></dt>
<dd>The response header is appended to any existing header of
the same name, unless the value to be appended already appears in the
Expand All @@ -321,32 +339,15 @@ headers</description>
all format specifiers have been processed. Values in double quotes
are considered different from otherwise identical unquoted values.</dd>

<dt><code>add</code></dt>
<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 <code>set</code>,
<code>append</code> or <code>merge</code> should be used instead.</dd>
<dt><code>set</code></dt>
<dd>The response header is set, replacing any previous header
with this name. The <var>value</var> may be a format string.</dd>

<dt><code>unset</code></dt>
<dd>The response header of this name is removed, if it exists.
If there are multiple headers of the same name, all will be
removed. <var>value</var> must be omitted.</dd>

<dt><code>echo</code></dt>
<dd>Request headers with this name are echoed back in the
response headers. <var>header</var> may be a
<glossary ref="regex">regular expression</glossary>.
<var>value</var> must be omitted.</dd>

<dt><code>edit</code></dt>
<dd>If this request 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>
</dl>

<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>merge</code>,
Expand Down

0 comments on commit e987e86

Please sign in to comment.