From: Daniel Gruno Date: Fri, 4 May 2012 15:02:21 +0000 (+0000) Subject: Backporting syntax highlighting for mod_b|c|d*.xml X-Git-Tag: 2.4.3~484 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d43c4bcbfb0e0f14fa77514afa31665aa41ac4c7;p=apache Backporting syntax highlighting for mod_b|c|d*.xml git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1334011 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_buffer.xml b/docs/manual/mod/mod_buffer.xml index 7bef039f7a..1b6d89e4fe 100644 --- a/docs/manual/mod/mod_buffer.xml +++ b/docs/manual/mod/mod_buffer.xml @@ -55,7 +55,9 @@ AddOutputFilterByType directives.

Using buffer with mod_include - AddOutputFilterByType INCLUDES;BUFFER text/html
+ + AddOutputFilterByType INCLUDES;BUFFER text/html + The buffer filters read the request/response into diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml index 572fa79d50..6c03be4489 100644 --- a/docs/manual/mod/mod_cache.xml +++ b/docs/manual/mod/mod_cache.xml @@ -112,6 +112,12 @@ supported by this module. The htcacheclean tool is provided to list cached URLs, remove cached URLs, or to maintain the size of the disk cache within size and inode limits. +
mod_cache_socache
+
Implements a shared object cache based storage manager. Headers and + bodies are stored together beneath a single key based on the URL of the + response being cached. Multiple content negotiated responses can + be stored concurrently, however the caching of partial content is not + supported by this module.

Further details, discussion, and examples, are provided in the @@ -123,6 +129,7 @@ mod_cache_disk + mod_cache_socache CacheRoot @@ -130,33 +137,36 @@ CacheDirLength CacheMinFileSize CacheMaxFileSize + CacheSocache + CacheSocacheMaxTime + CacheSocacheMinTime + CacheSocacheMaxSize + CacheSocacheReadSize + CacheSocacheReadTime

Sample Configuration Sample httpd.conf - #
- # Sample Cache Configuration
- #
- LoadModule cache_module modules/mod_cache.so
-
- <IfModule mod_cache.c>
- - LoadModule cache_disk_module modules/mod_cache_disk.so
- <IfModule mod_cache_disk.c>
- - CacheRoot c:/cacheroot
- CacheEnable disk /
- CacheDirLevels 5
- CacheDirLength 3
- - </IfModule>
-
- # When acting as a proxy, don't cache the list of security updates
- CacheDisable http://security.update.server/update-list/
- - </IfModule> + +# +# Sample Cache Configuration +# +LoadModule cache_module modules/mod_cache.so +<IfModule mod_cache.c> + LoadModule cache_disk_module modules/mod_cache_disk.so + <IfModule mod_cache_disk.c> + CacheRoot c:/cacheroot + CacheEnable disk / + CacheDirLevels 5 + CacheDirLength 3 + </IfModule> + + # When acting as a proxy, don't cache the list of security updates + CacheDisable http://security.update.server/update-list/ +</IfModule> +
@@ -210,16 +220,16 @@
Example configuration Enabling the cache lock - #
- # Enable the cache lock
- #
- <IfModule mod_cache.c>
- - CacheLock on
- CacheLockPath /tmp/mod_cache-lock
- CacheLockMaxAge 5
- - </IfModule> + +# +# Enable the cache lock +# +<IfModule mod_cache.c> + CacheLock on + CacheLockPath /tmp/mod_cache-lock + CacheLockMaxAge 5 +</IfModule> +
@@ -253,33 +263,33 @@ place the CACHE filter before the DEFLATE filter as in the example below:

- - # Cache content before optional compression
- CacheQuickHandler off
- AddOutputFilterByType CACHE;DEFLATE text/plain

- + +# Cache content before optional compression +CacheQuickHandler off +AddOutputFilterByType CACHE;DEFLATE text/plain +

Another option is to have content cached before personalisation is applied by mod_include (or another content processing filter). In this example templates containing tags understood by mod_include are cached before being parsed:

- - # Cache content before mod_include and mod_deflate
- CacheQuickHandler off
- AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html

- + +# Cache content before mod_include and mod_deflate +CacheQuickHandler off +AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html +

You may place the CACHE filter anywhere you wish within the filter chain. In this example, content is cached after being parsed by mod_include, but before being processed by mod_deflate:

- - # Cache content between mod_include and mod_deflate
- CacheQuickHandler off
- AddOutputFilterByType INCLUDES;CACHE;DEFLATE text/html

- + +# Cache content between mod_include and mod_deflate +CacheQuickHandler off +AddOutputFilterByType INCLUDES;CACHE;DEFLATE text/html + Warning:If the location of the CACHE filter in the filter chain is changed for any reason, @@ -297,28 +307,31 @@ LogFormat directive as follows:

- + LogFormat "%{cache-status}e ..." - +

Based on the caching decision made, the reason is also written to the - subprocess environment under one the following three keys, as appropriate:

+ subprocess environment under one the following four keys, as appropriate:

cache-hit
The response was served from cache.
cache-revalidate
The response was stale and was successfully revalidated, then served from cache.
cache-miss
The response was served from the upstream server.
+
cache-invalidate
The cached entity was invalidated by a request + method other than GET or HEAD.

This makes it possible to support conditional logging of cached requests as per the following example:

- - CustomLog cached-requests.log common env=cache-hit
- CustomLog uncached-requests.log common env=cache-miss
- CustomLog revalidated-requests.log common env=cache-revalidate
- + +CustomLog cached-requests.log common env=cache-hit +CustomLog uncached-requests.log common env=cache-miss +CustomLog revalidated-requests.log common env=cache-revalidate +CustomLog invalidated-requests.log common env=cache-invalidate +

For module authors, a hook called cache_status is available, allowing modules to respond to the caching outcomes above in customised @@ -345,7 +358,10 @@ manager the content is cacheable. cache_type disk instructs mod_cache to use the disk based storage manager - implemented by mod_cache_disk.

+ implemented by mod_cache_disk. cache_type + socache instructs mod_cache to use the + shared object cache based storage manager implemented by + mod_cache_socache.

In the event that the URL space overlaps between different CacheEnable directives (as in the example below), each possible storage manager will be run until the first one that @@ -360,37 +376,37 @@ manager also be used to specify remote sites and proxy protocols which caching should be enabled for.

- - # Cache content
- <Location /foo>
- - CacheEnable disk
- - </Location>

- # Cache regex
- <LocationMatch foo$>
- - CacheEnable disk
- - </LocationMatch>

- # Cache proxied url's
- CacheEnable disk /

- # Cache FTP-proxied url's
- CacheEnable disk ftp://

- # Cache content from www.example.org
- CacheEnable disk http://www.example.org/
- + +# Cache content +<Location /foo> + CacheEnable disk +</Location> + +# Cache regex +<LocationMatch foo$> + CacheEnable disk +</LocationMatch> + +# Cache proxied url's +CacheEnable disk / + +# Cache FTP-proxied url's +CacheEnable disk ftp:// + +# Cache content from www.example.org +CacheEnable disk http://www.example.org/ +

A hostname starting with a "*" matches all hostnames with that suffix. A hostname starting with "." matches all hostnames containing the domain components that follow.

- - # Match www.example.org, and fooexample.org
- CacheEnable disk http://*example.org/
- # Match www.example.org, but not fooexample.org
- CacheEnable disk http://.example.org/
- + +# Match www.example.org, and fooexample.org +CacheEnable disk http://*example.org/ +# Match www.example.org, but not fooexample.org +CacheEnable disk http://.example.org/ +

The no-cache environment variable can be set to disable caching on a finer grained set of resources in versions @@ -414,7 +430,9 @@ manager url-string.

Example + CacheDisable /local_files +

If used in a Location directive, @@ -422,11 +440,11 @@ manager is used, caching for the whole location will be disabled.

Example - <Location /foo>
- - CacheDisable on
- - </Location>
+ +<Location /foo> + CacheDisable on +</Location> +

The no-cache environment variable can be set to @@ -453,9 +471,9 @@ manager server. Thus, documents will be out of date at most this number of seconds. This maximum value is enforced even if an expiry date was supplied with the document.

- + CacheMaxExpire 604800 - + @@ -476,9 +494,9 @@ manager server. This is only used if no valid expire time was supplied with the document.

- + CacheMinExpire 3600 - + @@ -499,9 +517,9 @@ manager with the document. The value specified with the CacheMaxExpire directive does not override this setting.

- + CacheDefaultExpire 86400 - + @@ -529,9 +547,9 @@ header. CacheDefaultExpire directive will be used to generate an expiration date.

- + CacheIgnoreNoLastMod On - + @@ -552,9 +570,9 @@ header. if the request contains no-cache header values. Resources requiring authorization will never be cached.

- + CacheIgnoreCacheControl On - + Warning: This directive will allow serving from the cache even if the client has @@ -584,9 +602,9 @@ header. view the request is treated as if having no query string when this directive is enabled.

- + CacheIgnoreQueryString On - + @@ -623,9 +641,9 @@ LastModified date. CacheMaxExpire, then the latter takes precedence.

- + CacheLastModifiedFactor 0.5 - + @@ -666,11 +684,15 @@ LastModified date. None.

Example 1 + CacheIgnoreHeaders Set-Cookie + Example 2 + CacheIgnoreHeaders None + Warning: @@ -709,11 +731,15 @@ LastModified date. identifiers. Otherwise, each identifier is added to the list.

Example 1 + CacheIgnoreURLSessionIdentifiers jsessionid + Example 2 + CacheIgnoreURLSessionIdentifiers None + @@ -740,9 +766,9 @@ LastModified date. the origin server, and the response may be fulfilled from cache if the backend resource has not changed.

- + CacheStoreExpired On - + @@ -766,9 +792,9 @@ LastModified date. private header values. Resources requiring authorization will never be cached.

- + CacheStorePrivate On - + Warning: This directive will allow caching even if the upstream server has @@ -800,9 +826,9 @@ LastModified date. no-store header values. Resources requiring authorization will never be cached.

- + CacheStoreNoStore On - + Warning: As described in RFC 2616, the no-store directive is intended to @@ -831,10 +857,10 @@ LastModified date.

In a minimal configuration the following directive is all that is needed to enable the thundering herd lock in the default system temp directory.

- - # Enable cache lock
- CacheLock on

- + +# Enable cache lock +CacheLock on + @@ -901,21 +927,21 @@ LastModified date. slower than the default, it allows the cache to be used in cases where full processing is required, such as when content is subject to authorisation.

- - # Run cache as a normal handler
- CacheQuickHandler off

- + +# Run cache as a normal handler +CacheQuickHandler off +

It is also possible, when the quick handler is disabled, for the administrator to choose the precise location within the filter chain where caching is to be performed, by adding the CACHE filter to the chain.

- - # Cache content before mod_include and mod_deflate
- CacheQuickHandler off
- AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html

- + +# Cache content before mod_include and mod_deflate +CacheQuickHandler off +AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html +

If the CACHE filter is specified more than once, the last instance will apply.

@@ -953,14 +979,14 @@ LastModified date. server and was not served from cache. - - # Enable the X-Cache header
- CacheHeader on
- + +# Enable the X-Cache header +CacheHeader on + - - X-Cache: HIT from localhost
- + + X-Cache: HIT from localhost + @@ -993,10 +1019,10 @@ LastModified date. is used, this directive must appear within a server or virtual host context, otherwise the setting will be ignored.

- - # Enable the X-Cache-Detail header
- CacheDetailHeader on
- + +# Enable the X-Cache-Detail header +CacheDetailHeader on + X-Cache-Detail: "conditional cache hit: entity refreshed" from localhost
@@ -1024,10 +1050,10 @@ LastModified date. should be cached beneath the same cache key, a new base URL can be specified with this directive.

- - # Override the base URL of the cache key.
- CacheKeyBaseURL http://www.example.com/
- + +# Override the base URL of the cache key. +CacheKeyBaseURL http://www.example.com/ + Take care when setting this directive. If two separate virtual hosts are accidentally given the same base URL, entries from one virtual host @@ -1056,10 +1082,10 @@ LastModified date. and the raw 5xx responses returned to the client on request, the 5xx response so returned to the client will not invalidate the content in the cache.

- - # Serve stale data on error.
- CacheStaleOnError on
- + +# Serve stale data on error. +CacheStaleOnError on + diff --git a/docs/manual/mod/mod_cache_disk.xml b/docs/manual/mod/mod_cache_disk.xml index b159c6ad1d..69a65e724d 100644 --- a/docs/manual/mod/mod_cache_disk.xml +++ b/docs/manual/mod/mod_cache_disk.xml @@ -66,6 +66,9 @@ cache.

 +mod_cache +mod_cache_socache +Caching Guide CacheRoot @@ -86,9 +89,9 @@ stored module="mod_cache_disk">CacheDirLength directives define the structure of the directories under the specified root directory.

- + CacheRoot c:/cacheroot - + @@ -164,9 +167,9 @@ cache minimum size, in bytes, for a document to be considered for storage in the cache.

- + CacheMinFileSize 64 - + @@ -187,9 +190,9 @@ cache maximum size, in bytes, for a document to be considered for storage in the cache.

- + CacheMaxFileSize 64000 - + @@ -217,9 +220,9 @@ cache

This directive only takes effect when the data is being saved to the cache, as opposed to data being served from the cache.

- + CacheReadSize 102400 - + @@ -251,9 +254,9 @@ cache ensure that the server does not buffer excessively should data arrive faster than expected.

- + CacheReadTime 1000 - + diff --git a/docs/manual/mod/mod_cern_meta.xml b/docs/manual/mod/mod_cern_meta.xml index d5c5b9edaa..e25f75782b 100644 --- a/docs/manual/mod/mod_cern_meta.xml +++ b/docs/manual/mod/mod_cern_meta.xml @@ -81,18 +81,18 @@ files accessed. Set to "." to look in the same directory as the file:

- MetaDir . + MetaDir .

Or, to set it to a subdirectory of the directory containing the files:

- MetaDir .meta + MetaDir .meta MetaSuffix -File name suffix for the file containg CERN-style +File name suffix for the file containing CERN-style meta information MetaSuffix suffix MetaSuffix .meta diff --git a/docs/manual/mod/mod_cgi.xml b/docs/manual/mod/mod_cgi.xml index 3a256010d5..b459c48bb6 100644 --- a/docs/manual/mod/mod_cgi.xml +++ b/docs/manual/mod/mod_cgi.xml @@ -168,7 +168,9 @@

Example + ScriptLog logs/cgi_log +

This log will be opened as the user the child processes run diff --git a/docs/manual/mod/mod_cgid.xml b/docs/manual/mod/mod_cgid.xml index 01e660dd2f..75c5be58f3 100644 --- a/docs/manual/mod/mod_cgid.xml +++ b/docs/manual/mod/mod_cgid.xml @@ -90,7 +90,9 @@ the cgi daemon write in the directory where the socket is located.

Example + ScriptSock /var/run/cgid.sock + diff --git a/docs/manual/mod/mod_charset_lite.xml b/docs/manual/mod/mod_charset_lite.xml index 0fdcf1bc0c..31516532e2 100644 --- a/docs/manual/mod/mod_charset_lite.xml +++ b/docs/manual/mod/mod_charset_lite.xml @@ -102,12 +102,12 @@ supported by iconv.

Example - <Directory /export/home/trawick/apacheinst/htdocs/convert>
- - CharsetSourceEnc UTF-16BE
- CharsetDefault ISO-8859-1
- - </Directory> + +<Directory /export/home/trawick/apacheinst/htdocs/convert> + CharsetSourceEnc UTF-16BE + CharsetDefault ISO-8859-1 +</Directory> +

The character set names in this example work with the iconv @@ -143,12 +143,12 @@ supported by iconv.

Example - <Directory /export/home/trawick/apacheinst/htdocs/convert>
- - CharsetSourceEnc UTF-16BE
- CharsetDefault ISO-8859-1
- - </Directory> + +<Directory /export/home/trawick/apacheinst/htdocs/convert> + CharsetSourceEnc UTF-16BE + CharsetDefault ISO-8859-1 +</Directory> + diff --git a/docs/manual/mod/mod_data.xml b/docs/manual/mod/mod_data.xml index 6de297478e..51b9b58e7f 100644 --- a/docs/manual/mod/mod_data.xml +++ b/docs/manual/mod/mod_data.xml @@ -56,11 +56,11 @@ module.

Configuring the filter - <Location /data/images>
- - SetOutputFilter DATA - - </Location>
+ +<Location /data/images> + SetOutputFilter DATA +</Location> + diff --git a/docs/manual/mod/mod_dav.xml b/docs/manual/mod/mod_dav.xml index ee56ec6b18..c85cb9f14e 100644 --- a/docs/manual/mod/mod_dav.xml +++ b/docs/manual/mod/mod_dav.xml @@ -45,7 +45,7 @@

To enable mod_dav, add the following to a container in your httpd.conf file:

- Dav On + Dav On

This enables the DAV file system provider, which is implemented by the mod_dav_fs module. Therefore, that module @@ -57,9 +57,9 @@ file using the DavLockDB directive:

- + DavLockDB /usr/local/apache2/var/DavLock - +

The directory containing the lock database file must be writable by the User @@ -77,29 +77,24 @@ requests.

Full Example - DavLockDB /usr/local/apache2/var/DavLock
-
- <Directory /usr/local/apache2/htdocs/foo>
- - Require all granted
- Dav On
-
- AuthType Basic
- AuthName DAV
- AuthUserFile user.passwd
-
- <LimitExcept GET POST OPTIONS>
- - Require user admin
- - </LimitExcept>
- - </Directory>
+ +DavLockDB /usr/local/apache2/var/DavLock + +<Directory /usr/local/apache2/htdocs/foo> + Require all granted + Dav On + + AuthType Basic + AuthName DAV + AuthUserFile user.passwd + + <LimitExcept GET POST OPTIONS> + Require user admin + </LimitExcept> +</Directory> + -

mod_dav is a descendent of Greg Stein's mod_dav for Apache 1.3. More - information about the module is available from that site.

Security Issues @@ -153,16 +148,14 @@ will run the script, and one of which will allow it to be downloaded and manipulated with DAV.

- -Alias /phparea /home/gstein/php_files
-Alias /php-source /home/gstein/php_files
+ +Alias /phparea /home/gstein/php_files +Alias /php-source /home/gstein/php_files <Location /php-source> - - DAV On
- ForceType text/plain
- + DAV On + ForceType text/plain </Location> - +

With this setup, http://example.com/phparea can be used to access the output of the PHP scripts, and @@ -181,13 +174,11 @@ Alias /php-source /home/gstein/php_files

Use the Dav directive to enable the WebDAV HTTP methods for the given container:

- - <Location /foo>
- - Dav On
- - </Location> - + +<Location /foo> + Dav On +</Location> +

The value On is actually an alias for the default provider filesystem which is served by the the lock due to network latency.

Example - <Location /MSWord>
- - DavMinTimeout 600
- - </Location> + +<Location /MSWord> + DavMinTimeout 600 +</Location> + diff --git a/docs/manual/mod/mod_dav_fs.xml b/docs/manual/mod/mod_dav_fs.xml index 84d10184d2..ce04374974 100644 --- a/docs/manual/mod/mod_dav_fs.xml +++ b/docs/manual/mod/mod_dav_fs.xml @@ -38,7 +38,9 @@ directive:

Example + Dav filesystem +

Since filesystem is the default provider for @@ -67,7 +69,9 @@ the server to display all locks in a lock database.

--> Example + DavLockDB var/DavLock +

The directory containing the lock database file must be diff --git a/docs/manual/mod/mod_dav_lock.xml b/docs/manual/mod/mod_dav_lock.xml index 5caaaf76ae..41532b0af9 100644 --- a/docs/manual/mod/mod_dav_lock.xml +++ b/docs/manual/mod/mod_dav_lock.xml @@ -72,7 +72,9 @@ locks.

Example + DavGenericLockDB var/DavLock +

The directory containing the lock database file must be diff --git a/docs/manual/mod/mod_dbd.xml b/docs/manual/mod/mod_dbd.xml index 05de4a81ae..183bbd8d5d 100644 --- a/docs/manual/mod/mod_dbd.xml +++ b/docs/manual/mod/mod_dbd.xml @@ -59,8 +59,8 @@

mod_dbd exports five functions for other modules to use. The API is as follows:

- -
typedef struct {
+
+typedef struct {
     apr_dbd_t *handle;
     apr_dbd_driver_t *driver;
     apr_hash_t *prepared;
@@ -96,8 +96,7 @@ APR_DECLARE_OPTIONAL_FN(void, ap_dbd_close, (server_rec*, ap_dbd_t*));
 APR_DECLARE_OPTIONAL_FN(ap_dbd_t*, ap_dbd_acquire, (request_rec*));
 APR_DECLARE_OPTIONAL_FN(ap_dbd_t*, ap_dbd_cacquire, (conn_rec*));
 APR_DECLARE_OPTIONAL_FN(void, ap_dbd_prepare, (server_rec*, const char*, const char*));
-
- +
SQL Prepared Statements diff --git a/docs/manual/mod/mod_deflate.xml b/docs/manual/mod/mod_deflate.xml index ddef322900..fd4d228413 100644 --- a/docs/manual/mod/mod_deflate.xml +++ b/docs/manual/mod/mod_deflate.xml @@ -41,7 +41,9 @@ client

This is a simple sample configuration for the impatient.

Compress only a few types + AddOutputFilterByType DEFLATE text/html text/plain text/xml +

The following configuration, while resulting in more compressed content, @@ -49,29 +51,26 @@ client all the configuration details.

Compress everything except images - <Location />
- - # Insert filter
- SetOutputFilter DEFLATE
-
- # Netscape 4.x has some problems...
- BrowserMatch ^Mozilla/4 gzip-only-text/html
-
- # Netscape 4.06-4.08 have some more problems
- BrowserMatch ^Mozilla/4\.0[678] no-gzip
-
- # MSIE masquerades as Netscape, but it is fine
- BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
- # Don't compress images
- SetEnvIfNoCase Request_URI \
- - \.(?:gif|jpe?g|png)$ no-gzip dont-vary
- -
- # Make sure proxies don't deliver the wrong content
- Header append Vary User-Agent env=!dont-vary
- - </Location> + +<Location /> + # Insert filter + SetOutputFilter DEFLATE + + # Netscape 4.x has some problems... + BrowserMatch ^Mozilla/4 gzip-only-text/html + + # Netscape 4.06-4.08 have some more problems + BrowserMatch ^Mozilla/4\.0[678] no-gzip + + # MSIE masquerades as Netscape, but it is fine + BrowserMatch \bMSIE !no-gzip !gzip-only-text/html + # Don't compress images + SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary + + # Make sure proxies don't deliver the wrong content + Header append Vary User-Agent env=!dont-vary +</Location> +
@@ -84,9 +83,9 @@ client will enable compression for documents in the container where it is placed:

- + SetOutputFilter DEFLATE - +

Some popular browsers cannot handle compression of all content so you may want to set the gzip-only-text/html note to @@ -100,13 +99,11 @@ client enabling compression only for the html files of the Apache documentation:

- - <Directory "/your-server-root/manual">
- - AddOutputFilterByType DEFLATE text/html
- - </Directory> - + +<Directory "/your-server-root/manual"> + AddOutputFilterByType DEFLATE text/html +</Directory> +

For browsers that have problems even with compression of all file types, use the excerpt from the configuration example defined in the section above:

- - BrowserMatch ^Mozilla/4 gzip-only-text/html
- BrowserMatch ^Mozilla/4\.0[678] no-gzip
- BrowserMatch \bMSIE !no-gzip !gzip-only-text/html - + +BrowserMatch ^Mozilla/4 gzip-only-text/html +BrowserMatch ^Mozilla/4\.0[678] no-gzip +BrowserMatch \bMSIE !no-gzip !gzip-only-text/html +

At first we probe for a User-Agent string that indicates a Netscape Navigator version of 4.x. These versions @@ -159,14 +156,12 @@ client >SetOutputFilter or AddOutputFilter, for example:

- - <Location /dav-area>
- - ProxyPass http://example.com/
- SetOutputFilter INFLATE
- - </Location> - + +<Location /dav-area> + ProxyPass http://example.com/ + SetOutputFilter INFLATE +</Location> +

This Example will uncompress gzip'ed output from example.com, so other filters can do further processing with it. @@ -181,13 +176,11 @@ client >SetInputFilter or AddInputFilter, for example:

- - <Location /dav-area>
- - SetInputFilter DEFLATE
- - </Location> - + +<Location /dav-area> + SetInputFilter DEFLATE +</Location> +

Now if a request contains a Content-Encoding: gzip header, the body will be automatically decompressed. @@ -222,9 +215,9 @@ client in a typical configuration where the addition of the DEFLATE filter depends on the User-Agent, you should add:

- + Header append Vary User-Agent - +

If your decision about compression depends on other information than request headers (e.g. HTTP version), you have to set the @@ -232,7 +225,9 @@ client compliant proxies from caching entirely.

Example + Header set Vary * + @@ -253,10 +248,12 @@ client >access log.

Example - DeflateFilterNote ratio
-
- LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate
+ + DeflateFilterNote ratio + + LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate CustomLog logs/deflate_log deflate +

If you want to extract more accurate values from your logs, you @@ -279,12 +276,14 @@ client

Thus you may log it this way:

Accurate Logging - DeflateFilterNote Input instream
- DeflateFilterNote Output outstream
- DeflateFilterNote Ratio ratio
-
- LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate
- CustomLog logs/deflate_log deflate + +DeflateFilterNote Input instream +DeflateFilterNote Output outstream +DeflateFilterNote Ratio ratio + +LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate +CustomLog logs/deflate_log deflate + mod_log_config diff --git a/docs/manual/mod/mod_dialup.xml b/docs/manual/mod/mod_dialup.xml index 4fefae82d3..c8fdf53808 100644 --- a/docs/manual/mod/mod_dialup.xml +++ b/docs/manual/mod/mod_dialup.xml @@ -36,11 +36,11 @@ the document to validate. --> by the various old modem standards. So, you can browse your site with a 56k V.92 modem, by adding something like this:

- -<Location /mysite>
-ModemStandard V.92
+ +<Location /mysite> + ModemStandard V.92 </Location> - +

Previously to do bandwidth rate limiting modules would have to block an entire thread, for each client, and insert sleeps to slow the bandwidth down. @@ -58,11 +58,11 @@ once the timer hits. From there the handler can continue to send data to the cl

Specify what modem standard you wish to simulate.

- -<Location /mysite>
-ModemStandard V.26bis
+ +<Location /mysite> + ModemStandard V.26bis </Location> - + diff --git a/docs/manual/mod/mod_dir.xml b/docs/manual/mod/mod_dir.xml index 4762cabf42..8265dfde18 100644 --- a/docs/manual/mod/mod_dir.xml +++ b/docs/manual/mod/mod_dir.xml @@ -77,7 +77,9 @@ a directory directory.

Example + DirectoryIndex index.html +

then a request for http://example.com/docs/ would @@ -87,9 +89,9 @@ a directory

Note that the documents do not need to be relative to the directory;

- + DirectoryIndex index.html index.txt /cgi-bin/index.pl - +

would cause the CGI script /cgi-bin/index.pl to be executed if neither index.html or index.txt @@ -123,7 +125,9 @@ a directory to instead be issued.

Example + DirectoryIndexRedirect on +

A request for http://example.com/docs/ would @@ -168,15 +172,13 @@ a directory be aware that there are possible security implications to doing this.

- - # see security warning below!
- <Location /some/path>
- - DirectorySlash Off
- SetHandler some-handler
- - </Location> - + +# see security warning below! +<Location /some/path> + DirectorySlash Off + SetHandler some-handler +</Location> + Security Warning

Turning off the trailing slash redirect may result in an information @@ -204,9 +206,9 @@ a directory

Use this to set a handler for any URL that doesn't map to anything in your filesystem, and would otherwise return HTTP 404 (Not Found). For example

- - FallbackResource /not-404.php - + + FallbackResource /not-404.php +

will cause requests for non-existent files to be handled by not-404.php, while requests for files that exist are unaffected.

@@ -218,22 +220,18 @@ a directory mod_rewrite, and the use of the -f and -d tests for file and directory existence. This now requires only one line of configuration.

- - FallbackResource /index.php - + + FallbackResource /index.php +

Existing files, such as images, css files, and so on, will be served normally.

In a sub-URI, such as http://example.com/blog/ this sub-URI has to be supplied as local-url:

- - - <Directory /web/example.com/htdocs/blog>
- - FallbackResource /blog/index.php
- - </Directory> - - + +<Directory /web/example.com/htdocs/blog> + FallbackResource /blog/index.php +</Directory> + diff --git a/docs/manual/mod/mod_dumpio.xml b/docs/manual/mod/mod_dumpio.xml index 362fe7a23f..53add340a0 100644 --- a/docs/manual/mod/mod_dumpio.xml +++ b/docs/manual/mod/mod_dumpio.xml @@ -45,14 +45,14 @@

To enable the module, it should be compiled and loaded in to your running Apache configuration. Logging can then - be enabled or disabled seperately for input and output via + be enabled or disabled separately for input and output via the below directives. Additionally, mod_dumpio needs to be configured to LogLevel trace7:

- + LogLevel dumpio:trace7 - + @@ -69,7 +69,9 @@ later.

Enable dumping of all input.

Example + DumpIOInput On + @@ -89,7 +91,9 @@ later.

Enable dumping of all output.

Example + DumpIOOutput On +