summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index dc63637..4d656fe 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -7,24 +7,31 @@ NAME
7cgitrc - runtime configuration for cgit 7cgitrc - runtime configuration for cgit
8 8
9 9
10SYNOPSIS 10SYNOPSIS
11-------- 11--------
12Cgitrc contains all runtime settings for cgit, including the list of git 12Cgitrc contains all runtime settings for cgit, including the list of git
13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank 13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
14lines, and lines starting with '#', are ignored. 14lines, and lines starting with '#', are ignored.
15 15
16 16
17GLOBAL SETTINGS 17GLOBAL SETTINGS
18--------------- 18---------------
19about-filter::
20 Specifies a command which will be invoked to format the content of
21 about pages (both top-level and for each repository). The command will
22 get the content of the about-file on its STDIN, and the STDOUT from the
23 command will be included verbatim on the about page. Default value:
24 none.
25
19agefile:: 26agefile::
20 Specifies a path, relative to each repository path, which can be used 27 Specifies a path, relative to each repository path, which can be used
21 to specify the date and time of the youngest commit in the repository. 28 to specify the date and time of the youngest commit in the repository.
22 The first line in the file is used as input to the "parse_date" 29 The first line in the file is used as input to the "parse_date"
23 function in libgit. Recommended timestamp-format is "yyyy-mm-dd 30 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
24 hh:mm:ss". Default value: "info/web/last-modified". 31 hh:mm:ss". Default value: "info/web/last-modified".
25 32
26cache-root:: 33cache-root::
27 Path used to store the cgit cache entries. Default value: 34 Path used to store the cgit cache entries. Default value:
28 "/var/cache/cgit". 35 "/var/cache/cgit".
29 36
30cache-dynamic-ttl:: 37cache-dynamic-ttl::
@@ -233,24 +240,27 @@ summary-tags::
233 view. Default value: "10". 240 view. Default value: "10".
234 241
235virtual-root:: 242virtual-root::
236 Url which, if specified, will be used as root for all cgit links. It 243 Url which, if specified, will be used as root for all cgit links. It
237 will also cause cgit to generate 'virtual urls', i.e. urls like 244 will also cause cgit to generate 'virtual urls', i.e. urls like
238 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 245 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
239 value: none. 246 value: none.
240 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 247 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
241 same kind of virtual urls, so this option will probably be deprecated. 248 same kind of virtual urls, so this option will probably be deprecated.
242 249
243REPOSITORY SETTINGS 250REPOSITORY SETTINGS
244------------------- 251-------------------
252repo.about-filter::
253 Override the default about-filter. Default value: <about-filter>.
254
245repo.clone-url:: 255repo.clone-url::
246 A list of space-separated urls which can be used to clone this repo. 256 A list of space-separated urls which can be used to clone this repo.
247 Default value: none. 257 Default value: none.
248 258
249repo.commit-filter:: 259repo.commit-filter::
250 Override the default commit-filter. Default value: <commit-filter>. 260 Override the default commit-filter. Default value: <commit-filter>.
251 261
252repo.defbranch:: 262repo.defbranch::
253 The name of the default branch for this repository. If no such branch 263 The name of the default branch for this repository. If no such branch
254 exists in the repository, the first branch name (when sorted) is used 264 exists in the repository, the first branch name (when sorted) is used
255 as default instead. Default value: "master". 265 as default instead. Default value: "master".
256 266