From 01528a91dd73baa5e89f4781655a041b69e577be Mon Sep 17 00:00:00 2001 From: Andre Malo Date: Wed, 6 Nov 2002 21:22:24 +0000 Subject: [PATCH] update transformation Thanks, Paul, for your extensive documentation! git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97433 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_cache.html.en | 157 ++++++++++----- docs/manual/mod/mod_disk_cache.html.en | 269 ++++++++++++++----------- docs/manual/mod/mod_mem_cache.html.en | 148 +++++++------- docs/manual/mod/quickreference.html.en | 23 +-- 4 files changed, 352 insertions(+), 245 deletions(-) diff --git a/docs/manual/mod/mod_cache.html.en b/docs/manual/mod/mod_cache.html.en index 47492c5da9..d371d01019 100644 --- a/docs/manual/mod/mod_cache.html.en +++ b/docs/manual/mod/mod_cache.html.en @@ -20,20 +20,20 @@ the base Apache distribution:

mod_disk_cache
-
implements a disk based storage manager for use with - mod_proxy
+
implements a disk based storage manager.
mod_mem_cache
-
implements an in-memory based storage manager. +
implements a memory based storage manager. mod_mem_cache can be configured to operate in two modes: caching open file descriptors or caching objects in heap storage. - mod_mem_cache is most useful when used to cache - locally generated content or to cache backend server content for - mod_proxy configured for ProxyPass (aka reverse proxy)
+ mod_mem_cache can be used to cache locally generated content + or to cache backend server content for mod_proxy when + configured using ProxyPass + (aka reverse proxy)
-

Content stored and retrived keyed to the URL. Content with - access protections is not cached.

+

Content is stored in and retrieved from the cache using URI based keys. Content with + access protection is not cached.

Directives

top

CacheDefaultExpire Directive

Description: - The default time in seconds to cache a document
Syntax: + The default duration to cache a document when no expiry date is specified.
Syntax: CacheDefaultExpire seconds
Default: CacheDefaultExpire 3600 (one hour)
Context: server config, virtual host
Status: Experimental
Module: mod_cache
-

The default time in seconds to cache a document if the page does not have - an expiry date in the Expires field.

+

The CacheDefaultExpire directive specifies a default time, + in seconds, to cache a document if neither an expiry date nor last-modified date are provided + with the document. The value specified with the CacheMaxExpire + directive does not override this setting.

CacheDefaultExpire 86400

top

CacheDisable Directive

Description: - Disable caching of specified URLs by specified storage -manager
Syntax: - CacheDisable cache_type url-string
Context: + Disable caching of specified URLs
Syntax: + CacheDisable url-string
Context: server config, virtual host
Status: Experimental
Module: mod_cache
@@ -103,10 +104,10 @@ managerSyntax: url-string.

Example

- CacheDisable disk /local_files + CacheDisable /local_files

top

CacheEnable Directive

Description: - Enable caching specified URLs in a specified storage + Enable caching of specified URLs using a specified storage manager
Syntax: CacheEnable cache_type url-string
Context: server config, virtual host
Status: @@ -114,71 +115,121 @@ manager
Syntax: mod_cache

The CacheEnable directive instructs mod_cache to cache urls at or below - url-string. The cache store is specified with the - cache_type argument. cache_type mem - instructs mod_cache to use the in-memory cache storage - manager implemented by mod_mem_cache. + url-string. The cache storage manager is specified with the + cache_type argument. cache_type mem + instructs mod_cache to use the memory based storage + manager implemented by mod_mem_cache. cache_type disk instructs - mod_cache to use the cache storage manager implemented - by mod_disk_cache.

+ mod_cache to use the disk based storage manager + implemented by mod_disk_cache. + cache_type fd instructs + mod_cache to use the file descriptor cache implemented + by mod_mem_cache.

+

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 + actually processes the request. The order in which the storage managers are + run is determined by the order of the CacheEnable + directives in the configuration file.

- CacheEnable disk /
CacheEnable mem /manual
CacheEnable fd /images
+ CacheEnable disk /

top

CacheForceCompletion Directive

Description: - Percentage of download to arrive for the cache to force -complete transfer
Syntax: + Percentage of document served, after which the server +will complete caching the file even if the request is cancelled.
Syntax: CacheForceCompletion Percentage
Default: CacheForceCompletion 60
Context: server config, virtual host
Status: Experimental
Module: mod_cache
-

Percentage of download to arrive for the cache to force complete transfer.

+

Ordinarily, if a request is cancelled while the response is being + cached and delivered to the client the processing of the response will + stop and the cache entry will be removed. The + CacheForceCompletion directive specifies a + threshold beyond which the document will continue to be cached to + completion, even if the request is cancelled.

+ +

The threshold is a percentage specified as a value between + 1 and 100. A value of 0 + specifies that the default be used. A value of 100 + will only cache documents that are served in their entirety. A value + between 60 and 90 is recommended.

CacheForceCompletion 80

-
+

Note:

This feature is currently not implemented.
top

CacheIgnoreCacheControl Directive

Description: - Ignore requests from the client for uncached -content
Syntax: + Ignore the fact that the client requested the content not be +cached.
Syntax: CacheIgnoreCacheControl On|Off
Default: CacheIgnoreCacheControl Off
Context: server config, virtual host
Status: Experimental
Module: mod_cache
-

Ignore requests from the client for uncached content

+

Ordinarily, documents with no-cache or no-store header values will not be stored in the cache. + The CacheIgnoreCacheControl directive allows this behavior to be overridden. + CacheIgnoreCacheControl On tells the server to attempt to cache the document + even if it contains no-cache or no-store header values. Documents requiring authorization will + never be cached.

CacheIgnoreCacheControl On

top

CacheIgnoreNoLastMod Directive

Description: - Ignore responses where there is no Last Modified -Header
Syntax: + Ignore the fact that a response has no Last Modified +header.
Syntax: CacheIgnoreNoLastMod On|Off
Default: CacheIgnoreNoLastMod Off
Context: server config, virtual host
Status: Experimental
Module: mod_cache
-

Ignore responses where there is no Last Modified Header.

+

Ordinarily, documents without a last-modified date are not cached. + Under some circumstances the last-modified date is removed (during + mod_include processing for example) or not provided + at all. The CacheIgnoreNoLastMod directive + provides a way to specify that documents without last-modified dates + should be considered for caching, even without a last-modified date. + If neither a last-modified date nor an expiry date are provided with + the document then the value specified by the + CacheDefaultExpire directive will be used to + generate an expiration date.

CacheIgnoreNoLastMod On

top

CacheLastModifiedFactor Directive

Description: - The factor used to estimate the Expires date from the -LastModified date
Syntax: + The factor used to compute an expiry date based on the +LastModified date.
Syntax: CacheLastModifiedFactor float
Default: CacheLastModifiedFactor 0.1
Context: server config, virtual host
Status: Experimental
Module: mod_cache
-

The factor used to estimate the Expires date from the LastModified date.

+

In the event that a document does not provide an expiry date but does + provide a last-modified date, an expiry date can be calculated based on + the time since the document was last modified. The + CacheLastModifiedFactor directive specifies a + factor to be used in the generation of this expiry date + according to the following formula: + + expiry-period = time-since-last-modified-date * factor + expiry-date = current-date + expiry-period + + For example, if the document was last modified 10 hours ago, and + factor is 0.1 then the expiry-period will be set to + 10*0.1 = 1 hour. If the current time was 3:00pm then the computed + expiry-date would be 3:00pm + 1hour = 4:00pm. + + If the expiry-period would be longer than that set by + CacheMaxExpire, then the latter takes + precedence.

CacheLastModifiedFactor 0.5 @@ -190,9 +241,10 @@ LastModified dateSyntax: server config, virtual hostStatus: ExperimentalModule: mod_cache -

The maximum time in seconds to cache a document. The - CacheMaxExpire takes precedence over the - Expires field from the header.

+

The CacheMaxExpire directive specifies the maximum number of + seconds for which cachable HTTP documents will be retained without checking the origin + 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 @@ -205,15 +257,22 @@ before declaring the response uncacheableStatus: ExperimentalModule: mod_cache -

Maximum number of bytes of a streamed response (i.e., a - response where the entire content is not available all at once, such - as a proxy or CGI response) to buffer before deciding if the response - is cacheable. By default, a streamed response will not be - cached unless it has a Content-Length header. The reason - for this is to avoid using a large amount of memory to buffer a partial - response that might end up being too large to fit in the cache anyway. - To enable caching of streamed responses, use CacheMaxStreamingBuffer to specify the maximum amount of - buffer space to use per request.

+

The CacheMaxStreamingBuffer directive + specifies the maximum number of bytes of a streamed response to + buffer before deciding that the response is too big to cache. + A streamed response is one in which the entire content is not + immediately available and in which the Content-Length + may not be known. Sources of streaming responses include proxied + responses and the output of CGI scripts. By default, a streamed + response will not be cached unless it has a + Content-Length header. The reason for this is to + avoid using a large amount of memory to buffer a partial response + that might end up being too large to fit in the cache. + The CacheMaxStreamingBuffer directive allows + buffering of streamed responses that don't contain a + Content-Length up to the specified maximum amount of + space. If the maximum buffer space is reached, the buffered + content is discarded and the attempt to cache is abandoned.

Note:

Using a nonzero value for CacheMaxStreamingBuffer will not delay the transmission diff --git a/docs/manual/mod/mod_disk_cache.html.en b/docs/manual/mod/mod_disk_cache.html.en index 46a4b2b484..908d7f8648 100644 --- a/docs/manual/mod/mod_disk_cache.html.en +++ b/docs/manual/mod/mod_disk_cache.html.en @@ -5,20 +5,22 @@ This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -->mod_disk_cache - Apache HTTP Server

<-

Apache Module mod_disk_cache

Description: - Content cache keyed to URIs
Status: + Content cache storage manager keyed to URIs
Status: Experimental
Module Identifier: disk_cache_module
Source File: mod_disk_cache.c

Summary

+
+ This module is experimental. Documentation is still under development... +
-
-This module is experimental. Documentation is still under development... -
-

mod_disk_cache implements a disk based storage manager for use with mod_proxy.

-

Content stored and retrived keyed to the URL. Content with - access protections is not cached.

-
-

mod_disk_cache requires the services of mod_cache.

-
+

mod_disk_cache implements a disk based storage manager. It is primarily of + use in conjunction with mod_proxy.

+

Content is stored in and retrieved from the cache using URI based keys. Content with + access protection is not cached.

+ +

Note:

+

mod_disk_cache requires the services of mod_cache.

+

Directives

top

CacheDirLength Directive

Description: The number of characters in subdirectory names
Syntax: - CacheDirLength length
Default: + CacheDirLength length
Default: CacheDirLength 2
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache

The CacheDirLength directive sets the number of - characters for each subdirectory in the cache

+ characters for each subdirectory name in the cache hierarchy.

-
-

CacheDirLevels*CacheDirLength value must not be higher than 20.

-
-

- CacheDirLength 4
-

+
+

The result of CacheDirLevels* + CacheDirLength must not be higher than 20.

+
+ +

+ CacheDirLength 4
+

top

CacheDirLevels Directive

Description: - The number of levels of subdirectories in the cache
Syntax: - CacheDirLevels levels
Default: + The number of levels of subdirectories in the cache.
Syntax: + CacheDirLevels levels
Default: CacheDirLevels 3
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache

The CacheDirLevels directive sets the number of - subdirectory levels in the cache. Cached data will be saved this many directory - levels below CacheRoot

+ subdirectory levels in the cache. Cached data will be saved this many + directory levels below the CacheRoot directory.

-
-

CacheDirLevels*CacheDirLength value must not be higher than 20.

-
-

- CacheDirLevels 5
-

+
+

The result of CacheDirLevels* + CacheDirLength must not be higher than 20.

+
+ +

+ CacheDirLevels 5
+

top

CacheExpiryCheck Directive

Description: - On if cache observes Expires date when seeking files
Syntax: - CacheExpiryCheck binary
Default: - CacheExpiryCheck ?
Context: - server config
Status: + Indicates if the cache observes Expires dates when seeking +files
Syntax: + CacheExpiryCheck On|Off
Default: + CacheExpiryCheck On
Context: + server config, virtual host
Status: Experimental
Module: mod_disk_cache
+

More detail will be added here, when the function is implemented.

-

- CacheExpiryCheck On
-

-
-The CacheExpiryCheck directive is currently not implemented. -
+

+ CacheExpiryCheck Off
+

+ +
+ The CacheExpiryCheck directive is currently + not implemented. +
top

CacheGcClean Directive

Description: - The time in hours to retain unchanged files that match a url
Syntax: - CacheGcClean hours
Default: + The time to retain unchanged cached files that match a URL
Syntax: + CacheGcClean hours url-string
Default: CacheGcClean ?
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache
+

More detail will be added here, when the function is implemented.

-

- CacheGcClean
-

-
-The CacheGcClean directive is currently not implemented. -
+

+ CacheGcClean 12 /daily_scripts
+

+ +
+ The CacheGcClean directive is currently + not implemented. +
top

CacheGcDaily Directive

Description: - The time of day for garbage collection (24 hour clock)
Syntax: - CacheGcDaily time
Default: + The recurring time each day for garbage collection to be run. +(24 hour clock)
Syntax: + CacheGcDaily time
Default: CacheGcDaily ?
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache
+

More detail will be added here, when the function is implemented.

-

- CacheGcDaily
-

-
-The CacheGcDaily directive is currently not implemented. -
+

+ CacheGcDaily 23:59
+

+ +
+ The CacheGcDaily directive is currently + not implemented. +
top

CacheGcInterval Directive

Description: - The interval between garbage collections
Syntax: - CacheGcInterval hours
Context: - server config
Status: + The interval between garbage collection attempts.
Syntax: + CacheGcInterval hours
Context: + server config, virtual host
Status: Experimental
Module: mod_disk_cache
+

The CacheGcInterval directive specifies the + number of hours to wait between attempts to free up disk space.

+

More detail will be added here, when the function is implemented.

-

- CacheGcInterval 24
-

-
-The CacheGcInterval directive is currently not implemented. -
+

+ CacheGcInterval 24
+

+ +
+ The CacheGcInterval directive is currently + not implemented. +
top

CacheGcMemUsage Directive

Description: The maximum kilobytes of memory used for garbage collection
Syntax: - CacheGcMemUsage KBytes
Default: + CacheGcMemUsage KBytes
Default: CacheGcMemUsage ?
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache
+

More detail will be added here, when the function is implemented.

-

- CacheGcMemUsage
-

-
-The CacheGcMemUsage directive is currently not implemented. -
+

+ CacheGcMemUsage 16
+

+ +
+ The CacheGcMemUsage directive is currently + not implemented. +
top

CacheGcUnused Directive

Description: - The time in hours to retain unused file that match a url
Syntax: - CacheGcUnused hours
Default: + The time to retain unreferenced cached files that match a URL.
Syntax: + CacheGcUnused hours url-string
Default: CacheGcUnused ?
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache
+

More detail will be added here, when the function is implemented.

-

- CacheGcUnused
-

-
-The CacheGcUnused directive is currently not implemented. -
+

+ CacheGcUnused 12 /local_images
+

+ +
+ The CacheGcUnused directive is currently + not implemented. +
top

CacheMaxFileSize Directive

Description: - The maximum size (in bytes) of a file to be placed in the cache
Syntax: - CacheMaxFileSize bytes
Default: + The maximum size (in bytes) of a document to be placed in the +cache
Syntax: + CacheMaxFileSize bytes
Default: CacheMaxFileSize 1000000
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache

The CacheMaxFileSize directive sets the maximum - size in bytes of a file to be cached.

+ size, in bytes, for a document to be considered for storage in the cache.

-

- CacheMaxFileSize 64000
-

+

+ CacheMaxFileSize 64000
+

top

CacheMinFileSize Directive

Description: - The minimum size (in bytes) of a file to be placed in the cache
Syntax: - CacheMinFileSize bytes
Default: + The minimum size (in bytes) of a document to be placed in the +cache
Syntax: + CacheMinFileSize bytes
Default: CacheMinFileSize 1
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache

The CacheMinFileSize directive sets the minimum - size in bytes of a file to be cached.

+ size, in bytes, for a document to be considered for storage in the cache.

-

- CacheMinFileSize 64
-

+

+ CacheMinFileSize 64
+

top

CacheRoot Directive

Description: The directory root under which cache files are stored
Syntax: - CacheRoot directory
Default: + CacheRoot directory
Default: none
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache
-

The CacheRoot 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 must be defined. Failing to - provide a value for CacheRoot will result in a configuration +

The CacheRoot 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 must be defined. Failing to provide a + value for CacheRoot will result in a configuration file processing error. The CacheDirLevels and - CacheDirLength directives define the structure of the directories - under the specified root directory.

+ CacheDirLength directives define the structure of + the directories under the specified root directory.

-

- CacheRoot c:/cacheroot
-

+

+ CacheRoot c:/cacheroot
+

top

CacheSize Directive

Description: The maximum amount of disk space that will be used by the cache in KBytes
Syntax: - CacheSize KBytes
Default: + CacheSize KBytes
Default: CacheSize 1000000
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache

The CacheSize directive sets the desired disk space @@ -210,13 +241,19 @@ The CacheGcUnused directive is currently not<

top

CacheTimeMargin Directive

Description: The minimum time margin to cache a document
Syntax: - CacheTimeMargin ?
Default: + CacheTimeMargin ?
Default: CacheTimeMargin ?
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_disk_cache
+

More detail will be added here, when the function is implemented.

-

- CacheTimeMargin
-

+

+ CacheTimeMargin X
+

+ +
+ The CacheTimeMargin directive is currently + not implemented. +
\ No newline at end of file diff --git a/docs/manual/mod/mod_mem_cache.html.en b/docs/manual/mod/mod_mem_cache.html.en index b9d451df1f..b02b0120d2 100644 --- a/docs/manual/mod/mod_mem_cache.html.en +++ b/docs/manual/mod/mod_mem_cache.html.en @@ -13,17 +13,20 @@
This module is experimental. Documentation is still under development...
-

mod_mem_cache implements an in-memory based storage manager. - mod_mem_cache can be configured to operate in two modes: caching open file - descriptors or caching objects in heap storage. mod_mem_cache - is most useful when used to cache locally generated content or to cache - backend server content for mod_proxy configured for ProxyPass - (aka reverse proxy)

-
-

mod_mem_cache requires the services of mod_cache.

-
-

Content stored and retrived keyed to the URL. Content with - access protections is not cached.

+

mod_mem_cache implements a memory based storage manager. + mod_mem_cache can be configured to operate in two modes: + caching open file descriptors or caching objects in heap storage. + mod_mem_cache is most useful when used to cache locally + generated content or to cache backend server content for + mod_proxy configured for + ProxyPass (aka reverse proxy)

+ +

Content is stored in and retrieved from the cache using URI based keys. Content with + access protection is not cached.

+ +

Note:

+

mod_mem_cache requires the services of mod_cache.

+

Directives

top

MCacheMaxObjectCount Directive

Description: The maximum number of objects allowed to be placed in the cache
Syntax: - MCacheMaxObjectCount value
Default: + MCacheMaxObjectCount value
Default: MCacheMaxObjectCount 1009
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_mem_cache

The MCacheMaxObjectCount directive sets the maximum - number of objects to be cached. If a new entry needs to be - inserted in the cache and the maximum number of objects is reached, an entry - will be removed to allow the new entry be cached.

+ number of objects to be cached. If a new object needs to be inserted in the cache + and the maximum number of objects has been reached, an object will be removed + to allow the new object to be cached. The object to be removed is selected using + the algorithm specified by MCacheRemovalAlgorithm.

-
- The value of MCacheMaxObjectCount is used to create - the open hash table. -
-

- MCacheMaxObjectCount 13001
-

+

Note:

+ The value of MCacheMaxObjectCount is used to create + the open hash table. +
+ +

+ MCacheMaxObjectCount 13001
+

top

MCacheMaxObjectSize Directive

Description: - The maximum size (in bytes) of an object to be placed in the cache
Syntax: - MCacheMaxObjectSize bytes
Default: + The maximum size (in bytes) of a document allowed in the +cache
Syntax: + MCacheMaxObjectSize bytes
Default: MCacheMaxObjectSize 10000
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_mem_cache

The MCacheMaxObjectSize directive sets the maximum - size of an object to be cached.

+ allowable size, in bytes, of a document for it to be considered cacheable.

-
- The size must be greater than MCacheMinObjectSize. -
+

Note:

+ The value of MCacheMaxObjectSize must be greater + than the value specified by the MCacheMinObjectSize + directive. +
-

- MCacheMaxObjectSize 6400000
-

+

+ MCacheMaxObjectSize 6400000
+

top

MCacheMinObjectSize Directive

Description: - The minimum size (in bytes) of an object to be placed in the cache
Syntax: - MCacheMinObjectSize bytes
Default: + The minimum size (in bytes) of a document to be allowed in the +cache
Syntax: + MCacheMinObjectSize bytes
Default: MCacheMinObjectSize 0
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_mem_cache

The MCacheMinObjectSize directive sets the minimum - size in bytes of an object to be cached.

+ size in bytes of a document for it to be considered cacheable.

-

- MCacheMinObjectSize 10000
-

+

+ MCacheMinObjectSize 10000
+

top

MCacheRemovalAlgorithm Directive

Description: - The algorithm used to remove entries from the cache
Syntax: - MCacheRemovalAlgorithm algorithm
Default: + The algorithm used to select documents for removal from the +cache
Syntax: + MCacheRemovalAlgorithm LRU|GDSF
Default: MCacheRemovalAlgorithm GDSF
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_mem_cache
-

The MCacheRemovalAlgorithm directive sets the algorithm - used to remove entries from the cache. - Two choices are available:
- LRU (Least Recently Used): LRU removes the objects that have not been - accessed for the longest time.
- GDSF (GreadyDual-Size): This algorithm assigns priority to cached objects - based on the coast of a cache miss and the size of the object. Objects with - smallest priority are removed first.

+

The MCacheRemovalAlgorithm directive specifies + the algorithm used to select documents for removal from the cache. + Two choices are available:
+ LRU (Least Recently Used): LRU removes the + documents that have not been accessed for the longest time.
+ GDSF (GreadyDual-Size): GDSF assigns a priority + to cached documents based on the cost of a cache miss and the size of + the document. Documents with the lowest priority are removed first.

-

- MCacheRemovalAlgorithm GDSF
- MCacheRemovalAlgorithm LRU
-

+

+ MCacheRemovalAlgorithm GDSF
+ MCacheRemovalAlgorithm LRU
+

top

MCacheSize Directive

Description: The maximum amount of memory used by the cache in KBytes
Syntax: - MCacheSize KBytes
Default: + MCacheSize KBytes
Default: MCacheSize 100
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_mem_cache
-

The MCacheSize directive sets the desired space - usage of the cache, in KBytes (1024-byte units). If a new entry needs to be - inserted in the cache and the size of the entry is greather than the - remaining size, entries will be removed until the new entry could be cached. - The removed entry is decided base on the MCacheRemovalAlgorithm algorithm

+

The MCacheSize directive sets the maximum amount of memory + to be used by the cache, in KBytes (1024-byte units). If a new object needs to be + inserted in the cache and the size of the object is greater than the + remaining memory, objects will be removed until the new object can be cached. + The object to be removed is selected using the algorithm specified by + MCacheRemovalAlgorithm.

-
- The size must be greater than MCacheMaxObjectSize. -
+

Note:

+ The MCacheSize value must be greater than the value + specified by the MCacheMaxObjectSize directive. +
-

- MCacheSize 700000
-

+

+ MCacheSize 700000
+

\ No newline at end of file diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 1ff066ecd2..85edc49849 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -165,21 +165,20 @@ store passwords BrowserMatchNoCase regex [!]env-variable[=value] [[!]env-variable[=value]] ...svdhBSets environment variables conditional on User-Agent without respect to case -CacheDefaultExpire seconds 3600 (one hour) svXThe default time in seconds to cache a document -CacheDisable cache_type url-stringsvXDisable caching of specified URLs by specified storage -manager -CacheEnable cache_type url-stringsvXEnable caching specified URLs in a specified storage +CacheDefaultExpire seconds 3600 (one hour) svXThe default duration to cache a document when no expiry date is specified. +CacheDisable url-stringsvXDisable caching of specified URLs +CacheEnable cache_type url-stringsvXEnable caching of specified URLs using a specified storage manager CacheFile file-path [file-path] ...sX- -CacheForceCompletion Percentage 60 svXPercentage of download to arrive for the cache to force -complete transfer -CacheIgnoreCacheControl On|Off Off svXIgnore requests from the client for uncached -content -CacheIgnoreNoLastMod On|Off Off svXIgnore responses where there is no Last Modified -Header -CacheLastModifiedFactor float 0.1 svXThe factor used to estimate the Expires date from the -LastModified date +CacheForceCompletion Percentage 60 svXPercentage of document served, after which the server +will complete caching the file even if the request is cancelled. +CacheIgnoreCacheControl On|Off Off svXIgnore the fact that the client requested the content not be +cached. +CacheIgnoreNoLastMod On|Off Off svXIgnore the fact that a response has no Last Modified +header. +CacheLastModifiedFactor float 0.1 svXThe factor used to compute an expiry date based on the +LastModified date. CacheMaxExpire seconds 86400 (one day) svXThe maximum time in seconds to cache a document CacheMaxStreamingBuffer size_in_bytes 0 svXMaximum amount of a streamed response to buffer in memory before declaring the response uncacheable -- 2.40.0