X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/b2cf630a4b423bbda6507b7f658042563e76b36e..859d106d5e8d884bf8f25b2ceea8600b2987c387:/cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 60539d7..8e31578 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -42,7 +42,7 @@ agefile::
 
 cache-root::
 	Path used to store the cgit cache entries. Default value:
-	"/var/cache/cgit".
+	"/var/cache/cgit". See also: "MACRO EXPANSION".
 
 cache-dynamic-ttl::
 	Number which specifies the time-to-live, in minutes, for the cached
@@ -106,6 +106,11 @@ enable-gitweb-owner::
 	for the git config value "gitweb.owner" to determine the owner.
 	Default value: "1". See also: scan-path.
 
+enable-http-clone::
+	If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
+	If you use an alternate way of serving git repositories, you may wish
+	to disable this. Default value: "1".
+
 enable-index-links::
 	Flag which, when set to "1", will make cgit generate extra links for
 	each repo in the repository index (specifically, to the "summary",
@@ -156,7 +161,7 @@ header::
 
 include::
 	Name of a configfile to include before the rest of the current config-
-	file is parsed. Default value: none.
+	file is parsed. Default value: none. See also: "MACRO EXPANSION".
 
 index-header::
 	The content of the file specified with this option will be included
@@ -238,7 +243,8 @@ noheader::
 project-list::
 	A list of subdirectories inside of scan-path, relative to it, that
 	should loaded as git repositories. This must be defined prior to
-	scan-path. Default value: none. See also: scan-path.
+	scan-path. Default value: none. See also: scan-path, "MACRO
+	EXPANSION".
 
 readme::
 	Text which will be used as default value for "repo.readme". Default
@@ -288,8 +294,10 @@ scan-path::
 	the result will be cached as a cgitrc include-file in the cache
 	directory. If project-list has been defined prior to scan-path,
 	scan-path loads only the directories listed in the file pointed to by
-	project-list. Default value: none. See also: cache-scanrc-ttl,
-	project-list.
+	project-list. Be advised that only the global settings taken
+	before the scan-path directive will be applied to each repository.
+	Default value: none. See also: cache-scanrc-ttl, project-list,
+	"MACRO EXPANSION".
 
 section::
 	The name of the current repository section - all repositories defined
@@ -309,7 +317,8 @@ side-by-side-diffs::
 snapshots::
 	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.
+	values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
+	none.
 
 source-filter::
 	Specifies a command which will be invoked to format plaintext blobs
@@ -485,6 +494,26 @@ allocated buffer within cgit then only the environment variables that fit
 in the allocated buffer are handed to the filter.
 
 
+MACRO EXPANSION
+---------------
+The following cgitrc options supports a simple macro expansion feature,
+where tokens prefixed with "$" are replaced with the value of a similary
+named environment variable:
+
+- cache-root
+- include
+- project-list
+- scan-path
+
+Macro expansion will also happen on the content of $CGIT_CONFIG, if
+defined.
+
+One usage of this feature is virtual hosting, which in its simplest form
+can be accomplished by adding the following line to /etc/cgitrc:
+
+	include=/etc/cgitrc.d/$HTTP_HOST
+
+
 EXAMPLE CGITRC FILE
 -------------------