X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/b826537cb4aa2358027ffcb1dd6a87274734e962..eeaffc33432d3cf91902cac3eab50c0598bdaa19:/cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 682d8bb..b7570db 100644
--- 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)'::
@@ -645,7 +649,7 @@ source filter::
 	filtered contents is expected on standard output.
 
 auth filter::
-	The authentication filter receives 11 parameters:
+	The authentication filter receives 12 parameters:
 	  - filter action, explained below, which specifies which action the
 	    filter is called for
 	  - http cookie
@@ -656,8 +660,9 @@ auth filter::
 	  - cgit repo
 	  - cgit page
 	  - cgit url
+	  - cgit login url
 	When the filter action is "body", this filter must write to output the
-	HTML for displaying the login form, which POSTs to "/?p=login". When
+	HTML for displaying the login form, which POSTs to the login url. When
 	the filter action is "authenticate-cookie", this filter must validate
 	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
@@ -711,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
 -------------------