[deployment-guide/comm-rel: 494/727] Updated the CacheNegotiatedDocs directive description.

Jaromir Hradilek jhradile at fedoraproject.org
Tue Oct 19 13:06:25 UTC 2010


commit 5460f63f95dcfb79b8d3d7dc0f7a632c3edf93db
Author: Jaromir Hradilek <jhradile at redhat.com>
Date:   Wed Aug 25 17:35:06 2010 +0200

    Updated the CacheNegotiatedDocs directive description.

 en-US/The_Apache_HTTP_Server.xml |  113 +++++++++++++++++---------------------
 1 files changed, 51 insertions(+), 62 deletions(-)
---
diff --git a/en-US/The_Apache_HTTP_Server.xml b/en-US/The_Apache_HTTP_Server.xml
index bfa7be4..59bd1fb 100644
--- a/en-US/The_Apache_HTTP_Server.xml
+++ b/en-US/The_Apache_HTTP_Server.xml
@@ -706,6 +706,57 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
           </listitem>
         </varlistentry>
         <varlistentry>
+          <term><option>CacheNegotiatedDocs</option></term>
+          <listitem>
+            <para>
+              The <option>CacheNegotiatedDocs</option> directive allows you to enable caching the documents which were negotiated on the basis of content. It takes the following form:
+            </para>
+            <screen>CacheNegotiatedDocs <replaceable>option</replaceable></screen>
+            <para>
+              For a list of valid <replaceable>option</replaceable>s, see <xref linkend="table-apache-httpdconf-cachenegotiateddocs" />. Note that since the content-negotiated documents may change over time or because of the input from the requester, this option is turned off by default.
+            </para>
+            <table id="table-apache-httpdconf-cachenegotiateddocs">
+              <title>Available options</title>
+              <tgroup cols="2">
+                <colspec colname="option" colnum="1" colwidth="20*" />
+                <colspec colname="description" colnum="2" colwidth="60*" />
+                <thead>
+                  <row>
+                    <entry>
+                      Option
+                    </entry>
+                    <entry>
+                      Description
+                    </entry>
+                  </row>
+                </thead>
+                <tbody>
+                  <row>
+                    <entry>
+                      <option>On</option>
+                    </entry>
+                    <entry>
+                      Enables caching the content-negotiated documents.
+                    </entry>
+                  </row>
+                  <row>
+                    <entry>
+                      <option>Off</option>
+                    </entry>
+                    <entry>
+                      Disables caching the content-negotiated documents.
+                    </entry>
+                  </row>
+                </tbody>
+              </tgroup>
+            </table>
+            <example id="example-apache-httpdconf-cachenegotiateddocs">
+              <title>Using the <option>CacheNegotiatedDocs</option> directive</title>
+              <screen>CacheNegotiatedDocs On</screen>
+            </example>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
           <term><option>CacheRoot</option></term>
           <listitem>
             <para>
@@ -722,68 +773,6 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
           </listitem>
         </varlistentry>
       </variablelist>
-      <formalpara id="s2-apache-cachedirectives">
-        <title>Cache Directives</title>
-        <para>
-          A number of commented cache directives are supplied by the default Apache HTTP Server configuration file. In most cases, uncommenting these lines by removing the hash mark (<command>#</command>) from the beginning of the line is sufficient. The following, however, is a list of some of the more important cache-related directives.
-        </para>
-      </formalpara>
-      <itemizedlist>
-        <listitem>
-          <para>
-            <command>CacheEnable</command> — Specifies whether the cache is a disk, memory, or file descriptor cache. By default <command>CacheEnable</command> configures a disk cache for URLs at or below <filename>/</filename>.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            <command>CacheRoot</command> — Specifies the name of the directory containing cached files. The default <command>CacheRoot</command> is the <filename>/var/httpd/proxy/</filename> directory.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            <command>CacheSize</command> — Specifies how much space the cache can use in kilobytes. The default <command>CacheSize</command> is <command>5</command> KB.
-          </para>
-        </listitem>
-      </itemizedlist>
-      <para>
-        The following is a list of some of the other common cache-related directives.
-      </para>
-      <itemizedlist>
-        <listitem>
-          <para>
-            <command>CacheMaxExpire</command> — Specifies how long HTML documents are retained (without a reload from the originating Web server) in the cache. The default is <command>24</command> hours (<command>86400</command> seconds).
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            <command>CacheLastModifiedFactor</command> — Specifies the creation of an expiry (expiration) date for a document which did not come from its originating server with its own expiry set. The default <command>CacheLastModifiedFactor</command> is set to <command>0.1</command>, meaning that the expiry date for such documents equals one-tenth of the amount of time since the document was last modified.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            <command>CacheDefaultExpire</command> — Specifies the expiry time in hours for a document that was received using a protocol that does not support expiry times. The default is set to <command>1</command> hour (<command>3600</command> seconds).
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            <command>NoProxy</command> — Specifies a space-separated list of subnets, IP addresses, domains, or hosts whose content is not cached. This setting is most useful for Intranet sites.
-          </para>
-        </listitem>
-      </itemizedlist>
-      <formalpara id="s2-apache-cachenegotiateddocs">
-        <title>CacheNegotiatedDocs</title>
-        <indexterm>
-          <primary><command>CacheNegotiatedDocs</command></primary>
-          <secondary>Apache configuration directive</secondary>
-        </indexterm>
-        <indexterm>
-          <primary>configuration directives, Apache</primary>
-          <secondary><command>CacheNegotiatedDocs</command></secondary>
-        </indexterm>
-        <para>
-          By default, the Web server asks proxy servers not to cache any documents which were negotiated on the basis of content (that is, they may change over time or because of the input from the requester). If <command>CacheNegotiatedDocs</command> is set to <option>on</option>, this function is disabled and proxy servers are allowed to cache such documents.
-        </para>
-      </formalpara>
       <formalpara id="s2-apache-customlog">
         <title>CustomLog</title>
         <indexterm>


More information about the docs-commits mailing list