aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt48
1 files changed, 43 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 3b16db9..4dc383d 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -54,6 +54,10 @@ cache-root-ttl::
54 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
55 version of the repository index page. Default value: "5". 55 version of the repository index page. Default value: "5".
56 56
57cache-scanrc-ttl::
58 Number which specifies the time-to-live, in minutes, for the result
59 of scanning a path for git repositories. Default value: "15".
60
57cache-size:: 61cache-size::
58 The maximum number of entries in the cgit cache. Default value: "0" 62 The maximum number of entries in the cgit cache. Default value: "0"
59 (i.e. caching is disabled). 63 (i.e. caching is disabled).
@@ -84,6 +88,10 @@ embedded::
84 suitable for embedding in other html pages. Default value: none. See 88 suitable for embedding in other html pages. Default value: none. See
85 also: "noheader". 89 also: "noheader".
86 90
91enable-filter-overrides::
92 Flag which, when set to "1", allows all filter settings to be
93 overridden in repository-specific cgitrc files. Default value: none.
94
87enable-index-links:: 95enable-index-links::
88 Flag which, when set to "1", will make cgit generate extra links for 96 Flag which, when set to "1", will make cgit generate extra links for
89 each repo in the repository index (specifically, to the "summary", 97 each repo in the repository index (specifically, to the "summary",
@@ -200,8 +208,8 @@ renamelimit::
200 `man git-diff`). Default value: "-1". 208 `man git-diff`). Default value: "-1".
201 209
202repo.group:: 210repo.group::
203 A value for the current repository group, which all repositories 211 Legacy alias for "section". This option is deprecated and will not be
204 specified after this setting will inherit. Default value: none. 212 supported in cgit-1.0.
205 213
206robots:: 214robots::
207 Text used as content for the "robots" meta-tag. Default value: 215 Text used as content for the "robots" meta-tag. Default value:
@@ -220,6 +228,16 @@ root-title::
220 Text printed as heading on the repository index page. Default value: 228 Text printed as heading on the repository index page. Default value:
221 "Git Repository Browser". 229 "Git Repository Browser".
222 230
231scan-path::
232 A path which will be scanned for repositories. If caching is enabled,
233 the result will be cached as a cgitrc include-file in the cache
234 directory. Default value: none. See also: cache-scanrc-ttl.
235
236section::
237 The name of the current repository section - all repositories defined
238 after this option will inherit the current section name. Default value:
239 none.
240
223snapshots:: 241snapshots::
224 Text which specifies the default set of snapshot formats generated by 242 Text which specifies the default set of snapshot formats generated by
225 cgit. The value is a space-separated list of zero or more of the 243 cgit. The value is a space-separated list of zero or more of the
@@ -256,14 +274,16 @@ virtual-root::
256REPOSITORY SETTINGS 274REPOSITORY SETTINGS
257------------------- 275-------------------
258repo.about-filter:: 276repo.about-filter::
259 Override the default about-filter. Default value: <about-filter>. 277 Override the default about-filter. Default value: none. See also:
278 "enable-filter-overrides".
260 279
261repo.clone-url:: 280repo.clone-url::
262 A list of space-separated urls which can be used to clone this repo. 281 A list of space-separated urls which can be used to clone this repo.
263 Default value: none. 282 Default value: none.
264 283
265repo.commit-filter:: 284repo.commit-filter::
266 Override the default commit-filter. Default value: <commit-filter>. 285 Override the default commit-filter. Default value: none. See also:
286 "enable-filter-overrides".
267 287
268repo.defbranch:: 288repo.defbranch::
269 The name of the default branch for this repository. If no such branch 289 The name of the default branch for this repository. If no such branch
@@ -305,14 +325,32 @@ repo.snapshots::
305 A mask of allowed snapshot-formats for this repo, restricted by the 325 A mask of allowed snapshot-formats for this repo, restricted by the
306 "snapshots" global setting. Default value: <snapshots>. 326 "snapshots" global setting. Default value: <snapshots>.
307 327
328repo.section::
329 Override the current section name for this repository. Default value:
330 none.
331
308repo.source-filter:: 332repo.source-filter::
309 Override the default source-filter. Default value: <source-filter>. 333 Override the default source-filter. Default value: none. See also:
334 "enable-filter-overrides".
310 335
311repo.url:: 336repo.url::
312 The relative url used to access the repository. This must be the first 337 The relative url used to access the repository. This must be the first
313 setting specified for each repo. Default value: none. 338 setting specified for each repo. Default value: none.
314 339
315 340
341REPOSITORY-SPECIFIC CGITRC FILE
342-------------------------------
343When the option "scan-path" is used to auto-discover git repositories, cgit
344will try to parse the file "cgitrc" within any found repository. Such a
345repo-specific config file may contain any of the repo-specific options
346described above, except "repo.url" and "repo.path". Additionally, the "filter"
347options are only acknowledged in repo-specific config files when
348"enable-filter-overrides" is set to "1".
349
350Note: the "repo." prefix is dropped from the option names in repo-specific
351config files, e.g. "repo.desc" becomes "desc".
352
353
316EXAMPLE CGITRC FILE 354EXAMPLE CGITRC FILE
317------------------- 355-------------------
318 356