cgitrc.5.txt: describe where/how cgit will locate cgitrc

Signed-off-by: Lars Hjemli <hjemli@gmail.com>

1 files changed, 7 insertions, 0 deletions

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 54490eb..3c35b02 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,144 +1,151 @@
 CGITRC(5)
 ========
 
 
 NAME
 ----
 cgitrc - runtime configuration for cgit
 
 
 SYNOPSIS
 --------
 Cgitrc contains all runtime settings for cgit, including the list of git
 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::
 	Specifies a command which will be invoked to format the content of
 	about pages (both top-level and for each repository). The command will
 	get the content of the about-file on its STDIN, and the STDOUT from the
 	command will be included verbatim on the about page. Default value:
 	none.
 
 agefile::
 	Specifies a path, relative to each repository path, which can be used
 	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".
 
 cache-root::
 	Path used to store the cgit cache entries. Default value:
 	"/var/cache/cgit".
 
 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".
 
 cache-repo-ttl::
 	Number which specifies the time-to-live, in minutes, for the cached
 	version of the repository summary page. 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".
 
 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".
 
 clone-prefix::
 	Space-separated list of common prefixes which, when combined with a
 	repository url, generates valid clone urls for the repository. This
 	setting is only used if `repo.clone-url` is unspecified. Default value:
 	none.
 
 commit-filter::
 	Specifies a command which will be invoked to format commit messages.
 	The command will get the message on its STDIN, and the STDOUT from the
 	command will be included verbatim as the commit message, i.e. this can
 	be used to implement bugtracker integration. Default value: none.
 
 css::
 	Url which specifies the css document to include in all cgit pages.
 	Default value: "/cgit.css".
 
 embedded::
 	Flag which, when set to "1", will make cgit generate a html fragment
 	suitable for embedding in other html pages. Default value: none. See
 	also: "noheader".
 	
 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",
 	"commit" and "tree" pages). Default value: "0".
 
 enable-log-filecount::
 	Flag which, when set to "1", will make cgit print the number of
 	modified files for each commit on the repository log page. Default
 	value: "0".
 
 enable-log-linecount::
 	Flag which, when set to "1", will make cgit print the number of added
 	and removed lines for each commit on the repository log page. Default
 	value: "0".
 
 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.
 
 footer::
 	The content of the file specified with this option will be included
 	verbatim at the bottom of all pages (i.e. it replaces the standard
 	"generated by..." message. Default value: none.
 
 head-include::
 	The content of the file specified with this option will be included
 	verbatim in the html HEAD section on all pages. Default value: none.
 
 header::
 	The content of the file specified with this option will be included
 	verbatim at the top of all pages. Default value: none.
 
 include::
 	Name of a configfile to include before the rest of the current config-
 	file is parsed. Default value: none.
 
 index-header::
 	The content of the file specified with this option will be included
 	verbatim above the repository index. This setting is deprecated, and
 	will not be supported by cgit-1.0 (use root-readme instead). Default
 	value: none.
 
 index-info::
 	The content of the file specified with this option will be included
 	verbatim below the heading on the repository index page. This setting
 	is deprecated, and will not be supported by cgit-1.0 (use root-desc
 	instead). Default value: none.
 
 local-time::
 	Flag which, if set to "1", makes cgit print commit and tag times in the
 	servers timezone. Default value: "0".
 
 logo::
 	Url which specifies the source of an image which will be used as a logo
 	on all cgit pages. Default value: "/cgit.png".
 
 logo-link::
 	Url loaded when clicking on the cgit logo image. If unspecified the
 	calculated url of the repository index page will be used. Default
 	value: none.
 
 max-commit-count::
 	Specifies the number of entries to list per page in "log" view. Default
 	value: "50".