mirror of
https://github.com/apache/httpd.git
synced 2026-01-06 09:01:14 +03:00
Updates to the mod_disk_cache.xml file to update formatting, improve
detail and accuracy, and to align with what the code does. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97432 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Paul J. Reder
@@ -4,52 +4,57 @@
|
||||
<modulesynopsis>
|
||||
|
||||
<name>mod_disk_cache</name>
|
||||
<description>Content cache keyed to URIs</description>
|
||||
<description>Content cache storage manager keyed to URIs</description>
|
||||
<status>Experimental</status>
|
||||
<sourcefile>mod_disk_cache.c</sourcefile>
|
||||
<identifier>disk_cache_module</identifier>
|
||||
|
||||
<summary>
|
||||
<note type="warning">
|
||||
This module is experimental. Documentation is still under development...
|
||||
</note>
|
||||
|
||||
<note type="warning">
|
||||
This module is experimental. Documentation is still under development...
|
||||
</note>
|
||||
<p><module>mod_disk_cache</module> implements a disk based storage manager for use with <module>mod_proxy</module>.</p>
|
||||
<p>Content stored and retrived keyed to the URL. Content with
|
||||
access protections is not cached.</p>
|
||||
<note>
|
||||
<p><module>mod_disk_cache</module> requires the services of <module>mod_cache</module>.</p>
|
||||
</note>
|
||||
<p><module>mod_disk_cache</module> implements a disk based storage manager. It is primarily of
|
||||
use in conjunction with <module>mod_proxy</module>.</p>
|
||||
<p>Content is stored in and retrieved from the cache using URI based keys. Content with
|
||||
access protection is not cached.</p>
|
||||
|
||||
<note><title>Note:</title>
|
||||
<p><module>mod_disk_cache</module> requires the services of <module>mod_cache</module>.</p>
|
||||
</note>
|
||||
</summary>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheRoot</name>
|
||||
<description>The directory root under which cache files are stored</description>
|
||||
<syntax>CacheRoot <em>directory</em></syntax>
|
||||
<syntax>CacheRoot <var>directory</var></syntax>
|
||||
<default>none</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>The <directive>CacheRoot</directive> directive defines the name of the directory
|
||||
on the disk to contain cache files. If the mod_disk_cache module has been loaded
|
||||
or compiled in to the Apache server, this directive <em>must</em> be defined. Failing to
|
||||
provide a value for <directive>CacheRoot</directive> will result in a configuration
|
||||
<p>The <directive>CacheRoot</directive> directive defines the name of the
|
||||
directory on the disk to contain cache files. If the
|
||||
<module>mod_disk_cache</module> module has been loaded or compiled in to the
|
||||
Apache server, this directive <em>must</em> be defined. Failing to provide a
|
||||
value for <directive>CacheRoot</directive> will result in a configuration
|
||||
file processing error. The <directive>CacheDirLevels</directive> and
|
||||
<directive>CacheDirLength</directive> directives define the structure of the directories
|
||||
under the specified root directory.</p>
|
||||
<directive>CacheDirLength</directive> directives define the structure of
|
||||
the directories under the specified root directory.</p>
|
||||
|
||||
<example>
|
||||
CacheRoot c:/cacheroot <br />
|
||||
</example>
|
||||
<example>
|
||||
CacheRoot c:/cacheroot<br />
|
||||
</example>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheSize</name>
|
||||
<description>The maximum amount of disk space that will be used by the cache in KBytes</description>
|
||||
<syntax>CacheSize <em>KBytes</em></syntax>
|
||||
<syntax>CacheSize <var>KBytes</var></syntax>
|
||||
<default>CacheSize 1000000</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>The <directive>CacheSize</directive> directive sets the desired disk space
|
||||
@@ -66,198 +71,243 @@ This module is experimental. Documentation is still under development...
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheGcInterval</name>
|
||||
<description>The interval between garbage collections</description>
|
||||
<syntax>CacheGcInterval <em>hours</em></syntax>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<description>The interval between garbage collection attempts.</description>
|
||||
<syntax>CacheGcInterval <var>hours</var></syntax>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>The <directive>CacheGcInterval</directive> directive specifies the
|
||||
number of hours to wait between attempts to free up disk space.</p>
|
||||
<p>More detail will be added here, when the function is implemented.</p>
|
||||
|
||||
<example>
|
||||
CacheGcInterval 24 <br />
|
||||
</example>
|
||||
<note type="warning">
|
||||
The <directive>CacheGcInterval</directive> directive is currently <em>not</em> implemented.
|
||||
</note>
|
||||
<example>
|
||||
CacheGcInterval 24<br />
|
||||
</example>
|
||||
|
||||
<note type="warning">
|
||||
The <directive>CacheGcInterval</directive> directive is currently
|
||||
<em>not</em> implemented.
|
||||
</note>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheDirLevels</name>
|
||||
<description>The number of levels of subdirectories in the cache</description>
|
||||
<syntax>CacheDirLevels <em>levels</em></syntax>
|
||||
<description>The number of levels of subdirectories in the cache.</description>
|
||||
<syntax>CacheDirLevels <var>levels</var></syntax>
|
||||
<default>CacheDirLevels 3</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>The <directive>CacheDirLevels</directive> directive sets the number of
|
||||
subdirectory levels in the cache. Cached data will be saved this many directory
|
||||
levels below <directive>CacheRoot</directive></p>
|
||||
subdirectory levels in the cache. Cached data will be saved this many
|
||||
directory levels below the <directive>CacheRoot</directive> directory.</p>
|
||||
|
||||
<note>
|
||||
<p>CacheDirLevels*CacheDirLength value must not be higher than 20.</p>
|
||||
</note>
|
||||
<example>
|
||||
CacheDirLevels 5 <br />
|
||||
</example>
|
||||
<note>
|
||||
<p>The result of <directive>CacheDirLevels</directive>*
|
||||
<directive>CacheDirLength</directive> must not be higher than 20.</p>
|
||||
</note>
|
||||
|
||||
<example>
|
||||
CacheDirLevels 5<br />
|
||||
</example>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheDirLength</name>
|
||||
<description>The number of characters in subdirectory names</description>
|
||||
<syntax>CacheDirLength <em>length</em></syntax>
|
||||
<syntax>CacheDirLength <var>length</var></syntax>
|
||||
<default>CacheDirLength 2</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>The <directive>CacheDirLength</directive> directive sets the number of
|
||||
characters for each subdirectory in the cache</p>
|
||||
characters for each subdirectory name in the cache hierarchy.</p>
|
||||
|
||||
<note>
|
||||
<p>CacheDirLevels*CacheDirLength value must not be higher than 20.</p>
|
||||
</note>
|
||||
<example>
|
||||
CacheDirLength 4 <br />
|
||||
</example>
|
||||
<note>
|
||||
<p>The result of <directive>CacheDirLevels</directive>*
|
||||
<directive>CacheDirLength</directive> must not be higher than 20.</p>
|
||||
</note>
|
||||
|
||||
<example>
|
||||
CacheDirLength 4<br />
|
||||
</example>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheExpiryCheck</name>
|
||||
<description>On if cache observes Expires date when seeking files</description>
|
||||
<syntax>CacheExpiryCheck <em>binary</em></syntax>
|
||||
<default>CacheExpiryCheck ?</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<description>Indicates if the cache observes Expires dates when seeking
|
||||
files</description>
|
||||
<syntax>CacheExpiryCheck On|Off</syntax>
|
||||
<default>CacheExpiryCheck On</default>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>More detail will be added here, when the function is implemented.</p>
|
||||
|
||||
<example>
|
||||
CacheExpiryCheck On<br />
|
||||
</example>
|
||||
<note type="warning">
|
||||
The <directive>CacheExpiryCheck</directive> directive is currently <em>not</em> implemented.
|
||||
</note>
|
||||
<example>
|
||||
CacheExpiryCheck Off<br />
|
||||
</example>
|
||||
|
||||
<note type="warning">
|
||||
The <directive>CacheExpiryCheck</directive> directive is currently
|
||||
<em>not</em> implemented.
|
||||
</note>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheMinFileSize</name>
|
||||
<description>The minimum size (in bytes) of a file to be placed in the cache</description>
|
||||
<syntax>CacheMinFileSize <em>bytes</em></syntax>
|
||||
<description>The minimum size (in bytes) of a document to be placed in the
|
||||
cache</description>
|
||||
<syntax>CacheMinFileSize <var>bytes</var></syntax>
|
||||
<default>CacheMinFileSize 1</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>The <directive>CacheMinFileSize</directive> directive sets the minimum
|
||||
size in bytes of a file to be cached.</p>
|
||||
size, in bytes, for a document to be considered for storage in the cache.</p>
|
||||
|
||||
<example>
|
||||
CacheMinFileSize 64<br />
|
||||
</example>
|
||||
<example>
|
||||
CacheMinFileSize 64<br />
|
||||
</example>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheMaxFileSize</name>
|
||||
<description>The maximum size (in bytes) of a file to be placed in the cache</description>
|
||||
<syntax>CacheMaxFileSize <em>bytes</em></syntax>
|
||||
<description>The maximum size (in bytes) of a document to be placed in the
|
||||
cache</description>
|
||||
<syntax>CacheMaxFileSize <var>bytes</var></syntax>
|
||||
<default>CacheMaxFileSize 1000000</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>The <directive>CacheMaxFileSize</directive> directive sets the maximum
|
||||
size in bytes of a file to be cached.</p>
|
||||
size, in bytes, for a document to be considered for storage in the cache.</p>
|
||||
|
||||
<example>
|
||||
CacheMaxFileSize 64000<br />
|
||||
</example>
|
||||
<example>
|
||||
CacheMaxFileSize 64000<br />
|
||||
</example>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheTimeMargin</name>
|
||||
<description>The minimum time margin to cache a document</description>
|
||||
<syntax>CacheTimeMargin <em>?</em></syntax>
|
||||
<syntax>CacheTimeMargin <var>?</var></syntax>
|
||||
<default>CacheTimeMargin ?</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>More detail will be added here, when the function is implemented.</p>
|
||||
|
||||
<example>
|
||||
CacheTimeMargin<br />
|
||||
</example>
|
||||
<example>
|
||||
CacheTimeMargin X<br />
|
||||
</example>
|
||||
|
||||
<note type="warning">
|
||||
The <directive>CacheTimeMargin</directive> directive is currently
|
||||
<em>not</em> implemented.
|
||||
</note>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheGcDaily</name>
|
||||
<description>The time of day for garbage collection (24 hour clock)</description>
|
||||
<syntax>CacheGcDaily <em>time</em></syntax>
|
||||
<description>The recurring time each day for garbage collection to be run.
|
||||
(24 hour clock)</description>
|
||||
<syntax>CacheGcDaily <var>time</var></syntax>
|
||||
<default>CacheGcDaily ?</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>More detail will be added here, when the function is implemented.</p>
|
||||
|
||||
<example>
|
||||
CacheGcDaily<br />
|
||||
</example>
|
||||
<note type="warning">
|
||||
The <directive>CacheGcDaily</directive> directive is currently <em>not</em> implemented.
|
||||
</note>
|
||||
<example>
|
||||
CacheGcDaily 23:59<br />
|
||||
</example>
|
||||
|
||||
<note type="warning">
|
||||
The <directive>CacheGcDaily</directive> directive is currently
|
||||
<em>not</em> implemented.
|
||||
</note>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheGcUnused</name>
|
||||
<description>The time in hours to retain unused file that match a url</description>
|
||||
<syntax>CacheGcUnused <em>hours</em></syntax>
|
||||
<description>The time to retain unreferenced cached files that match a URL.</description>
|
||||
<syntax>CacheGcUnused <var>hours</var> <var>url-string</var></syntax>
|
||||
<default>CacheGcUnused ?</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>More detail will be added here, when the function is implemented.</p>
|
||||
|
||||
<example>
|
||||
CacheGcUnused<br />
|
||||
</example>
|
||||
<note type="warning">
|
||||
The <directive>CacheGcUnused</directive> directive is currently <em>not</em> implemented.
|
||||
</note>
|
||||
<example>
|
||||
CacheGcUnused 12 /local_images<br />
|
||||
</example>
|
||||
|
||||
<note type="warning">
|
||||
The <directive>CacheGcUnused</directive> directive is currently
|
||||
<em>not</em> implemented.
|
||||
</note>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheGcClean</name>
|
||||
<description>The time in hours to retain unchanged files that match a url</description>
|
||||
<syntax>CacheGcClean <em>hours</em></syntax>
|
||||
<description>The time to retain unchanged cached files that match a URL</description>
|
||||
<syntax>CacheGcClean <var>hours</var> <var>url-string</var></syntax>
|
||||
<default>CacheGcClean ?</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>More detail will be added here, when the function is implemented.</p>
|
||||
|
||||
<example>
|
||||
CacheGcClean<br />
|
||||
</example>
|
||||
<note type="warning">
|
||||
The <directive>CacheGcClean</directive> directive is currently <em>not</em> implemented.
|
||||
</note>
|
||||
<example>
|
||||
CacheGcClean 12 /daily_scripts<br />
|
||||
</example>
|
||||
|
||||
<note type="warning">
|
||||
The <directive>CacheGcClean</directive> directive is currently
|
||||
<em>not</em> implemented.
|
||||
</note>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
<directivesynopsis>
|
||||
<name>CacheGcMemUsage</name>
|
||||
<description>The maximum kilobytes of memory used for garbage collection</description>
|
||||
<syntax>CacheGcMemUsage <em>KBytes</em></syntax>
|
||||
<syntax>CacheGcMemUsage <var>KBytes</var></syntax>
|
||||
<default>CacheGcMemUsage ?</default>
|
||||
<contextlist><context>server config</context></contextlist>
|
||||
<contextlist><context>server config</context><context>virtual host</context>
|
||||
</contextlist>
|
||||
|
||||
<usage>
|
||||
<p>More detail will be added here, when the function is implemented.</p>
|
||||
|
||||
<example>
|
||||
CacheGcMemUsage<br />
|
||||
</example>
|
||||
<note type="warning">
|
||||
The <directive>CacheGcMemUsage</directive> directive is currently <em>not</em> implemented.
|
||||
</note>
|
||||
<example>
|
||||
CacheGcMemUsage 16<br />
|
||||
</example>
|
||||
|
||||
<note type="warning">
|
||||
The <directive>CacheGcMemUsage</directive> directive is currently
|
||||
<em>not</em> implemented.
|
||||
</note>
|
||||
</usage>
|
||||
</directivesynopsis>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user