Commit 1dd61cfa authored by Luca Toscano's avatar Luca Toscano
Browse files

Documentation rebuild 

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1816357 13f79535-47bb-0310-9956-ffa450edef68
parent d8c74ccc

docs/manual/mod/mod_authn_socache.html.en

+0 −2
Original line number Diff line number Diff line
@@ -147,7 +147,6 @@ AuthnCacheSOCache dbm 
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable Authn caching configured anywhere</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheEnable</code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>None</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr>

</table>
@@ -187,7 +186,6 @@ AuthnCacheSOCache dbm 
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Select socache backend provider to use</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheSOCache <var>provider-name[:provider-args]</var></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>None</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr>

<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Optional provider arguments are available in

docs/manual/mod/mod_logio.html.en

+1 −1
Original line number Diff line number Diff line
@@ -109,7 +109,7 @@ 
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogIOTrackTTFB ON|OFF</code></td></tr>

<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LogIOTrackTTFB OFF</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>none</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_logio</td></tr>

<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache HTTP Server 2.4.13 and later</td></tr>

docs/manual/mod/mod_proxy_html.html.en

+24 −24
Original line number Diff line number Diff line
@@ -124,8 +124,8 @@ will generate output using the same encoding as the input.</p> 
<div class="directive-section"><h2><a name="ProxyHTMLDocType" id="ProxyHTMLDocType">ProxyHTMLDocType</a> <a name="proxyhtmldoctype" id="proxyhtmldoctype">Directive</a></h2>

<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets an HTML or XHTML document type declaration.</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLDocType <var>HTML|XHTML [Legacy]</var><br /><strong>OR</strong>

<br />ProxyHTMLDocType <var>fpi [SGML|XML]</var></code></td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLDocType HTML|XHTML [Legacy]<br /><strong>OR</strong>

<br />ProxyHTMLDocType <var>fpi</var> [SGML|XML]</code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
@@ -155,7 +155,7 @@ It will also optionally log other errors at <code class="directive"><a href="../ 
<div class="directive-section"><h2><a name="ProxyHTMLEnable" id="ProxyHTMLEnable">ProxyHTMLEnable</a> <a name="proxyhtmlenable" id="proxyhtmlenable">Directive</a></h2>

<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Turns the proxy_html filter on or off.</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLEnable <var>On|Off</var></code></td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLEnable On|Off</code></td></tr>

<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyHTMLEnable Off</code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
@@ -184,10 +184,10 @@ module for earlier 2.x versions.</td></tr> 
for earlier 2.x versions</td></tr>

</table>

<p>Specifies one or more attributes to treat as scripting events and

apply <code class="directive">ProxyHTMLURLMap</code>s to where enabled.

apply <code class="directive"><a href="#proxyhtmlurlmap">ProxyHTMLURLMap</a></code>s to where enabled.

You can specify any number of attributes in one or more

<code>ProxyHTMLEvents</code> directives.</p>

<p>Normally you'll set this globally.  If you set ProxyHTMLEvents in more than

<code class="directive">ProxyHTMLEvents</code> directives.</p>

<p>Normally you'll set this globally.  If you set <code class="directive">ProxyHTMLEvents</code> in more than

one scope so that one overrides the other, you'll need to specify a complete

set in each of those scopes.</p>

<p>A default configuration is supplied in <var>proxy-html.conf</var>
@@ -199,7 +199,7 @@ and defines the events in standard HTML 4 and XHTML 1.</p> 
<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether to fix links in inline scripts, stylesheets,

and scripting events.</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLExtended <var>On|Off</var></code></td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLExtended On|Off</code></td></tr>

<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyHTMLExtended Off</code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
@@ -208,11 +208,11 @@ and scripting events.</td></tr> 
for earlier 2.x versions</td></tr>

</table>

<p>Set to <code>Off</code>, HTML links are rewritten according to the

<code class="directive">ProxyHTMLURLMap</code> directives, but links appearing

<code class="directive"><a href="#proxyhtmlurlmap">ProxyHTMLURLMap</a></code> directives, but links appearing

in Javascript and CSS are ignored.</p>

<p>Set to <code>On</code>, all scripting events (as determined by

<code class="directive">ProxyHTMLEvents</code>) and embedded scripts or

stylesheets are also processed by the <code class="directive">ProxyHTMLURLMap</code>

<code class="directive"><a href="#proxyhtmlevents">ProxyHTMLEvents</a></code>) and embedded scripts or

stylesheets are also processed by the <code class="directive"><a href="#proxyhtmlurlmap">ProxyHTMLURLMap</a></code>

rules, according to the flags set for each rule.  Since this requires more

parsing, performance will be best if you only enable it when strictly necessary.

</p><p>
@@ -227,7 +227,7 @@ false matches. 
<div class="directive-section"><h2><a name="ProxyHTMLFixups" id="ProxyHTMLFixups">ProxyHTMLFixups</a> <a name="proxyhtmlfixups" id="proxyhtmlfixups">Directive</a></h2>

<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fixes for simple HTML errors.</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLFixups <var>[lowercase] [dospath] [reset]</var></code></td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLFixups [lowercase] [dospath] [reset]</code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
@@ -250,7 +250,7 @@ Only use them if you know you have a broken backend server.</p> 
<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables per-request interpolation of

<code class="directive">ProxyHTMLURLMap</code> rules.</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLInterp <var>On|Off</var></code></td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLInterp On|Off</code></td></tr>

<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyHTMLInterp Off</code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
@@ -259,7 +259,7 @@ Only use them if you know you have a broken backend server.</p> 
for earlier 2.x versions</td></tr>

</table>

    <p>This enables per-request interpolation in

    <code class="directive">ProxyHTMLURLMap</code> to- and from- patterns.</p>

    <code class="directive"><a href="#proxyhtmlurlmap">ProxyHTMLURLMap</a></code> to- and from- patterns.</p>

    <p>If interpolation is not enabled, all rules are pre-compiled at startup.

    With interpolation, they must be re-compiled for every request, which

    implies an extra processing overhead.  It should therefore be
@@ -279,9 +279,9 @@ for earlier 2.x versions</td></tr> 
</table>

<p>Specifies elements that have URL attributes that should be rewritten

using standard <code class="directive"><a href="#proxyhtmlurlmap">ProxyHTMLURLMap</a></code>s.

You will need one ProxyHTMLLinks directive per element,

You will need one <code class="directive">ProxyHTMLLinks</code> directive per element,

but it can have any number of attributes.</p>

<p>Normally you'll set this globally.  If you set ProxyHTMLLinks in more than

<p>Normally you'll set this globally.  If you set <code class="directive">ProxyHTMLLinks</code> in more than

one scope so that one overrides the other, you'll need to specify a complete

set in each of those scopes.</p>

<p>A default configuration is supplied in <var>proxy-html.conf</var>
@@ -308,7 +308,7 @@ ProxyHTMLLinks script src for</pre> 
<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Turns on or off extra pre-parsing of metadata in HTML

<code>&lt;head&gt;</code> sections.</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLMeta <var>On|Off</var></code></td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLMeta On|Off</code></td></tr>

<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyHTMLMeta Off</code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
@@ -321,7 +321,7 @@ module for earlier 2.x versions.</td></tr> 
    <p>If not required, turning ProxyHTMLMeta Off will give a small

    performance boost by skipping this parse step.  However, it

    is sometimes necessary for internationalisation to work correctly.</p>

    <p>ProxyHTMLMeta has two effects.  Firstly and most importantly

    <p><code class="directive">ProxyHTMLMeta</code> has two effects.  Firstly and most importantly

    it enables detection of character encodings declared in the form</p>

    <pre>&lt;meta http-equiv="Content-Type" content="text/html;charset=<var>foo</var>"&gt;</pre>

    <p>or, in the case of an XHTML document, an XML declaration.
@@ -330,10 +330,10 @@ module for earlier 2.x versions.</td></tr> 
    document is <var>utf-8</var> (unicode) or a subset such as ASCII.

    You may also be able to dispense with it where documents use a

    default declared using <code class="directive"><a href="../mod/mod_xml2enc.html#xml2encdefault">xml2EncDefault</a></code>, but that risks propagating an

    incorrect declaration.  A <code class="directive">ProxyHTMLCharsetOut</code>

    incorrect declaration.  A <code class="directive"><a href="#proxyhtmlcharsetout">ProxyHTMLCharsetOut</a></code>

    can remove that risk, but is likely to be a bigger processing

    overhead than enabling ProxyHTMLMeta.</p>

    <p>The other effect of enabling ProxyHTMLMeta is to parse all

    <p>The other effect of enabling <code class="directive">ProxyHTMLMeta</code> is to parse all

    <code>&lt;meta http-equiv=...&gt;</code> declarations and convert

    them to real HTTP headers, in keeping with the original purpose

    of this form of the HTML &lt;meta&gt; element.</p>
@@ -352,7 +352,7 @@ module for earlier 2.x versions.</td></tr> 
<div class="directive-section"><h2><a name="ProxyHTMLStripComments" id="ProxyHTMLStripComments">ProxyHTMLStripComments</a> <a name="proxyhtmlstripcomments" id="proxyhtmlstripcomments">Directive</a></h2>

<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether to strip HTML comments.</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLStripComments <var>On|Off</var></code></td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLStripComments On|Off</code></td></tr>

<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyHTMLStripComments Off</code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
@@ -438,20 +438,20 @@ A string of the form <code>${varname|default}</code> will be replaced by the 
value of environment variable <code>varname</code>.  If that is unset, it

is replaced by <code>default</code>.  The <code>|default</code> is optional.</p>

<p>NOTE: interpolation will only be enabled if

<code class="directive">ProxyHTMLInterp</code> is <var>On</var>.</p>

<code class="directive"><a href="#proxyhtmlinterp">ProxyHTMLInterp</a></code> is <var>On</var>.</p>

</dd>



<dt>v</dt>

<dd><p>Interpolate environment variables in <code>from-pattern</code>.

Patterns supported are as above.</p>

<p>NOTE: interpolation will only be enabled if

<code class="directive">ProxyHTMLInterp</code> is <var>On</var>.</p>

<code class="directive"><a href="#proxyhtmlinterp">ProxyHTMLInterp</a></code> is <var>On</var>.</p>

</dd>

</dl>



<p>The optional fourth <strong>cond</strong> argument defines a condition

that will be evaluated per Request, provided

<code class="directive">ProxyHTMLInterp</code> is <var>On</var>.

<code class="directive"><a href="#proxyhtmlinterp">ProxyHTMLInterp</a></code> is <var>On</var>.

If the condition evaluates FALSE the map will not be applied in this request.

If TRUE, or if no condition is defined, the map is applied.</p>

<p>A <strong>cond</strong> is evaluated by the <a href="../expr.html">Expression Parser</a>.  In addition, the simpler syntax of conditions

docs/manual/mod/mod_ssl.html.en

+0 −3
Original line number Diff line number Diff line
@@ -1780,7 +1780,6 @@ server to proxy SSL/TLS requests.</p> 
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA certificates to be used by the proxy for choosing a certificate</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificateChainFile <em>filename</em></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>

</table>
@@ -1810,7 +1809,6 @@ SSLProxyCACertificateFile</a></code>.</p> 
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded client certificates and keys to be used by the proxy</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificateFile <em>filename</em></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>

</table>
@@ -1836,7 +1834,6 @@ or additionally to <code>SSLProxyMachineCertificatePath</code>. 
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded client certificates and keys to be used by the proxy</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificatePath <em>directory</em></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>

</table>

docs/manual/mod/mod_substitute.html.en

+3 −0
Original line number Diff line number Diff line
@@ -86,6 +86,9 @@ 
        or regex of a subsequent one.</dd>

    </dl>



    <p>The <var>substitution</var> is may contain literal text and regular

    expression backreferences</p>



    <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">&lt;Location "/"&gt;

    AddOutputFilterByType SUBSTITUTE text/html

    Substitute "s/foo/bar/ni"