VladPolskiy/apache-http-server
1
0
Fork 0
mirror of https://github.com/apache/httpd.git synced 2025-08-06 11:06:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

syntax for mod_b*.xml and mod_c*.xml

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1330964 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Daniel Gruno
2012-04-26 16:55:17 +00:00
parent f19a613269
commit c8f77a58d9
8 changed files with 203 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/manual/mod/mod_buffer.xml
View File

@ -55,7 +55,9 @@
<directive module="mod_filter">AddOutputFilterByType</directive> directives.</p>
<example><title>Using buffer with mod_include</title>
AddOutputFilterByType INCLUDES;BUFFER text/html<br />
<highlight language="config">
AddOutputFilterByType INCLUDES;BUFFER text/html
</highlight>
</example>
<note type="warning">The buffer filters read the request/response into

281
docs/manual/mod/mod_cache.xml
View File

@ -149,27 +149,24 @@
<section id="sampleconf"><title>Sample Configuration</title>
<example><title>Sample httpd.conf</title>
#<br />
# Sample Cache Configuration<br />
#<br />
LoadModule cache_module modules/mod_cache.so<br />
<br />
&lt;IfModule mod_cache.c&gt;<br />
<indent>
LoadModule cache_disk_module modules/mod_cache_disk.so<br />
&lt;IfModule mod_cache_disk.c&gt;<br />
<indent>
CacheRoot c:/cacheroot<br />
CacheEnable disk /<br />
CacheDirLevels 5<br />
CacheDirLength 3<br />
</indent>
&lt;/IfModule&gt; <br />
<br />
# When acting as a proxy, don't cache the list of security updates<br />
CacheDisable http://security.update.server/update-list/<br />
</indent>
&lt;/IfModule&gt;
<highlight language="config">
#
# Sample Cache Configuration
#
LoadModule cache_module modules/mod_cache.so
&lt;IfModule mod_cache.c&gt;
LoadModule cache_disk_module modules/mod_cache_disk.so
&lt;IfModule mod_cache_disk.c&gt;
CacheRoot c:/cacheroot
CacheEnable disk /
CacheDirLevels 5
CacheDirLength 3
&lt;/IfModule&gt;
# When acting as a proxy, don't cache the list of security updates
CacheDisable http://security.update.server/update-list/
&lt;/IfModule&gt;
</highlight>
</example>
</section>
@ -223,16 +220,16 @@
<section>
<title>Example configuration</title>
<example><title>Enabling the cache lock</title>
#<br />
# Enable the cache lock<br />
#<br />
&lt;IfModule mod_cache.c&gt;<br />
<indent>
CacheLock on<br />
CacheLockPath /tmp/mod_cache-lock<br />
CacheLockMaxAge 5<br />
</indent>
&lt;/IfModule&gt;
<highlight language="config">
#
# Enable the cache lock
#
&lt;IfModule mod_cache.c&gt;
CacheLock on
CacheLockPath /tmp/mod_cache-lock
CacheLockMaxAge 5
&lt;/IfModule&gt;
</highlight>
</example>
</section>
</section>
@ -266,33 +263,33 @@
place the <strong>CACHE</strong> filter before the <strong>DEFLATE</strong>
filter as in the example below:</p>
<example>
# Cache content before optional compression<br />
CacheQuickHandler off<br />
AddOutputFilterByType CACHE;DEFLATE text/plain<br /><br />
</example>
<highlight language="config">
# Cache content before optional compression
CacheQuickHandler off
AddOutputFilterByType CACHE;DEFLATE text/plain
</highlight>
<p>Another option is to have content cached before personalisation is applied
by <module>mod_include</module> (or another content processing filter). In this
example templates containing tags understood by
<module>mod_include</module> are cached before being parsed:</p>
<example>
# Cache content before mod_include and mod_deflate<br />
CacheQuickHandler off<br />
AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html<br /><br />
</example>
<highlight language="config">
# Cache content before mod_include and mod_deflate
CacheQuickHandler off
AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html
</highlight>
<p>You may place the <strong>CACHE</strong> filter anywhere you wish within the
filter chain. In this example, content is cached after being parsed by
<module>mod_include</module>, but before being processed by
<module>mod_deflate</module>:</p>
<example>
# Cache content between mod_include and mod_deflate<br />
CacheQuickHandler off<br />
AddOutputFilterByType INCLUDES;CACHE;DEFLATE text/html<br /><br />
</example>
<highlight language="config">
# Cache content between mod_include and mod_deflate
CacheQuickHandler off
AddOutputFilterByType INCLUDES;CACHE;DEFLATE text/html
</highlight>
<note type="warning"><title>Warning:</title>If the location of the
<strong>CACHE</strong> filter in the filter chain is changed for any reason,
@ -310,9 +307,9 @@
<directive module="mod_log_config">LogFormat</directive> directive as
follows:</p>
<example>
<highlight language="config">
LogFormat "%{cache-status}e ..."
</example>
</highlight>
<p>Based on the caching decision made, the reason is also written to the
subprocess environment under one the following four keys, as appropriate:</p>
@ -329,12 +326,12 @@
<p>This makes it possible to support conditional logging of cached requests
as per the following example:</p>
<example>
CustomLog cached-requests.log common env=cache-hit<br />
CustomLog uncached-requests.log common env=cache-miss<br />
CustomLog revalidated-requests.log common env=cache-revalidate<br />
CustomLog invalidated-requests.log common env=cache-invalidate<br />
</example>
<highlight language="config">
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
</highlight>
<p>For module authors, a hook called <var>cache_status</var> is available,
allowing modules to respond to the caching outcomes above in customised
@ -379,37 +376,37 @@ manager</description>
also be used to specify remote sites and proxy protocols which
caching should be enabled for.</p>
<example>
# Cache content<br />
&lt;Location /foo&gt;<br />
<indent>
CacheEnable disk<br />
</indent>
&lt;/Location&gt;<br /><br />
# Cache regex<br />
&lt;LocationMatch foo$&gt;<br />
<indent>
CacheEnable disk<br />
</indent>
&lt;/LocationMatch&gt;<br /><br />
# Cache proxied url's<br />
CacheEnable disk /<br /><br />
# Cache FTP-proxied url's<br />
CacheEnable disk ftp://<br /><br />
# Cache content from www.example.org<br />
CacheEnable disk http://www.example.org/<br />
</example>
<highlight language="config">
# Cache content
&lt;Location /foo&gt;
CacheEnable disk
&lt;/Location&gt;
# Cache regex
&lt;LocationMatch foo$&gt;
CacheEnable disk
&lt;/LocationMatch&gt;
# 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/
</highlight>
<p>A hostname starting with a <strong>"*"</strong> matches all hostnames with
that suffix. A hostname starting with <strong>"."</strong> matches all
hostnames containing the domain components that follow.</p>
<example>
# Match www.example.org, and fooexample.org<br />
CacheEnable disk http://*example.org/<br />
# Match www.example.org, but not fooexample.org<br />
CacheEnable disk http://.example.org/<br />
</example>
<highlight language="config">
# 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/
</highlight>
<p> The <code>no-cache</code> environment variable can be set to
disable caching on a finer grained set of resources in versions
@ -433,7 +430,9 @@ manager</description>
<var>url-string</var>.</p>
<example><title>Example</title>
<highlight language="config">
CacheDisable /local_files
</highlight>
</example>
<p>If used in a <directive type="section">Location</directive> directive,
@ -441,11 +440,11 @@ manager</description>
is used, caching for the whole location will be disabled.</p>
<example><title>Example</title>
&lt;Location /foo&gt;<br />
<indent>
CacheDisable on<br />
</indent>
&lt;/Location&gt;<br />
<highlight language="config">
&lt;Location /foo&gt;
CacheDisable on
&lt;/Location&gt;
</highlight>
</example>
<p>The <code>no-cache</code> environment variable can be set to
@ -472,9 +471,9 @@ manager</description>
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.</p>
<example>
<highlight language="config">
CacheMaxExpire 604800
</example>
</highlight>
</usage>
</directivesynopsis>
@ -495,9 +494,9 @@ manager</description>
server. This is only used if no valid expire time was supplied with the document.</p>
<example>
<highlight language="config">
CacheMinExpire 3600
</example>
</highlight>
</usage>
</directivesynopsis>
@ -518,9 +517,9 @@ manager</description>
with the document. The value specified with the <directive>CacheMaxExpire</directive>
directive does <em>not</em> override this setting.</p>
<example>
<highlight language="config">
CacheDefaultExpire 86400
</example>
</highlight>
</usage>
</directivesynopsis>
@ -548,9 +547,9 @@ header.</description>
<directive>CacheDefaultExpire</directive> directive will be used to
generate an expiration date.</p>
<example>
<highlight language="config">
CacheIgnoreNoLastMod On
</example>
</highlight>
</usage>
</directivesynopsis>
@ -571,9 +570,9 @@ header.</description>
if the request contains no-cache header values. Resources requiring
authorization will <em>never</em> be cached.</p>
<example>
<highlight language="config">
CacheIgnoreCacheControl On
</example>
</highlight>
<note type="warning"><title>Warning:</title>
This directive will allow serving from the cache even if the client has
@ -603,9 +602,9 @@ header.</description>
view the request is treated as if having no query string when this
directive is enabled.</p>
<example>
<highlight language="config">
CacheIgnoreQueryString On
</example>
</highlight>
</usage>
</directivesynopsis>
@ -642,9 +641,9 @@ LastModified date.</description>
<directive>CacheMaxExpire</directive>, then the latter takes
precedence.</p>
<example>
<highlight language="config">
CacheLastModifiedFactor 0.5
</example>
</highlight>
</usage>
</directivesynopsis>
@ -685,11 +684,15 @@ LastModified date.</description>
<code>None</code>.</p>
<example><title>Example 1</title>
<highlight language="config">
CacheIgnoreHeaders Set-Cookie
</highlight>
</example>
<example><title>Example 2</title>
<highlight language="config">
CacheIgnoreHeaders None
</highlight>
</example>
<note type="warning"><title>Warning:</title>
@ -728,11 +731,15 @@ LastModified date.</description>
identifiers. Otherwise, each identifier is added to the list.</p>
<example><title>Example 1</title>
<highlight language="config">
CacheIgnoreURLSessionIdentifiers jsessionid
</highlight>
</example>
<example><title>Example 2</title>
<highlight language="config">
CacheIgnoreURLSessionIdentifiers None
</highlight>
</example>
</usage>
@ -759,9 +766,9 @@ LastModified date.</description>
the origin server, and the response may be fulfilled from cache
if the backend resource has not changed.</p>
<example>
<highlight language="config">
CacheStoreExpired On
</example>
</highlight>
</usage>
</directivesynopsis>
@ -785,9 +792,9 @@ LastModified date.</description>
private header values. Resources requiring authorization will
<em>never</em> be cached.</p>
<example>
<highlight language="config">
CacheStorePrivate On
</example>
</highlight>
<note type="warning"><title>Warning:</title>
This directive will allow caching even if the upstream server has
@ -819,9 +826,9 @@ LastModified date.</description>
no-store header values. Resources requiring authorization will
<em>never</em> be cached.</p>
<example>
<highlight language="config">
CacheStoreNoStore On
</example>
</highlight>
<note type="warning"><title>Warning:</title>
As described in RFC 2616, the no-store directive is intended to
@ -850,10 +857,10 @@ LastModified date.</description>
<p>In a minimal configuration the following directive is all that is needed to
enable the thundering herd lock in the default system temp directory.</p>
<example>
# Enable cache lock<br />
CacheLock on<br /><br />
</example>
<highlight language="config">
# Enable cache lock
CacheLock on
</highlight>
</usage>
</directivesynopsis>
@ -920,21 +927,21 @@ LastModified date.</description>
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.</p>
<example>
# Run cache as a normal handler<br />
CacheQuickHandler off<br /><br />
</example>
<highlight language="config">
# Run cache as a normal handler
CacheQuickHandler off
</highlight>
<p>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 <strong>CACHE</strong> filter to
the chain.</p>
<example>
# Cache content before mod_include and mod_deflate<br />
CacheQuickHandler off<br />
AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html<br /><br />
</example>
<highlight language="config">
# Cache content before mod_include and mod_deflate
CacheQuickHandler off
AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html
</highlight>
<p>If the CACHE filter is specified more than once, the last instance will
apply.</p>
@ -972,14 +979,14 @@ LastModified date.</description>
server and was not served from cache.</dd>
</dl>
<example>
# Enable the X-Cache header<br />
CacheHeader on<br />
</example>
<highlight language="config">
# Enable the X-Cache header
CacheHeader on
</highlight>
<example>
X-Cache: HIT from localhost<br />
</example>
<highlight language="config">
X-Cache: HIT from localhost
</highlight>
</usage>
</directivesynopsis>
@ -1012,10 +1019,10 @@ LastModified date.</description>
is used, this directive must appear within a server or virtual host context, otherwise
the setting will be ignored.</p>
<example>
# Enable the X-Cache-Detail header<br />
CacheDetailHeader on<br />
</example>
<highlight language="config">
# Enable the X-Cache-Detail header
CacheDetailHeader on
</highlight>
<example>
X-Cache-Detail: "conditional cache hit: entity refreshed" from localhost<br />
@ -1043,10 +1050,10 @@ LastModified date.</description>
should be cached beneath the same cache key, a new base URL can be specified
with this directive.</p>
<example>
# Override the base URL of the cache key.<br />
CacheKeyBaseURL http://www.example.com/<br />
</example>
<highlight language="config">
# Override the base URL of the cache key.
CacheKeyBaseURL http://www.example.com/
</highlight>
<note type="warning">Take care when setting this directive. If two separate virtual
hosts are accidentally given the same base URL, entries from one virtual host
@ -1075,10 +1082,10 @@ LastModified date.</description>
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.</p>
<example>
# Serve stale data on error.<br />
CacheStaleOnError on<br />
</example>
<highlight language="config">
# Serve stale data on error.
CacheStaleOnError on
</highlight>
</usage>
</directivesynopsis>

20
docs/manual/mod/mod_cache_disk.xml
View File

@ -89,9 +89,9 @@ stored</description>
module="mod_cache_disk">CacheDirLength</directive> directives define
the structure of the directories under the specified root directory.</p>
<example>
<highlight language="config">
CacheRoot c:/cacheroot
</example>
</highlight>
</usage>
</directivesynopsis>
@ -167,9 +167,9 @@ cache</description>
minimum size, in bytes, for a document to be considered for storage
in the cache.</p>
<example>
<highlight language="config">
CacheMinFileSize 64
</example>
</highlight>
</usage>
</directivesynopsis>
@ -190,9 +190,9 @@ cache</description>
maximum size, in bytes, for a document to be considered for storage in
the cache.</p>
<example>
<highlight language="config">
CacheMaxFileSize 64000
</example>
</highlight>
</usage>
</directivesynopsis>
@ -220,9 +220,9 @@ cache</description>
<p>This directive only takes effect when the data is being saved to the
cache, as opposed to data being served from the cache.</p>
<example>
<highlight language="config">
CacheReadSize 102400
</example>
</highlight>
</usage>
</directivesynopsis>
@ -254,9 +254,9 @@ cache</description>
ensure that the server does not buffer excessively should data arrive faster
than expected.</p>
<example>
<highlight language="config">
CacheReadTime 1000
</example>
</highlight>
</usage>
</directivesynopsis>

60
docs/manual/mod/mod_cache_socache.xml
View File

@ -42,26 +42,22 @@ HTTP caching filter.</description>
however the caching of partial content is not yet supported by this
module.</p>
<example>
# Turn on caching<br />
CacheSocache shmcb<br />
CacheSocacheMaxSize 102400<br />
&lt;Location /foo&gt;<br />
<indent>
CacheEnable socache<br />
</indent>
&lt;/Location&gt;<br />
<br />
# Fall back to the disk cache<br />
CacheSocache shmcb<br />
CacheSocacheMaxSize 102400<br />
&lt;Location /foo&gt;<br />
<indent>
CacheEnable socache<br />
CacheEnable disk<br />
</indent>
&lt;/Location&gt;<br />
</example>
<highlight language="config">
# Turn on caching
CacheSocache shmcb
CacheSocacheMaxSize 102400
&lt;Location /foo&gt;
CacheEnable socache
&lt;/Location&gt;
# Fall back to the disk cache
CacheSocache shmcb
CacheSocacheMaxSize 102400
&lt;Location /foo&gt;
CacheEnable socache
CacheEnable disk
&lt;/Location&gt;
</highlight>
<note><title>Note:</title>
<p><module>mod_cache_socache</module> requires the services of
@ -89,9 +85,9 @@ stored</description>
implementations</a> of shared object caches are available to choose
from.</p>
<example>
<highlight language="config">
CacheSocache shmcb
</example>
</highlight>
</usage>
</directivesynopsis>
@ -114,9 +110,9 @@ cache</description>
the cache. This value overrides the freshness lifetime defined for the
document by the HTTP protocol.</p>
<example>
<highlight language="config">
CacheSocacheMaxTime 86400
</example>
</highlight>
</usage>
</directivesynopsis>
@ -140,9 +136,9 @@ cache</description>
only stored for its freshness lifetime, there will be no opportunity to
revalidate the response to make it fresh again.</p>
<example>
<highlight language="config">
CacheSocacheMinTime 600
</example>
</highlight>
</usage>
</directivesynopsis>
@ -172,9 +168,9 @@ cache</description>
responses larger than those cacheable within
<module>mod_cache_socache</module>.</p>
<example>
<highlight language="config">
CacheSocacheMaxSize 102400
</example>
</highlight>
</usage>
</directivesynopsis>
@ -203,9 +199,9 @@ cache</description>
<p>This directive only takes effect when the data is being saved to the
cache, as opposed to data being served from the cache.</p>
<example>
<highlight language="config">
CacheReadSize 102400
</example>
</highlight>
</usage>
</directivesynopsis>
@ -238,9 +234,9 @@ cache</description>
to ensure that the server does not buffer excessively should data arrive faster
than expected.</p>
<example>
<highlight language="config">
CacheSocacheReadTime 1000
</example>
</highlight>
</usage>
</directivesynopsis>

4
docs/manual/mod/mod_cern_meta.xml
View File

@ -81,12 +81,12 @@ files</description>
accessed. Set to "<code>.</code>" to look in the same directory
as the file:</p>
<example>MetaDir .</example>
<highlight language="config">MetaDir .</highlight>
<p>Or, to set it to a subdirectory of the directory containing the
files:</p>
<example>MetaDir .meta</example>
<highlight language="config">MetaDir .meta</highlight>
</usage>
</directivesynopsis>

2
docs/manual/mod/mod_cgi.xml
View File

@ -168,7 +168,9 @@
</p>
<example><title>Example</title>
<highlight language="config">
ScriptLog logs/cgi_log
</highlight>
</example>
<p>This log will be opened as the user the child processes run

2
docs/manual/mod/mod_cgid.xml
View File

@ -90,7 +90,9 @@ the cgi daemon</description>
write in the directory where the socket is located.</p>
<example><title>Example</title>
<highlight language="config">
ScriptSock /var/run/cgid.sock
</highlight>
</example>
</usage>

24
docs/manual/mod/mod_charset_lite.xml
View File

@ -102,12 +102,12 @@
supported by iconv.</p>
<example><title>Example</title>
&lt;Directory /export/home/trawick/apacheinst/htdocs/convert&gt;<br />
<indent>
CharsetSourceEnc UTF-16BE<br />
CharsetDefault ISO-8859-1<br />
</indent>
&lt;/Directory&gt;
<highlight language="config">
&lt;Directory /export/home/trawick/apacheinst/htdocs/convert&gt;
CharsetSourceEnc UTF-16BE
CharsetDefault ISO-8859-1
&lt;/Directory&gt;
</highlight>
</example>
<p>The character set names in this example work with the iconv
@ -143,12 +143,12 @@
supported by iconv.</p>
<example><title>Example</title>
&lt;Directory /export/home/trawick/apacheinst/htdocs/convert&gt;<br />
<indent>
CharsetSourceEnc UTF-16BE<br />
CharsetDefault ISO-8859-1<br />
</indent>
&lt;/Directory&gt;
<highlight language="config">
&lt;Directory /export/home/trawick/apacheinst/htdocs/convert&gt;
CharsetSourceEnc UTF-16BE
CharsetDefault ISO-8859-1
&lt;/Directory&gt;
</highlight>
</example>
<note>