summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0c13485..0bb429a 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -65,96 +65,101 @@ cache-size::
65 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"
66 (i.e. caching is disabled). 66 (i.e. caching is disabled).
67 67
68cache-static-ttl:: 68cache-static-ttl::
69 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
70 version of repository pages accessed with a fixed SHA1. Default value: 70 version of repository pages accessed with a fixed SHA1. Default value:
71 "5". 71 "5".
72 72
73clone-prefix:: 73clone-prefix::
74 Space-separated list of common prefixes which, when combined with a 74 Space-separated list of common prefixes which, when combined with a
75 repository url, generates valid clone urls for the repository. This 75 repository url, generates valid clone urls for the repository. This
76 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:
77 none. 77 none.
78 78
79commit-filter:: 79commit-filter::
80 Specifies a command which will be invoked to format commit messages. 80 Specifies a command which will be invoked to format commit messages.
81 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
82 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
83 be used to implement bugtracker integration. Default value: none. 83 be used to implement bugtracker integration. Default value: none.
84 84
85css:: 85css::
86 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.
87 Default value: "/cgit.css". 87 Default value: "/cgit.css".
88 88
89embedded:: 89embedded::
90 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
91 suitable for embedding in other html pages. Default value: none. See 91 suitable for embedding in other html pages. Default value: none. See
92 also: "noheader". 92 also: "noheader".
93 93
94enable-filter-overrides:: 94enable-filter-overrides::
95 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
96 overridden in repository-specific cgitrc files. Default value: none. 96 overridden in repository-specific cgitrc files. Default value: none.
97 97
98enable-index-links:: 98enable-index-links::
99 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
100 each repo in the repository index (specifically, to the "summary", 100 each repo in the repository index (specifically, to the "summary",
101 "commit" and "tree" pages). Default value: "0". 101 "commit" and "tree" pages). Default value: "0".
102 102
103enable-log-filecount:: 103enable-log-filecount::
104 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
105 modified files for each commit on the repository log page. Default 105 modified files for each commit on the repository log page. Default
106 value: "0". 106 value: "0".
107 107
108enable-log-linecount:: 108enable-log-linecount::
109 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
110 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
111 value: "0". 111 value: "0".
112 112
113enable-remote-branches::
114 Flag which, when set to "1", will make cgit display remote branches
115 in the summary and refs views. Default value: "0". See also:
116 "repo.enable-remote-branches".
117
113enable-tree-linenumbers:: 118enable-tree-linenumbers::
114 Flag which, when set to "1", will make cgit generate linenumber links 119 Flag which, when set to "1", will make cgit generate linenumber links
115 for plaintext blobs printed in the tree view. Default value: "1". 120 for plaintext blobs printed in the tree view. Default value: "1".
116 121
117favicon:: 122favicon::
118 Url used as link to a shortcut icon for cgit. If specified, it is 123 Url used as link to a shortcut icon for cgit. If specified, it is
119 suggested to use the value "/favicon.ico" since certain browsers will 124 suggested to use the value "/favicon.ico" since certain browsers will
120 ignore other values. Default value: none. 125 ignore other values. Default value: none.
121 126
122footer:: 127footer::
123 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
124 verbatim at the bottom of all pages (i.e. it replaces the standard 129 verbatim at the bottom of all pages (i.e. it replaces the standard
125 "generated by..." message. Default value: none. 130 "generated by..." message. Default value: none.
126 131
127head-include:: 132head-include::
128 The content of the file specified with this option will be included 133 The content of the file specified with this option will be included
129 verbatim in the html HEAD section on all pages. Default value: none. 134 verbatim in the html HEAD section on all pages. Default value: none.
130 135
131header:: 136header::
132 The content of the file specified with this option will be included 137 The content of the file specified with this option will be included
133 verbatim at the top of all pages. Default value: none. 138 verbatim at the top of all pages. Default value: none.
134 139
135include:: 140include::
136 Name of a configfile to include before the rest of the current config- 141 Name of a configfile to include before the rest of the current config-
137 file is parsed. Default value: none. 142 file is parsed. Default value: none.
138 143
139index-header:: 144index-header::
140 The content of the file specified with this option will be included 145 The content of the file specified with this option will be included
141 verbatim above the repository index. This setting is deprecated, and 146 verbatim above the repository index. This setting is deprecated, and
142 will not be supported by cgit-1.0 (use root-readme instead). Default 147 will not be supported by cgit-1.0 (use root-readme instead). Default
143 value: none. 148 value: none.
144 149
145index-info:: 150index-info::
146 The content of the file specified with this option will be included 151 The content of the file specified with this option will be included
147 verbatim below the heading on the repository index page. This setting 152 verbatim below the heading on the repository index page. This setting
148 is deprecated, and will not be supported by cgit-1.0 (use root-desc 153 is deprecated, and will not be supported by cgit-1.0 (use root-desc
149 instead). Default value: none. 154 instead). Default value: none.
150 155
151local-time:: 156local-time::
152 Flag which, if set to "1", makes cgit print commit and tag times in the 157 Flag which, if set to "1", makes cgit print commit and tag times in the
153 servers timezone. Default value: "0". 158 servers timezone. Default value: "0".
154 159
155logo:: 160logo::
156 Url which specifies the source of an image which will be used as a logo 161 Url which specifies the source of an image which will be used as a logo
157 on all cgit pages. Default value: "/cgit.png". 162 on all cgit pages. Default value: "/cgit.png".
158 163
159logo-link:: 164logo-link::
160 Url loaded when clicking on the cgit logo image. If unspecified the 165 Url loaded when clicking on the cgit logo image. If unspecified the
@@ -259,96 +264,100 @@ summary-branches::
259 view. Default value: "10". 264 view. Default value: "10".
260 265
261summary-log:: 266summary-log::
262 Specifies the number of log entries to display in the repository 267 Specifies the number of log entries to display in the repository
263 "summary" view. Default value: "10". 268 "summary" view. Default value: "10".
264 269
265summary-tags:: 270summary-tags::
266 Specifies the number of tags to display in the repository "summary" 271 Specifies the number of tags to display in the repository "summary"
267 view. Default value: "10". 272 view. Default value: "10".
268 273
269virtual-root:: 274virtual-root::
270 Url which, if specified, will be used as root for all cgit links. It 275 Url which, if specified, will be used as root for all cgit links. It
271 will also cause cgit to generate 'virtual urls', i.e. urls like 276 will also cause cgit to generate 'virtual urls', i.e. urls like
272 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 277 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
273 value: none. 278 value: none.
274 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 279 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
275 same kind of virtual urls, so this option will probably be deprecated. 280 same kind of virtual urls, so this option will probably be deprecated.
276 281
277REPOSITORY SETTINGS 282REPOSITORY SETTINGS
278------------------- 283-------------------
279repo.about-filter:: 284repo.about-filter::
280 Override the default about-filter. Default value: none. See also: 285 Override the default about-filter. Default value: none. See also:
281 "enable-filter-overrides". 286 "enable-filter-overrides".
282 287
283repo.clone-url:: 288repo.clone-url::
284 A list of space-separated urls which can be used to clone this repo. 289 A list of space-separated urls which can be used to clone this repo.
285 Default value: none. 290 Default value: none.
286 291
287repo.commit-filter:: 292repo.commit-filter::
288 Override the default commit-filter. Default value: none. See also: 293 Override the default commit-filter. Default value: none. See also:
289 "enable-filter-overrides". 294 "enable-filter-overrides".
290 295
291repo.defbranch:: 296repo.defbranch::
292 The name of the default branch for this repository. If no such branch 297 The name of the default branch for this repository. If no such branch
293 exists in the repository, the first branch name (when sorted) is used 298 exists in the repository, the first branch name (when sorted) is used
294 as default instead. Default value: "master". 299 as default instead. Default value: "master".
295 300
296repo.desc:: 301repo.desc::
297 The value to show as repository description. Default value: none. 302 The value to show as repository description. Default value: none.
298 303
299repo.enable-log-filecount:: 304repo.enable-log-filecount::
300 A flag which can be used to disable the global setting 305 A flag which can be used to disable the global setting
301 `enable-log-filecount'. Default value: none. 306 `enable-log-filecount'. Default value: none.
302 307
303repo.enable-log-linecount:: 308repo.enable-log-linecount::
304 A flag which can be used to disable the global setting 309 A flag which can be used to disable the global setting
305 `enable-log-linecount'. Default value: none. 310 `enable-log-linecount'. Default value: none.
306 311
312repo.enable-remote-branches::
313 Flag which, when set to "1", will make cgit display remote branches
314 in the summary and refs views. Default value: <enable-remote-branches>.
315
307repo.max-stats:: 316repo.max-stats::
308 Override the default maximum statistics period. Valid values are equal 317 Override the default maximum statistics period. Valid values are equal
309 to the values specified for the global "max-stats" setting. Default 318 to the values specified for the global "max-stats" setting. Default
310 value: none. 319 value: none.
311 320
312repo.name:: 321repo.name::
313 The value to show as repository name. Default value: <repo.url>. 322 The value to show as repository name. Default value: <repo.url>.
314 323
315repo.owner:: 324repo.owner::
316 A value used to identify the owner of the repository. Default value: 325 A value used to identify the owner of the repository. Default value:
317 none. 326 none.
318 327
319repo.path:: 328repo.path::
320 An absolute path to the repository directory. For non-bare repositories 329 An absolute path to the repository directory. For non-bare repositories
321 this is the .git-directory. Default value: none. 330 this is the .git-directory. Default value: none.
322 331
323repo.readme:: 332repo.readme::
324 A path (relative to <repo.path>) which specifies a file to include 333 A path (relative to <repo.path>) which specifies a file to include
325 verbatim as the "About" page for this repo. Default value: none. 334 verbatim as the "About" page for this repo. Default value: none.
326 335
327repo.snapshots:: 336repo.snapshots::
328 A mask of allowed snapshot-formats for this repo, restricted by the 337 A mask of allowed snapshot-formats for this repo, restricted by the
329 "snapshots" global setting. Default value: <snapshots>. 338 "snapshots" global setting. Default value: <snapshots>.
330 339
331repo.section:: 340repo.section::
332 Override the current section name for this repository. Default value: 341 Override the current section name for this repository. Default value:
333 none. 342 none.
334 343
335repo.source-filter:: 344repo.source-filter::
336 Override the default source-filter. Default value: none. See also: 345 Override the default source-filter. Default value: none. See also:
337 "enable-filter-overrides". 346 "enable-filter-overrides".
338 347
339repo.url:: 348repo.url::
340 The relative url used to access the repository. This must be the first 349 The relative url used to access the repository. This must be the first
341 setting specified for each repo. Default value: none. 350 setting specified for each repo. Default value: none.
342 351
343 352
344REPOSITORY-SPECIFIC CGITRC FILE 353REPOSITORY-SPECIFIC CGITRC FILE
345------------------------------- 354-------------------------------
346When the option "scan-path" is used to auto-discover git repositories, cgit 355When the option "scan-path" is used to auto-discover git repositories, cgit
347will try to parse the file "cgitrc" within any found repository. Such a 356will try to parse the file "cgitrc" within any found repository. Such a
348repo-specific config file may contain any of the repo-specific options 357repo-specific config file may contain any of the repo-specific options
349described above, except "repo.url" and "repo.path". Additionally, the "filter" 358described above, except "repo.url" and "repo.path". Additionally, the "filter"
350options are only acknowledged in repo-specific config files when 359options are only acknowledged in repo-specific config files when
351"enable-filter-overrides" is set to "1". 360"enable-filter-overrides" is set to "1".
352 361
353Note: the "repo." prefix is dropped from the option names in repo-specific 362Note: the "repo." prefix is dropped from the option names in repo-specific
354config files, e.g. "repo.desc" becomes "desc". 363config files, e.g. "repo.desc" becomes "desc".