From: Luca Toscano Date: Sun, 26 Nov 2017 00:15:03 +0000 (+0000) Subject: Documentation rebuild X-Git-Tag: 2.4.30~250 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7ac69ce13242245a64948bc2a3db2c5474334cd9;p=apache Documentation rebuild git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1816357 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_authn_socache.html.en b/docs/manual/mod/mod_authn_socache.html.en index 6809a8ba24..bd8e76c0f5 100644 --- a/docs/manual/mod/mod_authn_socache.html.en +++ b/docs/manual/mod/mod_authn_socache.html.en @@ -147,7 +147,6 @@ AuthnCacheSOCache dbm Description:Enable Authn caching configured anywhere Syntax:AuthnCacheEnable Context:server config -Override:None Status:Base Module:mod_authn_socache @@ -187,7 +186,6 @@ AuthnCacheSOCache dbm Description:Select socache backend provider to use Syntax:AuthnCacheSOCache provider-name[:provider-args] Context:server config -Override:None Status:Base Module:mod_authn_socache Compatibility:Optional provider arguments are available in diff --git a/docs/manual/mod/mod_logio.html.en b/docs/manual/mod/mod_logio.html.en index 844ab5541b..766bb9b829 100644 --- a/docs/manual/mod/mod_logio.html.en +++ b/docs/manual/mod/mod_logio.html.en @@ -109,7 +109,7 @@ Syntax:LogIOTrackTTFB ON|OFF Default:LogIOTrackTTFB OFF Context:server config, virtual host, directory, .htaccess -Override:none +Override:All Status:Extension Module:mod_logio Compatibility:Apache HTTP Server 2.4.13 and later diff --git a/docs/manual/mod/mod_proxy_html.html.en b/docs/manual/mod/mod_proxy_html.html.en index 904efa68b3..d7e07e424e 100644 --- a/docs/manual/mod/mod_proxy_html.html.en +++ b/docs/manual/mod/mod_proxy_html.html.en @@ -124,8 +124,8 @@ will generate output using the same encoding as the input.

ProxyHTMLDocType Directive

- + @@ -155,7 +155,7 @@ It will also optionally log other errors at

ProxyHTMLEnable Directive

Description:Sets an HTML or XHTML document type declaration.
Syntax:ProxyHTMLDocType HTML|XHTML [Legacy]
OR -
ProxyHTMLDocType fpi [SGML|XML]
Syntax:ProxyHTMLDocType HTML|XHTML [Legacy]
OR +
ProxyHTMLDocType fpi [SGML|XML]
Context:server config, virtual host, directory
Status:Base
Module:mod_proxy_html
- + @@ -184,10 +184,10 @@ module for earlier 2.x versions. for earlier 2.x versions
Description:Turns the proxy_html filter on or off.
Syntax:ProxyHTMLEnable On|Off
Syntax:ProxyHTMLEnable On|Off
Default:ProxyHTMLEnable Off
Context:server config, virtual host, directory
Status:Base

Specifies one or more attributes to treat as scripting events and -apply ProxyHTMLURLMaps to where enabled. +apply ProxyHTMLURLMaps to where enabled. You can specify any number of attributes in one or more -ProxyHTMLEvents directives.

-

Normally you'll set this globally. If you set ProxyHTMLEvents in more than +ProxyHTMLEvents directives.

+

Normally you'll set this globally. If you set ProxyHTMLEvents in more than one scope so that one overrides the other, you'll need to specify a complete set in each of those scopes.

A default configuration is supplied in proxy-html.conf @@ -199,7 +199,7 @@ and defines the events in standard HTML 4 and XHTML 1.

- + @@ -208,11 +208,11 @@ and scripting events. for earlier 2.x versions
Description:Determines whether to fix links in inline scripts, stylesheets, and scripting events.
Syntax:ProxyHTMLExtended On|Off
Syntax:ProxyHTMLExtended On|Off
Default:ProxyHTMLExtended Off
Context:server config, virtual host, directory
Status:Base

Set to Off, HTML links are rewritten according to the -ProxyHTMLURLMap directives, but links appearing +ProxyHTMLURLMap directives, but links appearing in Javascript and CSS are ignored.

Set to On, all scripting events (as determined by -ProxyHTMLEvents) and embedded scripts or -stylesheets are also processed by the ProxyHTMLURLMap +ProxyHTMLEvents) and embedded scripts or +stylesheets are also processed by the ProxyHTMLURLMap 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.

@@ -227,7 +227,7 @@ false matches.

ProxyHTMLFixups Directive

- + @@ -242,7 +242,7 @@ for earlier 2.x versions

Take care when using these. The fixes will correct certain authoring mistakes, but risk also erroneously fixing links that were correct to start with. -Only use them if you know you have a broken backend server.

+Only use them if you know you have a broken backend server.

top
@@ -250,7 +250,7 @@ Only use them if you know you have a broken backend server.

Description:Fixes for simple HTML errors.
Syntax:ProxyHTMLFixups [lowercase] [dospath] [reset]
Syntax:ProxyHTMLFixups [lowercase] [dospath] [reset]
Context:server config, virtual host, directory
Status:Base
Module:mod_proxy_html
- + @@ -259,7 +259,7 @@ Only use them if you know you have a broken backend server.

for earlier 2.x versions
Description:Enables per-request interpolation of ProxyHTMLURLMap rules.
Syntax:ProxyHTMLInterp On|Off
Syntax:ProxyHTMLInterp On|Off
Default:ProxyHTMLInterp Off
Context:server config, virtual host, directory
Status:Base

This enables per-request interpolation in - ProxyHTMLURLMap to- and from- patterns.

+ ProxyHTMLURLMap to- and from- patterns.

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

Specifies elements that have URL attributes that should be rewritten using standard ProxyHTMLURLMaps. -You will need one ProxyHTMLLinks directive per element, +You will need one ProxyHTMLLinks directive per element, but it can have any number of attributes.

-

Normally you'll set this globally. If you set ProxyHTMLLinks in more than +

Normally you'll set this globally. If you set ProxyHTMLLinks in more than one scope so that one overrides the other, you'll need to specify a complete set in each of those scopes.

A default configuration is supplied in proxy-html.conf @@ -308,7 +308,7 @@ ProxyHTMLLinks script src for - + @@ -321,7 +321,7 @@ module for earlier 2.x versions.

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.

-

ProxyHTMLMeta has two effects. Firstly and most importantly +

ProxyHTMLMeta has two effects. Firstly and most importantly it enables detection of character encodings declared in the form

<meta http-equiv="Content-Type" content="text/html;charset=foo">

or, in the case of an XHTML document, an XML declaration. @@ -330,10 +330,10 @@ module for earlier 2.x versions. document is utf-8 (unicode) or a subset such as ASCII. You may also be able to dispense with it where documents use a default declared using xml2EncDefault, but that risks propagating an - incorrect declaration. A ProxyHTMLCharsetOut + incorrect declaration. A ProxyHTMLCharsetOut can remove that risk, but is likely to be a bigger processing overhead than enabling ProxyHTMLMeta.

-

The other effect of enabling ProxyHTMLMeta is to parse all +

The other effect of enabling ProxyHTMLMeta is to parse all <meta http-equiv=...> declarations and convert them to real HTTP headers, in keeping with the original purpose of this form of the HTML <meta> element.

@@ -352,7 +352,7 @@ module for earlier 2.x versions.

ProxyHTMLStripComments Directive

Description:Turns on or off extra pre-parsing of metadata in HTML <head> sections.
Syntax:ProxyHTMLMeta On|Off
Syntax:ProxyHTMLMeta On|Off
Default:ProxyHTMLMeta Off
Context:server config, virtual host, directory
Status:Base
- + @@ -438,20 +438,20 @@ A string of the form ${varname|default} will be replaced by the value of environment variable varname. If that is unset, it is replaced by default. The |default is optional.

NOTE: interpolation will only be enabled if -ProxyHTMLInterp is On.

+ProxyHTMLInterp is On.

v

Interpolate environment variables in from-pattern. Patterns supported are as above.

NOTE: interpolation will only be enabled if -ProxyHTMLInterp is On.

+ProxyHTMLInterp is On.

The optional fourth cond argument defines a condition that will be evaluated per Request, provided -ProxyHTMLInterp is On. +ProxyHTMLInterp is On. 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.

A cond is evaluated by the Expression Parser. In addition, the simpler syntax of conditions diff --git a/docs/manual/mod/mod_ssl.html.en b/docs/manual/mod/mod_ssl.html.en index b838b9bf49..5efafd7786 100644 --- a/docs/manual/mod/mod_ssl.html.en +++ b/docs/manual/mod/mod_ssl.html.en @@ -1780,7 +1780,6 @@ server to proxy SSL/TLS requests.

-
Description:Determines whether to strip HTML comments.
Syntax:ProxyHTMLStripComments On|Off
Syntax:ProxyHTMLStripComments On|Off
Default:ProxyHTMLStripComments Off
Context:server config, virtual host, directory
Status:Base
Description:File of concatenated PEM-encoded CA certificates to be used by the proxy for choosing a certificate
Syntax:SSLProxyMachineCertificateChainFile filename
Context:server config
Override:Not applicable
Status:Extension
Module:mod_ssl
@@ -1810,7 +1809,6 @@ SSLProxyCACertificateFile.

Description:File of concatenated PEM-encoded client certificates and keys to be used by the proxy Syntax:SSLProxyMachineCertificateFile filename Context:server config -Override:Not applicable Status:Extension Module:mod_ssl @@ -1836,7 +1834,6 @@ or additionally to SSLProxyMachineCertificatePath. Description:Directory of PEM-encoded client certificates and keys to be used by the proxy Syntax:SSLProxyMachineCertificatePath directory Context:server config -Override:Not applicable Status:Extension Module:mod_ssl diff --git a/docs/manual/mod/mod_substitute.html.en b/docs/manual/mod/mod_substitute.html.en index 18a4eb5374..61e3f41172 100644 --- a/docs/manual/mod/mod_substitute.html.en +++ b/docs/manual/mod/mod_substitute.html.en @@ -86,6 +86,9 @@ or regex of a subsequent one. +

The substitution is may contain literal text and regular + expression backreferences

+

Example

<Location "/">
     AddOutputFilterByType SUBSTITUTE text/html
     Substitute "s/foo/bar/ni"
diff --git a/docs/manual/mod/overrides.html.en b/docs/manual/mod/overrides.html.en
index 7f46bb45f4..3b2595829f 100644
--- a/docs/manual/mod/overrides.html.en
+++ b/docs/manual/mod/overrides.html.en
@@ -122,61 +122,63 @@ presence or absence of a specific module
 from the client
 LimitXMLRequestBodycore
 Limits the size of an XML-based request body
-LuaCodeCachemod_lua
-Configure the compiled code cache.
-LuaHookAccessCheckermod_lua
-Provide a hook for the access_checker phase of request processing
-LuaHookAuthCheckermod_lua
-Provide a hook for the auth_checker phase of request processing
-LuaHookCheckUserIDmod_lua
-Provide a hook for the check_user_id phase of request processing
-LuaHookFixupsmod_lua
-Provide a hook for the fixups phase of a request
+LogIOTrackTTFBmod_logio
+Enable tracking of time to first byte (TTFB)
+LuaCodeCachemod_lua
+Configure the compiled code cache.
+LuaHookAccessCheckermod_lua
+Provide a hook for the access_checker phase of request processing
+LuaHookAuthCheckermod_lua
+Provide a hook for the auth_checker phase of request processing
+LuaHookCheckUserIDmod_lua
+Provide a hook for the check_user_id phase of request processing
+LuaHookFixupsmod_lua
+Provide a hook for the fixups phase of a request
 processing
-LuaHookInsertFiltermod_lua
-Provide a hook for the insert_filter phase of request processing
-LuaHookLogmod_lua
-Provide a hook for the access log phase of a request
+LuaHookInsertFiltermod_lua
+Provide a hook for the insert_filter phase of request processing
+LuaHookLogmod_lua
+Provide a hook for the access log phase of a request
 processing
-LuaHookMapToStoragemod_lua
-Provide a hook for the map_to_storage phase of request processing
-LuaHookTranslateNamemod_lua
-Provide a hook for the translate name phase of request processing
-LuaHookTypeCheckermod_lua
-Provide a hook for the type_checker phase of request processing
-LuaInheritmod_lua
-Controls how parent configuration sections are merged into children
-LuaMapHandlermod_lua
-Map a path to a lua handler
-LuaPackageCPathmod_lua
-Add a directory to lua's package.cpath
-LuaPackagePathmod_lua
-Add a directory to lua's package.path
-LuaQuickHandlermod_lua
-Provide a hook for the quick handler of request processing
-LuaRootmod_lua
-Specify the base path for resolving relative paths for mod_lua directives
-LuaScopemod_lua
-One of once, request, conn, thread -- default is once
-RLimitCPUcore
-Limits the CPU consumption of processes launched
+LuaHookMapToStoragemod_lua
+Provide a hook for the map_to_storage phase of request processing
+LuaHookTranslateNamemod_lua
+Provide a hook for the translate name phase of request processing
+LuaHookTypeCheckermod_lua
+Provide a hook for the type_checker phase of request processing
+LuaInheritmod_lua
+Controls how parent configuration sections are merged into children
+LuaMapHandlermod_lua
+Map a path to a lua handler
+LuaPackageCPathmod_lua
+Add a directory to lua's package.cpath
+LuaPackagePathmod_lua
+Add a directory to lua's package.path
+LuaQuickHandlermod_lua
+Provide a hook for the quick handler of request processing
+LuaRootmod_lua
+Specify the base path for resolving relative paths for mod_lua directives
+LuaScopemod_lua
+One of once, request, conn, thread -- default is once
+RLimitCPUcore
+Limits the CPU consumption of processes launched
 by Apache httpd children
-RLimitMEMcore
-Limits the memory consumption of processes launched
+RLimitMEMcore
+Limits the memory consumption of processes launched
 by Apache httpd children
-RLimitNPROCcore
-Limits the number of processes that can be launched by
+RLimitNPROCcore
+Limits the number of processes that can be launched by
 processes launched by Apache httpd children
-ServerSignaturecore
-Configures the footer on server-generated documents
-SSIErrorMsgmod_include
-Error message displayed when there is an SSI
+ServerSignaturecore
+Configures the footer on server-generated documents
+SSIErrorMsgmod_include
+Error message displayed when there is an SSI
 error
-SSITimeFormatmod_include
-Configures the format in which date strings are
+SSITimeFormatmod_include
+Configures the format in which date strings are
 displayed
-SSIUndefinedEchomod_include
-String displayed when an unset variable is echoed
+SSIUndefinedEchomod_include
+String displayed when an unset variable is echoed
top

AuthConfig

The following directives are allowed in .htaccess files when @@ -670,39 +672,6 @@ except the named ones Controls the default access state and the order in which Allow and Deny are evaluated. -

top

none

-

- [This section has no description. It's possible that the documentation is - incomplete, or that the directives here have an incorrect or misspelled - Override type. Please consider reporting this in the - comments section.] -

- - -
LogIOTrackTTFBmod_logio
Enable tracking of time to first byte (TTFB)
top

None

-

- [This section has no description. It's possible that the documentation is - incomplete, or that the directives here have an incorrect or misspelled - Override type. Please consider reporting this in the - comments section.] -

- - - - -
AuthnCacheEnablemod_authn_socache
Enable Authn caching configured anywhere
AuthnCacheSOCachemod_authn_socache
Select socache backend provider to use
top

Not applicable

-

- [This section has no description. It's possible that the documentation is - incomplete, or that the directives here have an incorrect or misspelled - Override type. Please consider reporting this in the - comments section.] -

- - - - - -
SSLProxyMachineCertificateChainFilemod_ssl
File of concatenated PEM-encoded CA certificates to be used by the proxy for choosing a certificate
SSLProxyMachineCertificateFilemod_ssl
File of concatenated PEM-encoded client certificates and keys to be used by the proxy
SSLProxyMachineCertificatePathmod_ssl
Directory of PEM-encoded client certificates and keys to be used by the proxy
top

Options

The following directives are allowed in .htaccess files when diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index db73fb4f1e..7f6e6247e6 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -740,19 +740,19 @@ proxied ProxyHTMLBufSize bytessvdBSets the buffer size increment for buffering inline scripts and stylesheets. ProxyHTMLCharsetOut Charset | *svdBSpecify a charset for mod_proxy_html output. -ProxyHTMLDocType HTML|XHTML [Legacy]
OR -
ProxyHTMLDocType fpi [SGML|XML]svdBSets an HTML or XHTML document type declaration. -ProxyHTMLEnable On|Off Off svdBTurns the proxy_html filter on or off. +ProxyHTMLDocType HTML|XHTML [Legacy]
OR +
ProxyHTMLDocType fpi [SGML|XML]svdBSets an HTML or XHTML document type declaration. +ProxyHTMLEnable On|Off Off svdBTurns the proxy_html filter on or off. ProxyHTMLEvents attribute [attribute ...]svdBSpecify attributes to treat as scripting events. -ProxyHTMLExtended On|Off Off svdBDetermines whether to fix links in inline scripts, stylesheets, +ProxyHTMLExtended On|Off Off svdBDetermines whether to fix links in inline scripts, stylesheets, and scripting events. -ProxyHTMLFixups [lowercase] [dospath] [reset]svdBFixes for simple HTML errors. -ProxyHTMLInterp On|Off Off svdBEnables per-request interpolation of +ProxyHTMLFixups [lowercase] [dospath] [reset]svdBFixes for simple HTML errors. +ProxyHTMLInterp On|Off Off svdBEnables per-request interpolation of ProxyHTMLURLMap rules. ProxyHTMLLinks element attribute [attribute2 ...]svdBSpecify HTML elements that have URL attributes to be rewritten. -ProxyHTMLMeta On|Off Off svdBTurns on or off extra pre-parsing of metadata in HTML +ProxyHTMLMeta On|Off Off svdBTurns on or off extra pre-parsing of metadata in HTML <head> sections. -ProxyHTMLStripComments On|Off Off svdBDetermines whether to strip HTML comments. +ProxyHTMLStripComments On|Off Off svdBDetermines whether to strip HTML comments. ProxyHTMLURLMap from-pattern to-pattern [flags] [cond]svdBDefines a rule to rewrite HTML links ProxyIOBufferSize bytes 8192 svEDetermine size of internal data throughput buffer <ProxyMatch regex> ...</ProxyMatch>svEContainer for directives applied to regular-expression-matched