X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/92f9b53c4211cd2c8241b62db37affd91dab358d..74061ed5f03e72796450aa3b8ca1cf6ced5d59e2:/cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 54490eb..df494aa 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -14,6 +14,13 @@ repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 lines, and lines starting with '#', are ignored.
 
 
+LOCATION
+--------
+The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
+runtime, cgit will consult the environment variable CGIT_CONFIG and, if
+defined, use its value instead.
+
+
 GLOBAL SETTINGS
 ---------------
 about-filter::
@@ -47,6 +54,10 @@ cache-root-ttl::
 	Number which specifies the time-to-live, in minutes, for the cached
 	version of the repository index page. 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. Default value: "15".
+
 cache-size::
 	The maximum number of entries in the cgit cache. Default value: "0"
 	(i.e. caching is disabled).
@@ -189,8 +200,8 @@ renamelimit::
 	  `man git-diff`). Default value: "-1".
 
 repo.group::
-	A value for the current repository group, which all repositories
-	specified after this setting will inherit. Default value: none.
+	Legacy alias for 'section' which will be deprecated starting with
+	cgit-1.0.
 
 robots::
 	Text used as content for the "robots" meta-tag. Default value:
@@ -209,15 +220,20 @@ root-title::
 	Text printed as heading on the repository index page. Default value:
 	"Git Repository Browser".
 
+scan-path::
+	A path which will be scanned for repositories. If caching is enabled,
+	the result will be cached as a cgitrc include-file in the cache
+	directory. Default value: none. See also: cache-scanrc-ttl.
+
+section:
+	The name of the current repository section - all repositories defined
+	after this option will inherit the current section name. Default value:
+	none.
+
 snapshots::
-	Text which specifies the default (and allowed) set of snapshot formats
-	supported by cgit. The value is a space-separated list of zero or more
-	of the following values:
-		"tar"		uncompressed tar-file
-		"tar.gz"	gzip-compressed tar-file
-		"tar.bz2"	bzip-compressed tar-file
-		"zip"		zip-file
-	Default value: none.
+	Text which specifies the default set of snapshot formats generated by
+	cgit. The value is a space-separated list of zero or more of the
+	values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
 
 source-filter::
 	Specifies a command which will be invoked to format plaintext blobs
@@ -299,6 +315,9 @@ repo.snapshots::
 	A mask of allowed snapshot-formats for this repo, restricted by the
 	"snapshots" global setting. Default value: <snapshots>.
 
+repo.section::
+	Override the current section for this repository. Default value: none.
+
 repo.source-filter::
 	Override the default source-filter. Default value: <source-filter>.
 
@@ -307,6 +326,15 @@ repo.url::
 	setting specified for each repo. Default value: none.
 
 
+REPOSITORY-SPECIFIC CGITRC FILE
+-------------------------------
+When the option 'scan-path' is used to auto-discover git repositories, cgit
+will try to parse the file 'cgitrc' within any found repository. Such a repo-
+specific config file may contain any of the repo-specific options described
+above, except 'repo.url' and 'repo.path'. Also, in a repo-specific config
+file, the 'repo.' prefix is dropped from the config option names.
+
+
 EXAMPLE CGITRC FILE
 -------------------