home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278282_mod_disk_cache.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  11KB  |  348 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.5.2.5 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_disk_cache.xml.meta">
  23.  
  24. <name>mod_disk_cache</name>
  25. <description>Content cache storage manager keyed to URIs</description>
  26. <status>Experimental</status>
  27. <sourcefile>mod_disk_cache.c</sourcefile>
  28. <identifier>disk_cache_module</identifier>
  29.  
  30. <summary>
  31.     <note type="warning">
  32.       This module is experimental. Documentation is still under development...
  33.     </note>
  34.  
  35.     <p><module>mod_disk_cache</module> implements a disk based storage
  36.     manager. It is primarily of use in conjunction with
  37.     <module>mod_proxy</module>.</p>
  38.  
  39.     <p>Content is stored in and retrieved from the cache using URI based
  40.     keys. Content with access protection is not cached.</p>
  41.  
  42.     <note><title>Note:</title>
  43.       <p><module>mod_disk_cache</module> requires the services of
  44.       <module>mod_cache</module>.</p>
  45.     </note>
  46. </summary>
  47.  
  48. <directivesynopsis>
  49. <name>CacheRoot</name>
  50. <description>The directory root under which cache files are
  51. stored</description>
  52. <syntax>CacheRoot <var>directory</var></syntax>
  53. <contextlist><context>server config</context><context>virtual host</context>
  54. </contextlist>
  55.  
  56. <usage>
  57.     <p>The <directive>CacheRoot</directive> directive defines the name of
  58.     the directory on the disk to contain cache files. If the <module
  59.     >mod_disk_cache</module> module has been loaded or compiled in to the
  60.     Apache server, this directive <em>must</em> be defined. Failing to
  61.     provide a value for <directive>CacheRoot</directive> will result in
  62.     a configuration file processing error. The <directive
  63.     module="mod_disk_cache">CacheDirLevels</directive> and <directive
  64.     module="mod_disk_cache">CacheDirLength</directive> directives define
  65.     the structure of the directories under the specified root directory.</p>
  66.  
  67.     <example>
  68.       CacheRoot c:/cacheroot
  69.     </example>
  70. </usage>
  71. </directivesynopsis>
  72.  
  73. <directivesynopsis>
  74. <name>CacheSize</name>
  75. <description>The maximum amount of disk space that will be used by the
  76. cache in KBytes</description>
  77. <syntax>CacheSize <var>KBytes</var></syntax>
  78. <default>CacheSize 1000000</default>
  79. <contextlist><context>server config</context><context>virtual host</context>
  80. </contextlist>
  81.  
  82. <usage>
  83.     <p>The <directive>CacheSize</directive> directive sets the desired
  84.     disk space usage of the cache, in KBytes (1024-byte units). This
  85.     directive does not put a  hard limit on the size of the cache. The
  86.     garbage collector will delete files until the usage is at or below the
  87.     settings. Always use a value that is lower than the available disk
  88.     space.</p>
  89.  
  90.     <example>
  91.       CacheSize  5000000
  92.     </example>
  93. </usage>
  94. </directivesynopsis>
  95.  
  96. <directivesynopsis>
  97. <name>CacheGcInterval</name>
  98. <description>The interval between garbage collection attempts.</description>
  99. <syntax>CacheGcInterval <var>hours</var></syntax>
  100. <contextlist><context>server config</context><context>virtual host</context>
  101. </contextlist>
  102.  
  103. <usage>
  104.     <p>The <directive>CacheGcInterval</directive> directive specifies the
  105.     number of hours to wait between attempts to free up disk space.</p>
  106.     <p>More detail will be added here, when the function is implemented.</p>
  107.  
  108.     <example>
  109.       CacheGcInterval  24<br />
  110.     </example>
  111.  
  112.     <note type="warning">
  113.       The <directive>CacheGcInterval</directive> directive is currently
  114.       <em>not</em> implemented.
  115.     </note>
  116. </usage>
  117. </directivesynopsis>
  118.  
  119. <directivesynopsis>
  120. <name>CacheDirLevels</name>
  121. <description>The number of levels of subdirectories in the
  122. cache.</description>
  123. <syntax>CacheDirLevels <var>levels</var></syntax>
  124. <default>CacheDirLevels 3</default>
  125. <contextlist><context>server config</context><context>virtual host</context>
  126. </contextlist>
  127.  
  128. <usage>
  129.     <p>The <directive>CacheDirLevels</directive> directive sets the number
  130.     of subdirectory levels in the cache. Cached data will be saved this
  131.     many directory levels below the <directive module="mod_disk_cache"
  132.     >CacheRoot</directive> directory.</p>
  133.  
  134.     <note>
  135.       <p>The result of <directive>CacheDirLevels</directive>*
  136.       <directive module="mod_disk_cache">CacheDirLength</directive> must
  137.       not be higher than 20.</p>
  138.     </note>
  139.  
  140.     <example>
  141.       CacheDirLevels  5
  142.     </example>
  143. </usage>
  144. </directivesynopsis>
  145.  
  146. <directivesynopsis>
  147. <name>CacheDirLength</name>
  148. <description>The number of characters in subdirectory names</description>
  149. <syntax>CacheDirLength <var>length</var></syntax>
  150. <default>CacheDirLength 2</default>
  151. <contextlist><context>server config</context><context>virtual host</context>
  152. </contextlist>
  153.  
  154. <usage>
  155.     <p>The <directive>CacheDirLength</directive> directive sets the number
  156.     of characters for each subdirectory name in the cache hierarchy.</p>
  157.  
  158.     <note>
  159.       <p>The result of <directive module="mod_disk_cache"
  160.       >CacheDirLevels</directive>* <directive>CacheDirLength</directive>
  161.       must not be higher than 20.</p>
  162.     </note>
  163.  
  164.     <example>
  165.       CacheDirLength  4
  166.     </example>
  167. </usage>
  168. </directivesynopsis>
  169.  
  170. <directivesynopsis>
  171. <name>CacheExpiryCheck</name>
  172. <description>Indicates if the cache observes Expires dates when seeking
  173. files</description>
  174. <syntax>CacheExpiryCheck On|Off</syntax>
  175. <default>CacheExpiryCheck On</default>
  176. <contextlist><context>server config</context><context>virtual host</context>
  177. </contextlist>
  178.  
  179. <usage>
  180.     <p>More detail will be added here, when the function is implemented.</p>
  181.  
  182.     <example>
  183.       CacheExpiryCheck Off<br />
  184.     </example>
  185.  
  186.     <note type="warning">
  187.       The <directive>CacheExpiryCheck</directive> directive is currently
  188.       <em>not</em> implemented.
  189.     </note>
  190. </usage>
  191. </directivesynopsis>
  192.  
  193. <directivesynopsis>
  194. <name>CacheMinFileSize</name>
  195. <description>The minimum size (in bytes) of a document to be placed in the
  196. cache</description>
  197. <syntax>CacheMinFileSize <var>bytes</var></syntax>
  198. <default>CacheMinFileSize 1</default>
  199. <contextlist><context>server config</context><context>virtual host</context>
  200. </contextlist>
  201.  
  202. <usage>
  203.     <p>The <directive>CacheMinFileSize</directive> directive sets the
  204.     minimum size, in bytes, for a document to be considered for storage
  205.     in the cache.</p>
  206.  
  207.     <example>
  208.       CacheMinFileSize 64
  209.     </example>
  210. </usage>
  211. </directivesynopsis>
  212.  
  213. <directivesynopsis>
  214. <name>CacheMaxFileSize</name>
  215. <description>The maximum size (in bytes) of a document to be placed in the
  216. cache</description>
  217. <syntax>CacheMaxFileSize <var>bytes</var></syntax>
  218. <default>CacheMaxFileSize 1000000</default>
  219. <contextlist><context>server config</context><context>virtual host</context>
  220. </contextlist>
  221.  
  222. <usage>
  223.     <p>The <directive>CacheMaxFileSize</directive> directive sets the
  224.     maximum size, in bytes, for a document to be considered for storage in
  225.     the cache.</p>
  226.  
  227.     <example>
  228.       CacheMaxFileSize 64000
  229.     </example>
  230. </usage>
  231. </directivesynopsis>
  232.  
  233. <directivesynopsis>
  234. <name>CacheTimeMargin</name>
  235. <description>The minimum time margin to cache a document</description>
  236. <syntax>CacheTimeMargin <var>?</var></syntax>
  237. <default>CacheTimeMargin ?</default>
  238. <contextlist><context>server config</context><context>virtual host</context>
  239. </contextlist>
  240.  
  241. <usage>
  242.     <p>More detail will be added here, when the function is implemented.</p>
  243.  
  244.     <example>
  245.       CacheTimeMargin X
  246.     </example>
  247.  
  248.     <note type="warning">
  249.       The <directive>CacheTimeMargin</directive> directive is currently
  250.       <em>not</em> implemented.
  251.     </note>
  252. </usage>
  253. </directivesynopsis>
  254.  
  255. <directivesynopsis>
  256. <name>CacheGcDaily</name>
  257. <description>The recurring time each day for garbage collection to be run.
  258. (24 hour clock)</description>
  259. <syntax>CacheGcDaily <var>time</var></syntax>
  260. <default>CacheGcDaily ?</default>
  261. <contextlist><context>server config</context><context>virtual host</context>
  262. </contextlist>
  263.  
  264. <usage>
  265.     <p>More detail will be added here, when the function is implemented.</p>
  266.  
  267.     <example>
  268.       CacheGcDaily 23:59
  269.     </example>
  270.  
  271.     <note type="warning">
  272.       The <directive>CacheGcDaily</directive> directive is currently
  273.       <em>not</em> implemented.
  274.     </note>
  275. </usage>
  276. </directivesynopsis>
  277.  
  278. <directivesynopsis>
  279. <name>CacheGcUnused</name>
  280. <description>The time to retain unreferenced cached files that match a
  281. URL.</description>
  282. <syntax>CacheGcUnused <var>hours</var> <var>url-string</var></syntax>
  283. <default>CacheGcUnused ?</default>
  284. <contextlist><context>server config</context><context>virtual host</context>
  285. </contextlist>
  286.  
  287. <usage>
  288.     <p>More detail will be added here, when the function is implemented.</p>
  289.  
  290.     <example>
  291.       CacheGcUnused 12 /local_images
  292.     </example>
  293.  
  294.     <note type="warning">
  295.       The <directive>CacheGcUnused</directive> directive is currently
  296.       <em>not</em> implemented.
  297.     </note>
  298. </usage>
  299. </directivesynopsis>
  300.  
  301. <directivesynopsis>
  302. <name>CacheGcClean</name>
  303. <description>The time to retain unchanged cached files that match a
  304. URL</description>
  305. <syntax>CacheGcClean <var>hours</var> <var>url-string</var></syntax>
  306. <default>CacheGcClean ?</default>
  307. <contextlist><context>server config</context><context>virtual host</context>
  308. </contextlist>
  309.  
  310. <usage>
  311.     <p>More detail will be added here, when the function is implemented.</p>
  312.  
  313.     <example>
  314.       CacheGcClean 12 /daily_scripts
  315.     </example>
  316.  
  317.     <note type="warning">
  318.       The <directive>CacheGcClean</directive> directive is currently
  319.       <em>not</em> implemented.
  320.     </note>
  321. </usage>
  322. </directivesynopsis>
  323.  
  324. <directivesynopsis>
  325. <name>CacheGcMemUsage</name>
  326. <description>The maximum kilobytes of memory used for garbage
  327. collection</description>
  328. <syntax>CacheGcMemUsage <var>KBytes</var></syntax>
  329. <default>CacheGcMemUsage ?</default>
  330. <contextlist><context>server config</context><context>virtual host</context>
  331. </contextlist>
  332.  
  333. <usage>
  334.     <p>More detail will be added here, when the function is implemented.</p>
  335.  
  336.     <example>
  337.       CacheGcMemUsage 16
  338.     </example>
  339.  
  340.     <note type="warning">
  341.       The <directive>CacheGcMemUsage</directive> directive is currently
  342.       <em>not</em> implemented.
  343.     </note>
  344. </usage>
  345. </directivesynopsis>
  346.  
  347. </modulesynopsis>
  348.