cgitrc.5: we mean a cgi response, not request

[cgit.git] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 8eafc4a8ff4ff031d5b792236253b59ce013c890..104b223b9b9e64c62c5c6d2c8e7c35db8fbb1960 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -60,37 +60,41 @@ cache-root::
 
 cache-static-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
-       version of repository pages accessed with a fixed SHA1. Negative
-       values have infinite ttl. Default value: -1".
+       version of repository pages accessed with a fixed SHA1. See also:
+       "CACHE". Default value: -1".
 
 cache-dynamic-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
-       version of repository pages accessed without a fixed SHA1. Negative
-       values have infinite ttl. Default value: "5".
+       version of repository pages accessed without a fixed SHA1. See also:
+       "CACHE". Default value: "5".
 
 cache-repo-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
-       version of the repository summary page. Negative values have infinite
-       ttl. Default value: "5".
+       version of the repository summary page. See also: "CACHE". Default
+       value: "5".
 
 cache-root-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
-       version of the repository index page. Negative values have infinite
-       ttl. Default value: "5".
+       version of the repository index page. See also: "CACHE". Default
+       value: "5".
 
 cache-scanrc-ttl::
        Number which specifies the time-to-live, in minutes, for the result
-       of scanning a path for git repositories. Negative values have infinite
-       ttl. Default value: "15".
+       of scanning a path for git repositories. See also: "CACHE". Default
+       value: "15".
 
 cache-about-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
-       version of the repository about page. Negative values have infinite
-       ttl. Default value: "15".
+       version of the repository about page. See also: "CACHE". Default
+       value: "15".
+
+cache-snapshot-ttl::
+       Number which specifies the time-to-live, in minutes, for the cached
+       version of snapshots. See also: "CACHE". Default value: "5".
 
 cache-size::
-       The maximum number of entries in the cgit cache. Default value: "0"
-       (i.e. caching is disabled).
+       The maximum number of entries in the cgit cache. When set to "0",
+       caching is disabled. See also: "CACHE". Default value: "0"
 
 case-sensitive-sort::
        Sort items in the repo list case sensitively. Default value: "1".
@@ -599,7 +603,7 @@ specification with the relevant string; available values are:
                This is called when the current filtering operation is
                completed. It must return an integer value. Usually 0
                indicates success.
-       
+
        Additionally, cgit exposes to the Lua the following built-in functions:
 
        'html(str)'::
@@ -663,7 +667,7 @@ auth filter::
        the http cookie and return a 0 if it is invalid or 1 if it is invalid,
        in the exit code / close function. If the filter action is
        "authenticate-post", this filter receives POST'd parameters on
-       standard input, and should write a complete CGI request, preferably
+       standard input, and should write a complete CGI response, preferably
        with a 302 redirect, and write to output one or more "Set-Cookie"
        HTTP headers, each followed by a newline.
 
@@ -712,6 +716,16 @@ the environment variables defined in "FILTER API":
 - repo.clone-url
 
 
+CACHE
+------
+
+All cache ttl values are in minutes. Negative ttl values indicate that a page
+type will never expire, and thus the first time a URL is accessed, the result
+will be cached indefinitely, even if the underlying git repository changes.
+Conversely, when a ttl value is zero, the cache is disabled for that
+particular page type, and the page type is never cached.
+
+
 EXAMPLE CGITRC FILE
 -------------------