From 9c091990f1070ad6f79830d65561178c5876c5c5 Mon Sep 17 00:00:00 2001
From: Brian Pane <brianp@apache.org>
Date: Thu, 5 Sep 2002 07:22:23 +0000
Subject: [PATCH] Added an entry for mod_cache's new CacheMaxStreamingBuffer
 directive

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96643 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/manual/mod/mod_cache.xml | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml
index 7501b8c304..2a920cb3e7 100644
--- a/docs/manual/mod/mod_cache.xml
+++ b/docs/manual/mod/mod_cache.xml
@@ -228,13 +228,13 @@ This feature is currently <em>not</em> implemented.
 
 <directivesynopsis>
 <name>CacheForceCompletion</name>
-<description>Percentage of download to arrive for the cache to force complete transfert</description>
+<description>Percentage of download to arrive for the cache to force complete transfer</description>
 <syntax>CacheLastModifiedFactor <em>Percentage</em></syntax>
 <default>CacheLastModifiedFactor 60</default>
 <contextlist><context>server config</context></contextlist>
 
 <usage>
-    <p>Percentage of download to arrive for the cache to force complete transfert.</p>
+    <p>Percentage of download to arrive for the cache to force complete transfer.</p>
 
     <example>
     CacheForceCompletion  
@@ -245,4 +245,24 @@ This feature is currently <em>not</em> implemented.
 </usage>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>CacheMaxStreamingBuffer</name>
+<description>Maximum amount of a streamed response to buffer in memory before declaring the response uncacheable</description>
+<syntax>CacheMaxStreamingBuffer <em>size_in_bytes</em></syntax>
+<default>CacheMaxStreamingBuffer 0</default>
+<contextlist><context>server config</context></contextlist>
+
+<usage>
+    <p>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 <em>not</em> 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.</p>
+<p>Note: Using a nonzero value for CacheMaxStreamingBuffer will not delay the transmission of the response to the client.  As soon as mod_cache copies a
+block of streamed content into a buffer, it sends the block on to the next
+output filter for delivery to the client.</p>
+
+    <example>
+    # Enable caching of streamed responses up to 64KB:
+    CacheMaxStreamingBuffer  65536
+    </example>
+</usage>
+</directivesynopsis>
+
 </modulesynopsis>
-- 
2.40.0