summaryrefslogtreecommitdiffabout
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt7
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,80 +1,87 @@
1CGITRC(5) 1CGITRC(5)
2======== 2========
3 3
4 4
5NAME 5NAME
6---- 6----
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
17LOCATION
18--------
19The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
20runtime, cgit will consult the environment variable CGIT_CONFIG and, if
21defined, use its value instead.
22
23
17GLOBAL SETTINGS 24GLOBAL SETTINGS
18--------------- 25---------------
19about-filter:: 26about-filter::
20 Specifies a command which will be invoked to format the content of 27 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 28 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 29 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: 30 command will be included verbatim on the about page. Default value:
24 none. 31 none.
25 32
26agefile:: 33agefile::
27 Specifies a path, relative to each repository path, which can be used 34 Specifies a path, relative to each repository path, which can be used
28 to specify the date and time of the youngest commit in the repository. 35 to specify the date and time of the youngest commit in the repository.
29 The first line in the file is used as input to the "parse_date" 36 The first line in the file is used as input to the "parse_date"
30 function in libgit. Recommended timestamp-format is "yyyy-mm-dd 37 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
31 hh:mm:ss". Default value: "info/web/last-modified". 38 hh:mm:ss". Default value: "info/web/last-modified".
32 39
33cache-root:: 40cache-root::
34 Path used to store the cgit cache entries. Default value: 41 Path used to store the cgit cache entries. Default value:
35 "/var/cache/cgit". 42 "/var/cache/cgit".
36 43
37cache-dynamic-ttl:: 44cache-dynamic-ttl::
38 Number which specifies the time-to-live, in minutes, for the cached 45 Number which specifies the time-to-live, in minutes, for the cached
39 version of repository pages accessed without a fixed SHA1. Default 46 version of repository pages accessed without a fixed SHA1. Default
40 value: "5". 47 value: "5".
41 48
42cache-repo-ttl:: 49cache-repo-ttl::
43 Number which specifies the time-to-live, in minutes, for the cached 50 Number which specifies the time-to-live, in minutes, for the cached
44 version of the repository summary page. Default value: "5". 51 version of the repository summary page. Default value: "5".
45 52
46cache-root-ttl:: 53cache-root-ttl::
47 Number which specifies the time-to-live, in minutes, for the cached 54 Number which specifies the time-to-live, in minutes, for the cached
48 version of the repository index page. Default value: "5". 55 version of the repository index page. Default value: "5".
49 56
50cache-size:: 57cache-size::
51 The maximum number of entries in the cgit cache. Default value: "0" 58 The maximum number of entries in the cgit cache. Default value: "0"
52 (i.e. caching is disabled). 59 (i.e. caching is disabled).
53 60
54cache-static-ttl:: 61cache-static-ttl::
55 Number which specifies the time-to-live, in minutes, for the cached 62 Number which specifies the time-to-live, in minutes, for the cached
56 version of repository pages accessed with a fixed SHA1. Default value: 63 version of repository pages accessed with a fixed SHA1. Default value:
57 "5". 64 "5".
58 65
59clone-prefix:: 66clone-prefix::
60 Space-separated list of common prefixes which, when combined with a 67 Space-separated list of common prefixes which, when combined with a
61 repository url, generates valid clone urls for the repository. This 68 repository url, generates valid clone urls for the repository. This
62 setting is only used if `repo.clone-url` is unspecified. Default value: 69 setting is only used if `repo.clone-url` is unspecified. Default value:
63 none. 70 none.
64 71
65commit-filter:: 72commit-filter::
66 Specifies a command which will be invoked to format commit messages. 73 Specifies a command which will be invoked to format commit messages.
67 The command will get the message on its STDIN, and the STDOUT from the 74 The command will get the message on its STDIN, and the STDOUT from the
68 command will be included verbatim as the commit message, i.e. this can 75 command will be included verbatim as the commit message, i.e. this can
69 be used to implement bugtracker integration. Default value: none. 76 be used to implement bugtracker integration. Default value: none.
70 77
71css:: 78css::
72 Url which specifies the css document to include in all cgit pages. 79 Url which specifies the css document to include in all cgit pages.
73 Default value: "/cgit.css". 80 Default value: "/cgit.css".
74 81
75embedded:: 82embedded::
76 Flag which, when set to "1", will make cgit generate a html fragment 83 Flag which, when set to "1", will make cgit generate a html fragment
77 suitable for embedding in other html pages. Default value: none. See 84 suitable for embedding in other html pages. Default value: none. See
78 also: "noheader". 85 also: "noheader".
79 86
80enable-index-links:: 87enable-index-links::