You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by nd...@apache.org on 2002/12/10 01:09:13 UTC

cvs commit: httpd-2.0/docs/manual/mod mod_mem_cache.html.en mod_mem_cache.xml quickreference.html.en

nd          2002/12/09 16:09:13

  Modified:    docs/manual/mod Tag: APACHE_2_0_BRANCH mod_mem_cache.html.en
                        mod_mem_cache.xml quickreference.html.en
  Log:
  backport: mod_mem_cache cleanup
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.9.2.1   +73 -73    httpd-2.0/docs/manual/mod/mod_mem_cache.html.en
  
  Index: mod_mem_cache.html.en
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_mem_cache.html.en,v
  retrieving revision 1.9
  retrieving revision 1.9.2.1
  diff -u -r1.9 -r1.9.2.1
  --- mod_mem_cache.html.en	6 Nov 2002 21:22:24 -0000	1.9
  +++ mod_mem_cache.html.en	10 Dec 2002 00:09:12 -0000	1.9.2.1
  @@ -9,125 +9,125 @@
                     </a></th><td>Experimental</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:
                     </a></th><td>mem_cache_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source�File:
                     </a></th><td>mod_mem_cache.c</td></tr></table><h3>Summary</h3>
  +    <div class="warning">
  +      This module is experimental. Documentation is still under
  +      development...
  +    </div>
   
  -<div class="warning">
  -This module is experimental. Documentation is still under development...
  -</div>
  -    <p><code class="module"><a href="../mod/mod_mem_cache.html">mod_mem_cache</a></code> implements a memory based storage manager. 
  -    <code class="module"><a href="../mod/mod_mem_cache.html">mod_mem_cache</a></code> can be configured to operate in two modes:
  -    caching open file descriptors or caching objects in heap storage.
  +    <p>This module <em>requires</em> the service of <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>. It acts as a support module for <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> and provides a memory based storage manager.
  +    <code class="module"><a href="../mod/mod_mem_cache.html">mod_mem_cache</a></code> can be configured to operate in two
  +    modes: caching open file descriptors or caching objects in heap storage.
       <code class="module"><a href="../mod/mod_mem_cache.html">mod_mem_cache</a></code> is most useful when used to cache locally
  -    generated content or to cache backend server content for
  -    <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> configured for
  -    <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> (aka <dfn>reverse proxy</dfn>)</p>
  -
  -    <p>Content is stored in and retrieved from the cache using URI based keys. Content with
  -    access protection is not cached.</p>
  +    generated content or to cache backend server content for <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> configured for <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> (aka <dfn>reverse proxy</dfn>).</p>
   
  -    <div class="note"><h3>Note:</h3>
  -      <p><code class="module"><a href="../mod/mod_mem_cache.html">mod_mem_cache</a></code> requires the services of <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>.</p>
  -    </div>
  +    <p>Content is stored in and retrieved from the cache using URI based
  +    keys. Content with access protection is not cached.</p>
   </div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#mcachemaxobjectcount">MCacheMaxObjectCount</a></li>
   <li><img alt="" src="../images/down.gif" /> <a href="#mcachemaxobjectsize">MCacheMaxObjectSize</a></li>
   <li><img alt="" src="../images/down.gif" /> <a href="#mcacheminobjectsize">MCacheMinObjectSize</a></li>
   <li><img alt="" src="../images/down.gif" /> <a href="#mcacheremovalalgorithm">MCacheRemovalAlgorithm</a></li>
   <li><img alt="" src="../images/down.gif" /> <a href="#mcachesize">MCacheSize</a></li>
  -</ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="MCacheMaxObjectCount" id="MCacheMaxObjectCount">MCacheMaxObjectCount</a> <a name="mcachemaxobjectcount" id="mcachemaxobjectcount">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
  -              </a></th><td>The maximum number of objects allowed to be placed in the cache</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
  +</ul><h3>See also</h3><ul class="seealso"><li><code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code></li><li><code class="module"><a href="../mod/mod_disk_cache.html">mod_disk_cache</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="MCacheMaxObjectCount" id="MCacheMaxObjectCount">MCacheMaxObjectCount</a> <a name="mcachemaxobjectcount" id="mcachemaxobjectcount">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
  +              </a></th><td>The maximum number of objects allowed to be placed in the
  +cache</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
                 </a></th><td><code>MCacheMaxObjectCount <var>value</var></code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
                 </a></th><td><code>MCacheMaxObjectCount 1009</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
  -              </a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
  +              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
                 </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
                 </a></th><td>mod_mem_cache</td></tr></table>
  -    <p>The <code class="directive">MCacheMaxObjectCount</code> directive sets the maximum
  -    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 <code class="directive">MCacheRemovalAlgorithm</code>.</p>
  -
  -    <div class="note"><h3>Note:</h3>
  -      The value of <code class="directive">MCacheMaxObjectCount</code> is used to create
  -      the open hash table.
  -    </div>
  +    <p>The <code class="directive">MCacheMaxObjectCount</code> directive sets the
  +    maximum number of objects to be cached. The value is used to create the
  +    open hash table. 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 <code class="directive"><a href="#mcacheremovalalgorithm">MCacheRemovalAlgorithm</a></code>.</p>
   
  -    <div class="example"><p><code>
  -      MCacheMaxObjectCount  13001<br />
  +    <div class="example"><h3>Example</h3><p><code>
  +      MCacheMaxObjectCount 13001
       </code></p></div>
   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="MCacheMaxObjectSize" id="MCacheMaxObjectSize">MCacheMaxObjectSize</a> <a name="mcachemaxobjectsize" id="mcachemaxobjectsize">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
                 </a></th><td>The maximum size (in bytes) of a document allowed in the
   cache</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
                 </a></th><td><code>MCacheMaxObjectSize <var>bytes</var></code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
                 </a></th><td><code>MCacheMaxObjectSize 10000</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
  -              </a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
  +              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
                 </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
                 </a></th><td>mod_mem_cache</td></tr></table>
  -    <p>The <code class="directive">MCacheMaxObjectSize</code> directive sets the maximum
  -    allowable size, in bytes, of a document for it to be considered cacheable.</p>
  -
  -    <div class="warning"><h3>Note:</h3>
  -      The value of <code class="directive">MCacheMaxObjectSize</code> must be greater
  -      than the value specified by the <code class="directive">MCacheMinObjectSize</code>
  -      directive.
  -    </div>
  +    <p>The <code class="directive">MCacheMaxObjectSize</code> directive sets the
  +    maximum allowable size, in bytes, of a document for it to be considered
  +    cacheable.</p>
   
  -    <div class="example"><p><code>
  -      MCacheMaxObjectSize  6400000<br />
  +    <div class="example"><h3>Example</h3><p><code>
  +      MCacheMaxObjectSize 6400000
       </code></p></div>
  +
  +    <div class="note"><h3>Note</h3>
  +      <p>The value of <code class="directive">MCacheMaxObjectSize</code> must be
  +      greater than the value specified by the <code class="directive"><a href="#mcacheminobjectsize">MCacheMinObjectSize</a></code> directive.</p>
  +    </div>
   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="MCacheMinObjectSize" id="MCacheMinObjectSize">MCacheMinObjectSize</a> <a name="mcacheminobjectsize" id="mcacheminobjectsize">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
                 </a></th><td>The minimum size (in bytes) of a document to be allowed in the
   cache</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
                 </a></th><td><code>MCacheMinObjectSize <var>bytes</var></code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
                 </a></th><td><code>MCacheMinObjectSize 0</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
  -              </a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
  +              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
                 </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
                 </a></th><td>mod_mem_cache</td></tr></table>
  -    <p>The <code class="directive">MCacheMinObjectSize</code> directive sets the minimum
  -    size in bytes of a document for it to be considered cacheable.</p>
  +    <p>The <code class="directive">MCacheMinObjectSize</code> directive sets the
  +    minimum size in bytes of a document for it to be considered
  +    cacheable.</p>
   
  -    <div class="example"><p><code>
  -      MCacheMinObjectSize  10000<br />
  +    <div class="example"><h3>Example</h3><p><code>
  +      MCacheMinObjectSize 10000
       </code></p></div>
   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="MCacheRemovalAlgorithm" id="MCacheRemovalAlgorithm">MCacheRemovalAlgorithm</a> <a name="mcacheremovalalgorithm" id="mcacheremovalalgorithm">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
                 </a></th><td>The algorithm used to select documents for removal from the
   cache</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
  -              </a></th><td><code>MCacheRemovalAlgorithm <code>LRU|GDSF</code></code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
  +              </a></th><td><code>MCacheRemovalAlgorithm LRU|GDSF</code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
                 </a></th><td><code>MCacheRemovalAlgorithm GDSF</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
  -              </a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
  +              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
                 </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
                 </a></th><td>mod_mem_cache</td></tr></table>
       <p>The <code class="directive">MCacheRemovalAlgorithm</code> directive specifies
       the algorithm used to select documents for removal from the cache.
  -    Two choices are available:<br />
  -    <code>LRU</code> (Least Recently Used): <code>LRU</code> removes the
  -    documents that have not been accessed for the longest time.<br />
  -    <code>GDSF</code> (GreadyDual-Size): <code>GDSF</code> 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.</p>
  -
  -    <div class="example"><p><code>
  -       MCacheRemovalAlgorithm  GDSF<br />
  -       MCacheRemovalAlgorithm  LRU<br />
  +    Two choices are available:</p>
  +
  +    <dl>
  +      <dt><code>LRU</code> (Least Recently Used)</dt>
  +      <dd><code>LRU</code> removes the documents that have not been accessed
  +      for the longest time.</dd>
  +
  +      <dt><code>GDSF</code> (GreadyDual-Size)</dt>
  +      <dd><code>GDSF</code> 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.</dd>
  +    </dl>
  +
  +    <div class="example"><h3>Example</h3><p><code>
  +      MCacheRemovalAlgorithm GDSF<br />
  +      MCacheRemovalAlgorithm LRU
       </code></p></div>
   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="MCacheSize" id="MCacheSize">MCacheSize</a> <a name="mcachesize" id="mcachesize">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
  -              </a></th><td>The maximum amount of memory used by the cache in KBytes</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
  +              </a></th><td>The maximum amount of memory used by the cache in
  +KBytes</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
                 </a></th><td><code>MCacheSize <var>KBytes</var></code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
                 </a></th><td><code>MCacheSize 100</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
  -              </a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
  +              </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status:
                 </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
                 </a></th><td>mod_mem_cache</td></tr></table>
  -    <p>The <code class="directive">MCacheSize</code> 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
  -    <code class="directive">MCacheRemovalAlgorithm</code>.</p>
  -
  -    <div class="warning"><h3>Note:</h3>
  -      The <code class="directive">MCacheSize</code> value must be greater than the value
  -      specified by the <code class="directive">MCacheMaxObjectSize</code> directive.
  -    </div>
  +    <p>The <code class="directive">MCacheSize</code> 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 <code class="directive"><a href="#mcacheremovalalgorithm">MCacheRemovalAlgorithm</a></code>.</p>
   
  -    <div class="example"><p><code>
  -      MCacheSize  700000<br />
  +    <div class="example"><h3>Example</h3><p><code>
  +      MCacheSize 700000
       </code></p></div>
  +
  +    <div class="note"><h3>Note</h3>
  +      <p>The <code class="directive">MCacheSize</code> value must be greater than
  +      the value specified by the <code class="directive"><a href="#mcachemaxobjectsize">MCacheMaxObjectSize</a></code> directive.</p>
  +    </div>
   </div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>
  
  
  
  1.3.2.1   +82 -77    httpd-2.0/docs/manual/mod/mod_mem_cache.xml
  
  Index: mod_mem_cache.xml
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_mem_cache.xml,v
  retrieving revision 1.3
  retrieving revision 1.3.2.1
  diff -u -r1.3 -r1.3.2.1
  --- mod_mem_cache.xml	6 Nov 2002 15:30:27 -0000	1.3
  +++ mod_mem_cache.xml	10 Dec 2002 00:09:12 -0000	1.3.2.1
  @@ -10,75 +10,75 @@
   <identifier>mem_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_mem_cache</module> implements a memory based storage manager. 
  -    <module>mod_mem_cache</module> can be configured to operate in two modes:
  -    caching open file descriptors or caching objects in heap storage.
  +    <p>This module <em>requires</em> the service of <module
  +    >mod_cache</module>. It acts as a support module for <module
  +    >mod_cache</module> and provides a memory based storage manager.
  +    <module>mod_mem_cache</module> can be configured to operate in two
  +    modes: caching open file descriptors or caching objects in heap storage.
       <module>mod_mem_cache</module> is most useful when used to cache locally
  -    generated content or to cache backend server content for
  -    <module>mod_proxy</module> configured for
  -    <directive module="mod_proxy">ProxyPass</directive> (aka <dfn>reverse proxy</dfn>)</p>
  -
  -    <p>Content is stored in and retrieved from the cache using URI based keys. Content with
  -    access protection is not cached.</p>
  +    generated content or to cache backend server content for <module
  +    >mod_proxy</module> configured for <directive module="mod_proxy"
  +    >ProxyPass</directive> (aka <dfn>reverse proxy</dfn>).</p>
   
  -    <note><title>Note:</title>
  -      <p><module>mod_mem_cache</module> requires the services of <module>mod_cache</module>.</p>
  -    </note>
  +    <p>Content is stored in and retrieved from the cache using URI based
  +    keys. Content with access protection is not cached.</p>
   </summary>
  +<seealso><module>mod_cache</module></seealso>
  +<seealso><module>mod_disk_cache</module></seealso>
   
   <directivesynopsis>
   <name>MCacheSize</name>
  -<description>The maximum amount of memory used by the cache in KBytes</description>
  +<description>The maximum amount of memory used by the cache in
  +KBytes</description>
   <syntax>MCacheSize <var>KBytes</var></syntax>
   <default>MCacheSize 100</default>
  -<contextlist><context>server config</context><context>virtual host</context>
  -</contextlist>
  +<contextlist><context>server config</context></contextlist>
   
   <usage>
  -    <p>The <directive>MCacheSize</directive> 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
  -    <directive>MCacheRemovalAlgorithm</directive>.</p>
  -
  -    <note type="warning"><title>Note:</title>
  -      The <directive>MCacheSize</directive> value must be greater than the value
  -      specified by the <directive>MCacheMaxObjectSize</directive> directive.
  -    </note>
  +    <p>The <directive>MCacheSize</directive> 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 <directive
  +    module="mod_mem_cache">MCacheRemovalAlgorithm</directive>.</p>
   
  -    <example>
  -      MCacheSize  700000<br />
  +    <example><title>Example</title>
  +      MCacheSize 700000
       </example>
  +
  +    <note><title>Note</title>
  +      <p>The <directive>MCacheSize</directive> value must be greater than
  +      the value specified by the <directive module="mod_mem_cache"
  +      >MCacheMaxObjectSize</directive> directive.</p>
  +    </note>
   </usage>
   </directivesynopsis>
   
   <directivesynopsis>
   <name>MCacheMaxObjectCount</name>
  -<description>The maximum number of objects allowed to be placed in the cache</description>
  +<description>The maximum number of objects allowed to be placed in the
  +cache</description>
   <syntax>MCacheMaxObjectCount <var>value</var></syntax>
   <default>MCacheMaxObjectCount 1009</default>
  -<contextlist><context>server config</context><context>virtual host</context>
  -</contextlist>
  +<contextlist><context>server config</context></contextlist>
   
   <usage>
  -    <p>The <directive>MCacheMaxObjectCount</directive> directive sets the maximum
  -    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 <directive>MCacheRemovalAlgorithm</directive>.</p>
  -
  -    <note><title>Note:</title>
  -      The value of <directive>MCacheMaxObjectCount</directive> is used to create
  -      the open hash table.
  -    </note>
  +    <p>The <directive>MCacheMaxObjectCount</directive> directive sets the
  +    maximum number of objects to be cached. The value is used to create the
  +    open hash table. 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 <directive
  +    module="mod_mem_cache">MCacheRemovalAlgorithm</directive>.</p>
   
  -    <example>
  -      MCacheMaxObjectCount  13001<br />
  +    <example><title>Example</title>
  +      MCacheMaxObjectCount 13001
       </example>
   </usage>
   </directivesynopsis>
  @@ -89,15 +89,15 @@
   cache</description>
   <syntax>MCacheMinObjectSize <var>bytes</var></syntax>
   <default>MCacheMinObjectSize 0</default>
  -<contextlist><context>server config</context><context>virtual host</context>
  -</contextlist>
  +<contextlist><context>server config</context></contextlist>
   
   <usage>
  -    <p>The <directive>MCacheMinObjectSize</directive> directive sets the minimum
  -    size in bytes of a document for it to be considered cacheable.</p>
  +    <p>The <directive>MCacheMinObjectSize</directive> directive sets the
  +    minimum size in bytes of a document for it to be considered
  +    cacheable.</p>
   
  -    <example>
  -      MCacheMinObjectSize  10000<br />
  +    <example><title>Example</title>
  +      MCacheMinObjectSize 10000
       </example>
   </usage>
   </directivesynopsis>
  @@ -108,22 +108,22 @@
   cache</description>
   <syntax>MCacheMaxObjectSize <var>bytes</var></syntax>
   <default>MCacheMaxObjectSize 10000</default>
  -<contextlist><context>server config</context><context>virtual host</context>
  -</contextlist>
  +<contextlist><context>server config</context></contextlist>
   
   <usage>
  -    <p>The <directive>MCacheMaxObjectSize</directive> directive sets the maximum
  -    allowable size, in bytes, of a document for it to be considered cacheable.</p>
  -
  -    <note type="warning"><title>Note:</title>
  -      The value of <directive>MCacheMaxObjectSize</directive> must be greater
  -      than the value specified by the <directive>MCacheMinObjectSize</directive>
  -      directive.
  -    </note>
  +    <p>The <directive>MCacheMaxObjectSize</directive> directive sets the
  +    maximum allowable size, in bytes, of a document for it to be considered
  +    cacheable.</p>
   
  -    <example>
  -      MCacheMaxObjectSize  6400000<br />
  +    <example><title>Example</title>
  +      MCacheMaxObjectSize 6400000
       </example>
  +
  +    <note><title>Note</title>
  +      <p>The value of <directive>MCacheMaxObjectSize</directive> must be
  +      greater than the value specified by the <directive
  +      module="mod_mem_cache">MCacheMinObjectSize</directive> directive.</p>
  +    </note>
   </usage>
   </directivesynopsis>
   
  @@ -131,24 +131,29 @@
   <name>MCacheRemovalAlgorithm</name>
   <description>The algorithm used to select documents for removal from the
   cache</description>
  -<syntax>MCacheRemovalAlgorithm <code>LRU|GDSF</code></syntax>
  +<syntax>MCacheRemovalAlgorithm LRU|GDSF</syntax>
   <default>MCacheRemovalAlgorithm GDSF</default>
  -<contextlist><context>server config</context><context>virtual host</context>
  -</contextlist>
  +<contextlist><context>server config</context></contextlist>
   
   <usage>
       <p>The <directive>MCacheRemovalAlgorithm</directive> directive specifies
       the algorithm used to select documents for removal from the cache.
  -    Two choices are available:<br />
  -    <code>LRU</code> (Least Recently Used): <code>LRU</code> removes the
  -    documents that have not been accessed for the longest time.<br />
  -    <code>GDSF</code> (GreadyDual-Size): <code>GDSF</code> 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.</p>
  -
  -    <example>
  -       MCacheRemovalAlgorithm  GDSF<br />
  -       MCacheRemovalAlgorithm  LRU<br />
  +    Two choices are available:</p>
  +
  +    <dl>
  +      <dt><code>LRU</code> (Least Recently Used)</dt>
  +      <dd><code>LRU</code> removes the documents that have not been accessed
  +      for the longest time.</dd>
  +
  +      <dt><code>GDSF</code> (GreadyDual-Size)</dt>
  +      <dd><code>GDSF</code> 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.</dd>
  +    </dl>
  +
  +    <example><title>Example</title>
  +      MCacheRemovalAlgorithm GDSF<br />
  +      MCacheRemovalAlgorithm LRU
       </example>
   </usage>
   </directivesynopsis>
  
  
  
  1.47.2.3  +7 -5      httpd-2.0/docs/manual/mod/quickreference.html.en
  
  Index: quickreference.html.en
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/mod/quickreference.html.en,v
  retrieving revision 1.47.2.2
  retrieving revision 1.47.2.3
  diff -u -r1.47.2.2 -r1.47.2.3
  --- quickreference.html.en	2 Dec 2002 20:02:23 -0000	1.47.2.2
  +++ quickreference.html.en	10 Dec 2002 00:09:12 -0000	1.47.2.3
  @@ -381,14 +381,16 @@
   <tr class="odd"><td><a href="mpm_common.html#maxsparethreads">MaxSpareThreads <var>number</var></a></td><td /><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Maximum number of idle threads</td></tr>
   <tr><td><a href="mpm_netware.html#maxthreads">MaxThreads <var>number</var></a></td><td> 250 </td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">-</td></tr>
   <tr class="odd"><td><a href="mpm_common.html#maxthreadsperchild">MaxThreadsPerChild <var>number</var></a></td><td> 64 </td><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Maximum number of threads per child process</td></tr>
  -<tr><td><a href="mod_mem_cache.html#mcachemaxobjectcount">MCacheMaxObjectCount <var>value</var></a></td><td> 1009 </td><td>sv</td><td>X</td></tr><tr><td class="descr" colspan="4">The maximum number of objects allowed to be placed in the cache</td></tr>
  -<tr class="odd"><td><a href="mod_mem_cache.html#mcachemaxobjectsize">MCacheMaxObjectSize <var>bytes</var></a></td><td> 10000 </td><td>sv</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">The maximum size (in bytes) of a document allowed in the
  +<tr><td><a href="mod_mem_cache.html#mcachemaxobjectcount">MCacheMaxObjectCount <var>value</var></a></td><td> 1009 </td><td>s</td><td>X</td></tr><tr><td class="descr" colspan="4">The maximum number of objects allowed to be placed in the
   cache</td></tr>
  -<tr><td><a href="mod_mem_cache.html#mcacheminobjectsize">MCacheMinObjectSize <var>bytes</var></a></td><td> 0 </td><td>sv</td><td>X</td></tr><tr><td class="descr" colspan="4">The minimum size (in bytes) of a document to be allowed in the
  +<tr class="odd"><td><a href="mod_mem_cache.html#mcachemaxobjectsize">MCacheMaxObjectSize <var>bytes</var></a></td><td> 10000 </td><td>s</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">The maximum size (in bytes) of a document allowed in the
   cache</td></tr>
  -<tr class="odd"><td><a href="mod_mem_cache.html#mcacheremovalalgorithm">MCacheRemovalAlgorithm <code>LRU|GDSF</code></a></td><td> GDSF </td><td>sv</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">The algorithm used to select documents for removal from the
  +<tr><td><a href="mod_mem_cache.html#mcacheminobjectsize">MCacheMinObjectSize <var>bytes</var></a></td><td> 0 </td><td>s</td><td>X</td></tr><tr><td class="descr" colspan="4">The minimum size (in bytes) of a document to be allowed in the
   cache</td></tr>
  -<tr><td><a href="mod_mem_cache.html#mcachesize">MCacheSize <var>KBytes</var></a></td><td> 100 </td><td>sv</td><td>X</td></tr><tr><td class="descr" colspan="4">The maximum amount of memory used by the cache in KBytes</td></tr>
  +<tr class="odd"><td><a href="mod_mem_cache.html#mcacheremovalalgorithm">MCacheRemovalAlgorithm LRU|GDSF</a></td><td> GDSF </td><td>s</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">The algorithm used to select documents for removal from the
  +cache</td></tr>
  +<tr><td><a href="mod_mem_cache.html#mcachesize">MCacheSize <var>KBytes</var></a></td><td> 100 </td><td>s</td><td>X</td></tr><tr><td class="descr" colspan="4">The maximum amount of memory used by the cache in
  +KBytes</td></tr>
   <tr class="odd"><td><a href="mod_cern_meta.html#metadir">MetaDir <var>directory</var></a></td><td> .web </td><td>svdh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Name of the directory to find CERN-style meta information
   files</td></tr>
   <tr><td><a href="mod_cern_meta.html#metafiles">MetaFiles on|off</a></td><td> off </td><td>svdh</td><td>E</td></tr><tr><td class="descr" colspan="4">Activates CERN meta-file processing</td></tr>