X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/2a1ead3efb940b7359bcc706c19bd8ddb0de7a11..820df9c66073b1345397642b46f1885b40b620e3:/cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 12a843b..8b0ad21 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -39,7 +39,8 @@ agefile::
 	to specify the date and time of the youngest commit in the repository.
 	The first line in the file is used as input to the "parse_date"
 	function in libgit. Recommended timestamp-format is "yyyy-mm-dd
-	hh:mm:ss". Default value: "info/web/last-modified".
+	hh:mm:ss". You may want to generate this file from a post-receive
+	hook. Default value: "info/web/last-modified".
 
 branch-sort::
 	Flag which, when set to "age", enables date ordering in the branch ref
@@ -50,32 +51,40 @@ cache-root::
 	Path used to store the cgit cache entries. Default value:
 	"/var/cache/cgit". See also: "MACRO EXPANSION".
 
+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".
+
 cache-dynamic-ttl::
 	Number which specifies the time-to-live, in minutes, for the cached
-	version of repository pages accessed without a fixed SHA1. Default
-	value: "5".
+	version of repository pages accessed without a fixed SHA1. Negative
+	values have infinite ttl. Default value: "5".
 
 cache-repo-ttl::
 	Number which specifies the time-to-live, in minutes, for the cached
-	version of the repository summary page. Default value: "5".
+	version of the repository summary page. Negative values have infinite
+	ttl. Default value: "5".
 
 cache-root-ttl::
 	Number which specifies the time-to-live, in minutes, for the cached
-	version of the repository index page. Default value: "5".
+	version of the repository index page. Negative values have infinite
+	ttl. 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".
+	of scanning a path for git repositories. Negative values have infinite
+	ttl. 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".
 
 cache-size::
 	The maximum number of entries in the cgit cache. Default value: "0"
 	(i.e. caching is disabled).
 
-cache-static-ttl::
-	Number which specifies the time-to-live, in minutes, for the cached
-	version of repository pages accessed with a fixed SHA1. Default value:
-	"5".
-
 case-sensitive-sort::
 	Sort items in the repo list case sensitively. Default value: "1".
 	See also: repository-sort, section-sort.
@@ -172,9 +181,9 @@ enable-git-config::
 	scan-path, section-from-path.
 
 favicon::
-	Url used as link to a shortcut icon for cgit. If specified, it is
-	suggested to use the value "/favicon.ico" since certain browsers will
-	ignore other values. Default value: none.
+	Url used as link to a shortcut icon for cgit. It is suggested to use
+	the value "/favicon.ico" since certain browsers will ignore other
+	values. Default value: "/favicon.ico".
 
 footer::
 	The content of the file specified with this option will be included
@@ -290,8 +299,9 @@ project-list::
 
 readme::
 	Text which will be used as default value for "repo.readme". Multiple
-	files may be specified, separated by a space, and cgit will use the
-	first found file in this list. Default value: none.
+	config keys may be specified, and cgit will use the first found file
+	in this list. This is useful in conjunction with scan-path. Default
+	value: none. See also: scan-path, repo.readme.
 
 remove-suffix::
 	If set to "1" and scan-path is enabled, if any repositories are found
@@ -621,6 +631,14 @@ clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
 css=/css/cgit.css
 
 
+# Show owner on index page
+enable-index-owner=1
+
+
+# Allow http transport git clone
+enable-git-clone=1
+
+
 # Show extra links for each repository on the index page
 enable-index-links=1
 
@@ -637,6 +655,10 @@ enable-log-filecount=1
 enable-log-linecount=1
 
 
+# Sort branches by date
+branch-sort=age
+
+
 # Add a cgit favicon
 favicon=/favicon.ico
 
@@ -678,6 +700,47 @@ mimetype.png=image/png
 mimetype.svg=image/svg+xml
 
 
+# Highlight source code with python pygments-based highligher
+source-filter=/var/www/cgit/filters/syntax-highlighting.py
+
+# Format markdown, restructuredtext, manpages, text files, and html files
+# through the right converters
+about-filter=/var/www/cgit/filters/about-formatting.sh
+
+##
+## Search for these files in the root of the default branch of repositories
+## for coming up with the about page:
+##
+readme=:README.md
+readme=:readme.md
+readme=:README.mkd
+readme=:readme.mkd
+readme=:README.rst
+readme=:readme.rst
+readme=:README.html
+readme=:readme.html
+readme=:README.htm
+readme=:readme.htm
+readme=:README.txt
+readme=:readme.txt
+readme=:README
+readme=:readme
+readme=:INSTALL.md
+readme=:install.md
+readme=:INSTALL.mkd
+readme=:install.mkd
+readme=:INSTALL.rst
+readme=:install.rst
+readme=:INSTALL.html
+readme=:install.html
+readme=:INSTALL.htm
+readme=:install.htm
+readme=:INSTALL.txt
+readme=:install.txt
+readme=:INSTALL
+readme=:install
+
+
 ##
 ## List of repositories.
 ## PS: Any repositories listed when section is unset will not be