summaryrefslogtreecommitdiffabout
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 4dc383d..e7f1a78 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,128 +1,131 @@
1:man source: cgit
2:man manual: cgit
3
1CGITRC(5) 4CGITRC(5)
2======== 5========
3 6
4 7
5NAME 8NAME
6---- 9----
7cgitrc - runtime configuration for cgit 10cgitrc - runtime configuration for cgit
8 11
9 12
10SYNOPSIS 13SYNOPSIS
11-------- 14--------
12Cgitrc contains all runtime settings for cgit, including the list of git 15Cgitrc contains all runtime settings for cgit, including the list of git
13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank 16repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
14lines, and lines starting with '#', are ignored. 17lines, and lines starting with '#', are ignored.
15 18
16 19
17LOCATION 20LOCATION
18-------- 21--------
19The default location of cgitrc, defined at compile time, is /etc/cgitrc. At 22The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
20runtime, cgit will consult the environment variable CGIT_CONFIG and, if 23runtime, cgit will consult the environment variable CGIT_CONFIG and, if
21defined, use its value instead. 24defined, use its value instead.
22 25
23 26
24GLOBAL SETTINGS 27GLOBAL SETTINGS
25--------------- 28---------------
26about-filter:: 29about-filter::
27 Specifies a command which will be invoked to format the content of 30 Specifies a command which will be invoked to format the content of
28 about pages (both top-level and for each repository). The command will 31 about pages (both top-level and for each repository). The command will
29 get the content of the about-file on its STDIN, and the STDOUT from the 32 get the content of the about-file on its STDIN, and the STDOUT from the
30 command will be included verbatim on the about page. Default value: 33 command will be included verbatim on the about page. Default value:
31 none. 34 none.
32 35
33agefile:: 36agefile::
34 Specifies a path, relative to each repository path, which can be used 37 Specifies a path, relative to each repository path, which can be used
35 to specify the date and time of the youngest commit in the repository. 38 to specify the date and time of the youngest commit in the repository.
36 The first line in the file is used as input to the "parse_date" 39 The first line in the file is used as input to the "parse_date"
37 function in libgit. Recommended timestamp-format is "yyyy-mm-dd 40 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
38 hh:mm:ss". Default value: "info/web/last-modified". 41 hh:mm:ss". Default value: "info/web/last-modified".
39 42
40cache-root:: 43cache-root::
41 Path used to store the cgit cache entries. Default value: 44 Path used to store the cgit cache entries. Default value:
42 "/var/cache/cgit". 45 "/var/cache/cgit".
43 46
44cache-dynamic-ttl:: 47cache-dynamic-ttl::
45 Number which specifies the time-to-live, in minutes, for the cached 48 Number which specifies the time-to-live, in minutes, for the cached
46 version of repository pages accessed without a fixed SHA1. Default 49 version of repository pages accessed without a fixed SHA1. Default
47 value: "5". 50 value: "5".
48 51
49cache-repo-ttl:: 52cache-repo-ttl::
50 Number which specifies the time-to-live, in minutes, for the cached 53 Number which specifies the time-to-live, in minutes, for the cached
51 version of the repository summary page. Default value: "5". 54 version of the repository summary page. Default value: "5".
52 55
53cache-root-ttl:: 56cache-root-ttl::
54 Number which specifies the time-to-live, in minutes, for the cached 57 Number which specifies the time-to-live, in minutes, for the cached
55 version of the repository index page. Default value: "5". 58 version of the repository index page. Default value: "5".
56 59
57cache-scanrc-ttl:: 60cache-scanrc-ttl::
58 Number which specifies the time-to-live, in minutes, for the result 61 Number which specifies the time-to-live, in minutes, for the result
59 of scanning a path for git repositories. Default value: "15". 62 of scanning a path for git repositories. Default value: "15".
60 63
61cache-size:: 64cache-size::
62 The maximum number of entries in the cgit cache. Default value: "0" 65 The maximum number of entries in the cgit cache. Default value: "0"
63 (i.e. caching is disabled). 66 (i.e. caching is disabled).
64 67
65cache-static-ttl:: 68cache-static-ttl::
66 Number which specifies the time-to-live, in minutes, for the cached 69 Number which specifies the time-to-live, in minutes, for the cached
67 version of repository pages accessed with a fixed SHA1. Default value: 70 version of repository pages accessed with a fixed SHA1. Default value:
68 "5". 71 "5".
69 72
70clone-prefix:: 73clone-prefix::
71 Space-separated list of common prefixes which, when combined with a 74 Space-separated list of common prefixes which, when combined with a
72 repository url, generates valid clone urls for the repository. This 75 repository url, generates valid clone urls for the repository. This
73 setting is only used if `repo.clone-url` is unspecified. Default value: 76 setting is only used if `repo.clone-url` is unspecified. Default value:
74 none. 77 none.
75 78
76commit-filter:: 79commit-filter::
77 Specifies a command which will be invoked to format commit messages. 80 Specifies a command which will be invoked to format commit messages.
78 The command will get the message on its STDIN, and the STDOUT from the 81 The command will get the message on its STDIN, and the STDOUT from the
79 command will be included verbatim as the commit message, i.e. this can 82 command will be included verbatim as the commit message, i.e. this can
80 be used to implement bugtracker integration. Default value: none. 83 be used to implement bugtracker integration. Default value: none.
81 84
82css:: 85css::
83 Url which specifies the css document to include in all cgit pages. 86 Url which specifies the css document to include in all cgit pages.
84 Default value: "/cgit.css". 87 Default value: "/cgit.css".
85 88
86embedded:: 89embedded::
87 Flag which, when set to "1", will make cgit generate a html fragment 90 Flag which, when set to "1", will make cgit generate a html fragment
88 suitable for embedding in other html pages. Default value: none. See 91 suitable for embedding in other html pages. Default value: none. See
89 also: "noheader". 92 also: "noheader".
90 93
91enable-filter-overrides:: 94enable-filter-overrides::
92 Flag which, when set to "1", allows all filter settings to be 95 Flag which, when set to "1", allows all filter settings to be
93 overridden in repository-specific cgitrc files. Default value: none. 96 overridden in repository-specific cgitrc files. Default value: none.
94 97
95enable-index-links:: 98enable-index-links::
96 Flag which, when set to "1", will make cgit generate extra links for 99 Flag which, when set to "1", will make cgit generate extra links for
97 each repo in the repository index (specifically, to the "summary", 100 each repo in the repository index (specifically, to the "summary",
98 "commit" and "tree" pages). Default value: "0". 101 "commit" and "tree" pages). Default value: "0".
99 102
100enable-log-filecount:: 103enable-log-filecount::
101 Flag which, when set to "1", will make cgit print the number of 104 Flag which, when set to "1", will make cgit print the number of
102 modified files for each commit on the repository log page. Default 105 modified files for each commit on the repository log page. Default
103 value: "0". 106 value: "0".
104 107
105enable-log-linecount:: 108enable-log-linecount::
106 Flag which, when set to "1", will make cgit print the number of added 109 Flag which, when set to "1", will make cgit print the number of added
107 and removed lines for each commit on the repository log page. Default 110 and removed lines for each commit on the repository log page. Default
108 value: "0". 111 value: "0".
109 112
110enable-tree-linenumbers:: 113enable-tree-linenumbers::
111 Flag which, when set to "1", will make cgit generate linenumber links 114 Flag which, when set to "1", will make cgit generate linenumber links
112 for plaintext blobs printed in the tree view. Default value: "1". 115 for plaintext blobs printed in the tree view. Default value: "1".
113 116
114favicon:: 117favicon::
115 Url used as link to a shortcut icon for cgit. If specified, it is 118 Url used as link to a shortcut icon for cgit. If specified, it is
116 suggested to use the value "/favicon.ico" since certain browsers will 119 suggested to use the value "/favicon.ico" since certain browsers will
117 ignore other values. Default value: none. 120 ignore other values. Default value: none.
118 121
119footer:: 122footer::
120 The content of the file specified with this option will be included 123 The content of the file specified with this option will be included
121 verbatim at the bottom of all pages (i.e. it replaces the standard 124 verbatim at the bottom of all pages (i.e. it replaces the standard
122 "generated by..." message. Default value: none. 125 "generated by..." message. Default value: none.
123 126
124head-include:: 127head-include::
125 The content of the file specified with this option will be included 128 The content of the file specified with this option will be included
126 verbatim in the html HEAD section on all pages. Default value: none. 129 verbatim in the html HEAD section on all pages. Default value: none.
127 130
128header:: 131header::