about summary refs log tree commit diff stats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorLars Hjemli2009-03-15 09:05:49 +0100
committerLars Hjemli2009-03-15 09:05:49 +0100
commit942a4c200168e110ec009c3260dc5f5f050de325 (patch)
tree240031636e0a85d60e51b0059ee285af712a17a3 /cgitrc.5.txt
parentui-tree: escape ascii-text properly in hexdump view (diff)
parentMakefile: add doc-related targets (diff)
downloadcgit-942a4c200168e110ec009c3260dc5f5f050de325.tar.gz
cgit-942a4c200168e110ec009c3260dc5f5f050de325.zip
Merge branch 'asciidoc'
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt114
1 files changed, 58 insertions, 56 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index fd299ae..7879f75 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt
@@ -1,14 +1,14 @@
1CGITRC 1CGITRC(5)
2====== 2========
3 3
4 4
5NAME 5NAME
6---- 6----
7 cgitrc - runtime configuration for cgit 7cgitrc - runtime configuration for cgit
8 8
9 9
10DESCRIPTION 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.
@@ -16,166 +16,166 @@ lines, and lines starting with '#', are ignored.
16 16
17GLOBAL SETTINGS 17GLOBAL SETTINGS
18--------------- 18---------------
19agefile 19agefile::
20 Specifies a path, relative to each repository path, which can be used 20 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. 21 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" 22 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 23 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
24 hh:mm:ss". Default value: "info/web/last-modified". 24 hh:mm:ss". Default value: "info/web/last-modified".
25 25
26cache-root 26cache-root::
27 Path used to store the cgit cache entries. Default value: 27 Path used to store the cgit cache entries. Default value:
28 "/var/cache/cgit". 28 "/var/cache/cgit".
29 29
30cache-dynamic-ttl 30cache-dynamic-ttl::
31 Number which specifies the time-to-live, in minutes, for the cached 31 Number which specifies the time-to-live, in minutes, for the cached
32 version of repository pages accessed without a fixed SHA1. Default 32 version of repository pages accessed without a fixed SHA1. Default
33 value: "5". 33 value: "5".
34 34
35cache-repo-ttl 35cache-repo-ttl::
36 Number which specifies the time-to-live, in minutes, for the cached 36 Number which specifies the time-to-live, in minutes, for the cached
37 version of the repository summary page. Default value: "5". 37 version of the repository summary page. Default value: "5".
38 38
39cache-root-ttl 39cache-root-ttl::
40 Number which specifies the time-to-live, in minutes, for the cached 40 Number which specifies the time-to-live, in minutes, for the cached
41 version of the repository index page. Default value: "5". 41 version of the repository index page. Default value: "5".
42 42
43cache-size 43cache-size::
44 The maximum number of entries in the cgit cache. Default value: "0" 44 The maximum number of entries in the cgit cache. Default value: "0"
45 (i.e. caching is disabled). 45 (i.e. caching is disabled).
46 46
47cache-static-ttl 47cache-static-ttl::
48 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
49 version of repository pages accessed with a fixed SHA1. Default value: 49 version of repository pages accessed with a fixed SHA1. Default value:
50 "5". 50 "5".
51 51
52clone-prefix 52clone-prefix::
53 Space-separated list of common prefixes which, when combined with a 53 Space-separated list of common prefixes which, when combined with a
54 repository url, generates valid clone urls for the repository. This 54 repository url, generates valid clone urls for the repository. This
55 setting is only used if `repo.clone-url` is unspecified. Default value: 55 setting is only used if `repo.clone-url` is unspecified. Default value:
56 none. 56 none.
57 57
58css 58css::
59 Url which specifies the css document to include in all cgit pages. 59 Url which specifies the css document to include in all cgit pages.
60 Default value: "/cgit.css". 60 Default value: "/cgit.css".
61 61
62enable-index-links 62enable-index-links::
63 Flag which, when set to "1", will make cgit generate extra links for 63 Flag which, when set to "1", will make cgit generate extra links for
64 each repo in the repository index (specifically, to the "summary", 64 each repo in the repository index (specifically, to the "summary",
65 "commit" and "tree" pages). Default value: "0". 65 "commit" and "tree" pages). Default value: "0".
66 66
67enable-log-filecount 67enable-log-filecount::
68 Flag which, when set to "1", will make cgit print the number of 68 Flag which, when set to "1", will make cgit print the number of
69 modified files for each commit on the repository log page. Default 69 modified files for each commit on the repository log page. Default
70 value: "0". 70 value: "0".
71 71
72enable-log-linecount 72enable-log-linecount::
73 Flag which, when set to "1", will make cgit print the number of added 73 Flag which, when set to "1", will make cgit print the number of added
74 and removed lines for each commit on the repository log page. Default 74 and removed lines for each commit on the repository log page. Default
75 value: "0". 75 value: "0".
76 76
77favicon 77favicon::
78 Url used as link to a shortcut icon for cgit. If specified, it is 78 Url used as link to a shortcut icon for cgit. If specified, it is
79 suggested to use the value "/favicon.ico" since certain browsers will 79 suggested to use the value "/favicon.ico" since certain browsers will
80 ignore other values. Default value: none. 80 ignore other values. Default value: none.
81 81
82footer 82footer::
83 The content of the file specified with this option will be included 83 The content of the file specified with this option will be included
84 verbatim at the bottom of all pages (i.e. it replaces the standard 84 verbatim at the bottom of all pages (i.e. it replaces the standard
85 "generated by..." message. Default value: none. 85 "generated by..." message. Default value: none.
86 86
87header 87header::
88 The content of the file specified with this option will be included 88 The content of the file specified with this option will be included
89 verbatim at the top of all pages. Default value: none. 89 verbatim at the top of all pages. Default value: none.
90 90
91include 91include::
92 Name of a configfile to include before the rest of the current config- 92 Name of a configfile to include before the rest of the current config-
93 file is parsed. Default value: none. 93 file is parsed. Default value: none.
94 94
95index-header 95index-header::
96 The content of the file specified with this option will be included 96 The content of the file specified with this option will be included
97 verbatim above the repository index. This setting is deprecated, and 97 verbatim above the repository index. This setting is deprecated, and
98 will not be supported by cgit-1.0 (use root-readme instead). Default 98 will not be supported by cgit-1.0 (use root-readme instead). Default
99 value: none. 99 value: none.
100 100
101index-info 101index-info::
102 The content of the file specified with this option will be included 102 The content of the file specified with this option will be included
103 verbatim below the heading on the repository index page. This setting 103 verbatim below the heading on the repository index page. This setting
104 is deprecated, and will not be supported by cgit-1.0 (use root-desc 104 is deprecated, and will not be supported by cgit-1.0 (use root-desc
105 instead). Default value: none. 105 instead). Default value: none.
106 106
107local-time 107local-time::
108 Flag which, if set to "1", makes cgit print commit and tag times in the 108 Flag which, if set to "1", makes cgit print commit and tag times in the
109 servers timezone. Default value: "0". 109 servers timezone. Default value: "0".
110 110
111logo 111logo::
112 Url which specifies the source of an image which will be used as a logo 112 Url which specifies the source of an image which will be used as a logo
113 on all cgit pages. 113 on all cgit pages.
114 114
115logo-link 115logo-link::
116 Url loaded when clicking on the cgit logo image. If unspecified the 116 Url loaded when clicking on the cgit logo image. If unspecified the
117 calculated url of the repository index page will be used. Default 117 calculated url of the repository index page will be used. Default
118 value: none. 118 value: none.
119 119
120max-commit-count 120max-commit-count::
121 Specifies the number of entries to list per page in "log" view. Default 121 Specifies the number of entries to list per page in "log" view. Default
122 value: "50". 122 value: "50".
123 123
124max-message-length 124max-message-length::
125 Specifies the maximum number of commit message characters to display in 125 Specifies the maximum number of commit message characters to display in
126 "log" view. Default value: "80". 126 "log" view. Default value: "80".
127 127
128max-repo-count 128max-repo-count::
129 Specifies the number of entries to list per page on the repository 129 Specifies the number of entries to list per page on the repository
130 index page. Default value: "50". 130 index page. Default value: "50".
131 131
132max-repodesc-length 132max-repodesc-length::
133 Specifies the maximum number of repo description characters to display 133 Specifies the maximum number of repo description characters to display
134 on the repository index page. Default value: "80". 134 on the repository index page. Default value: "80".
135 135
136max-stats 136max-stats::
137 Set the default maximum statistics period. Valid values are "week", 137 Set the default maximum statistics period. Valid values are "week",
138 "month", "quarter" and "year". If unspecified, statistics are 138 "month", "quarter" and "year". If unspecified, statistics are
139 disabled. Default value: none. See also: "repo.max-stats". 139 disabled. Default value: none. See also: "repo.max-stats".
140 140
141module-link 141module-link::
142 Text which will be used as the formatstring for a hyperlink when a 142 Text which will be used as the formatstring for a hyperlink when a
143 submodule is printed in a directory listing. The arguments for the 143 submodule is printed in a directory listing. The arguments for the
144 formatstring are the path and SHA1 of the submodule commit. Default 144 formatstring are the path and SHA1 of the submodule commit. Default
145 value: "./?repo=%s&page=commit&id=%s" 145 value: "./?repo=%s&page=commit&id=%s"
146 146
147nocache 147nocache::
148 If set to the value "1" caching will be disabled. This settings is 148 If set to the value "1" caching will be disabled. This settings is
149 deprecated, and will not be honored starting with cgit-1.0. Default 149 deprecated, and will not be honored starting with cgit-1.0. Default
150 value: "0". 150 value: "0".
151 151
152renamelimit 152renamelimit::
153 Maximum number of files to consider when detecting renames. The value 153 Maximum number of files to consider when detecting renames. The value
154 "-1" uses the compiletime value in git (for further info, look at 154 "-1" uses the compiletime value in git (for further info, look at
155 `man git-diff`). Default value: "-1". 155 `man git-diff`). Default value: "-1".
156 156
157repo.group 157repo.group::
158 A value for the current repository group, which all repositories 158 A value for the current repository group, which all repositories
159 specified after this setting will inherit. Default value: none. 159 specified after this setting will inherit. Default value: none.
160 160
161robots 161robots::
162 Text used as content for the "robots" meta-tag. Default value: 162 Text used as content for the "robots" meta-tag. Default value:
163 "index, nofollow". 163 "index, nofollow".
164 164
165root-desc 165root-desc::
166 Text printed below the heading on the repository index page. Default 166 Text printed below the heading on the repository index page. Default
167 value: "a fast webinterface for the git dscm". 167 value: "a fast webinterface for the git dscm".
168 168
169root-readme: 169root-readme::
170 The content of the file specified with this option will be included 170 The content of the file specified with this option will be included
171 verbatim below the "about" link on the repository index page. Default 171 verbatim below the "about" link on the repository index page. Default
172 value: none. 172 value: none.
173 173
174root-title 174root-title::
175 Text printed as heading on the repository index page. Default value: 175 Text printed as heading on the repository index page. Default value:
176 "Git Repository Browser". 176 "Git Repository Browser".
177 177
178snapshots 178snapshots::
179 Text which specifies the default (and allowed) set of snapshot formats 179 Text which specifies the default (and allowed) set of snapshot formats
180 supported by cgit. The value is a space-separated list of zero or more 180 supported by cgit. The value is a space-separated list of zero or more
181 of the following values: 181 of the following values:
@@ -185,19 +185,19 @@ snapshots
185 "zip" zip-file 185 "zip" zip-file
186 Default value: none. 186 Default value: none.
187 187
188summary-branches 188summary-branches::
189 Specifies the number of branches to display in the repository "summary" 189 Specifies the number of branches to display in the repository "summary"
190 view. Default value: "10". 190 view. Default value: "10".
191 191
192summary-log 192summary-log::
193 Specifies the number of log entries to display in the repository 193 Specifies the number of log entries to display in the repository
194 "summary" view. Default value: "10". 194 "summary" view. Default value: "10".
195 195
196summary-tags 196summary-tags::
197 Specifies the number of tags to display in the repository "summary" 197 Specifies the number of tags to display in the repository "summary"
198 view. Default value: "10". 198 view. Default value: "10".
199 199
200virtual-root 200virtual-root::
201 Url which, if specified, will be used as root for all cgit links. It 201 Url which, if specified, will be used as root for all cgit links. It
202 will also cause cgit to generate 'virtual urls', i.e. urls like 202 will also cause cgit to generate 'virtual urls', i.e. urls like
203 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 203 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
@@ -207,51 +207,51 @@ virtual-root
207 207
208REPOSITORY SETTINGS 208REPOSITORY SETTINGS
209------------------- 209-------------------
210repo.clone-url 210repo.clone-url::
211 A list of space-separated urls which can be used to clone this repo. 211 A list of space-separated urls which can be used to clone this repo.
212 Default value: none. 212 Default value: none.
213 213
214repo.defbranch 214repo.defbranch::
215 The name of the default branch for this repository. If no such branch 215 The name of the default branch for this repository. If no such branch
216 exists in the repository, the first branch name (when sorted) is used 216 exists in the repository, the first branch name (when sorted) is used
217 as default instead. Default value: "master". 217 as default instead. Default value: "master".
218 218
219repo.desc 219repo.desc::
220 The value to show as repository description. Default value: none. 220 The value to show as repository description. Default value: none.
221 221
222repo.enable-log-filecount 222repo.enable-log-filecount::
223 A flag which can be used to disable the global setting 223 A flag which can be used to disable the global setting
224 `enable-log-filecount'. Default value: none. 224 `enable-log-filecount'. Default value: none.
225 225
226repo.enable-log-linecount 226repo.enable-log-linecount::
227 A flag which can be used to disable the global setting 227 A flag which can be used to disable the global setting
228 `enable-log-linecount'. Default value: none. 228 `enable-log-linecount'. Default value: none.
229 229
230repo.max-stats 230repo.max-stats::
231 Override the default maximum statistics period. Valid values are equal 231 Override the default maximum statistics period. Valid values are equal
232 to the values specified for the global "max-stats" setting. Default 232 to the values specified for the global "max-stats" setting. Default
233 value: none. 233 value: none.
234 234
235repo.name 235repo.name::
236 The value to show as repository name. Default value: <repo.url>. 236 The value to show as repository name. Default value: <repo.url>.
237 237
238repo.owner 238repo.owner::
239 A value used to identify the owner of the repository. Default value: 239 A value used to identify the owner of the repository. Default value:
240 none. 240 none.
241 241
242repo.path 242repo.path::
243 An absolute path to the repository directory. For non-bare repositories 243 An absolute path to the repository directory. For non-bare repositories
244 this is the .git-directory. Default value: none. 244 this is the .git-directory. Default value: none.
245 245
246repo.readme 246repo.readme::
247 A path (relative to <repo.path>) which specifies a file to include 247 A path (relative to <repo.path>) which specifies a file to include
248 verbatim as the "About" page for this repo. Default value: none. 248 verbatim as the "About" page for this repo. Default value: none.
249 249
250repo.snapshots 250repo.snapshots::
251 A mask of allowed snapshot-formats for this repo, restricted by the 251 A mask of allowed snapshot-formats for this repo, restricted by the
252 "snapshots" global setting. Default value: <snapshots>. 252 "snapshots" global setting. Default value: <snapshots>.
253 253
254repo.url 254repo.url::
255 The relative url used to access the repository. This must be the first 255 The relative url used to access the repository. This must be the first
256 setting specified for each repo. Default value: none. 256 setting specified for each repo. Default value: none.
257 257
@@ -259,6 +259,7 @@ repo.url
259EXAMPLE CGITRC FILE 259EXAMPLE CGITRC FILE
260------------------- 260-------------------
261 261
262....
262# Enable caching of up to 1000 output entriess 263# Enable caching of up to 1000 output entriess
263cache-size=1000 264cache-size=1000
264 265
@@ -368,6 +369,7 @@ repo.enable-log-linecount=0
368 369
369# Restrict the max statistics period for this repo 370# Restrict the max statistics period for this repo
370repo.max-stats=month 371repo.max-stats=month
372....
371 373
372 374
373BUGS 375BUGS