-rw-r--r-- | cgitrc.5.txt | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 46df291..617b7c3 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -67,48 +67,52 @@ cache-static-ttl:: | |||
67 | version of repository pages accessed with a fixed SHA1. Default value: | 67 | version of repository pages accessed with a fixed SHA1. Default value: |
68 | "5". | 68 | "5". |
69 | 69 | ||
70 | clone-prefix:: | 70 | clone-prefix:: |
71 | Space-separated list of common prefixes which, when combined with a | 71 | Space-separated list of common prefixes which, when combined with a |
72 | repository url, generates valid clone urls for the repository. This | 72 | repository url, generates valid clone urls for the repository. This |
73 | setting is only used if `repo.clone-url` is unspecified. Default value: | 73 | setting is only used if `repo.clone-url` is unspecified. Default value: |
74 | none. | 74 | none. |
75 | 75 | ||
76 | commit-filter:: | 76 | commit-filter:: |
77 | Specifies a command which will be invoked to format commit messages. | 77 | 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 | 78 | 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 | 79 | command will be included verbatim as the commit message, i.e. this can |
80 | be used to implement bugtracker integration. Default value: none. | 80 | be used to implement bugtracker integration. Default value: none. |
81 | 81 | ||
82 | css:: | 82 | css:: |
83 | Url which specifies the css document to include in all cgit pages. | 83 | Url which specifies the css document to include in all cgit pages. |
84 | Default value: "/cgit.css". | 84 | Default value: "/cgit.css". |
85 | 85 | ||
86 | embedded:: | 86 | embedded:: |
87 | Flag which, when set to "1", will make cgit generate a html fragment | 87 | 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 | 88 | suitable for embedding in other html pages. Default value: none. See |
89 | also: "noheader". | 89 | also: "noheader". |
90 | 90 | ||
91 | enable-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 | |||
91 | enable-index-links:: | 95 | enable-index-links:: |
92 | 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 |
93 | each repo in the repository index (specifically, to the "summary", | 97 | each repo in the repository index (specifically, to the "summary", |
94 | "commit" and "tree" pages). Default value: "0". | 98 | "commit" and "tree" pages). Default value: "0". |
95 | 99 | ||
96 | enable-log-filecount:: | 100 | enable-log-filecount:: |
97 | Flag which, when set to "1", will make cgit print the number of | 101 | Flag which, when set to "1", will make cgit print the number of |
98 | modified files for each commit on the repository log page. Default | 102 | modified files for each commit on the repository log page. Default |
99 | value: "0". | 103 | value: "0". |
100 | 104 | ||
101 | enable-log-linecount:: | 105 | enable-log-linecount:: |
102 | Flag which, when set to "1", will make cgit print the number of added | 106 | Flag which, when set to "1", will make cgit print the number of added |
103 | and removed lines for each commit on the repository log page. Default | 107 | and removed lines for each commit on the repository log page. Default |
104 | value: "0". | 108 | value: "0". |
105 | 109 | ||
106 | favicon:: | 110 | favicon:: |
107 | Url used as link to a shortcut icon for cgit. If specified, it is | 111 | Url used as link to a shortcut icon for cgit. If specified, it is |
108 | suggested to use the value "/favicon.ico" since certain browsers will | 112 | suggested to use the value "/favicon.ico" since certain browsers will |
109 | ignore other values. Default value: none. | 113 | ignore other values. Default value: none. |
110 | 114 | ||
111 | footer:: | 115 | footer:: |
112 | The content of the file specified with this option will be included | 116 | The content of the file specified with this option will be included |
113 | verbatim at the bottom of all pages (i.e. it replaces the standard | 117 | verbatim at the bottom of all pages (i.e. it replaces the standard |
114 | "generated by..." message. Default value: none. | 118 | "generated by..." message. Default value: none. |
@@ -245,116 +249,123 @@ source-filter:: | |||
245 | 249 | ||
246 | summary-branches:: | 250 | summary-branches:: |
247 | Specifies the number of branches to display in the repository "summary" | 251 | Specifies the number of branches to display in the repository "summary" |
248 | view. Default value: "10". | 252 | view. Default value: "10". |
249 | 253 | ||
250 | summary-log:: | 254 | summary-log:: |
251 | Specifies the number of log entries to display in the repository | 255 | Specifies the number of log entries to display in the repository |
252 | "summary" view. Default value: "10". | 256 | "summary" view. Default value: "10". |
253 | 257 | ||
254 | summary-tags:: | 258 | summary-tags:: |
255 | Specifies the number of tags to display in the repository "summary" | 259 | Specifies the number of tags to display in the repository "summary" |
256 | view. Default value: "10". | 260 | view. Default value: "10". |
257 | 261 | ||
258 | virtual-root:: | 262 | virtual-root:: |
259 | Url which, if specified, will be used as root for all cgit links. It | 263 | Url which, if specified, will be used as root for all cgit links. It |
260 | will also cause cgit to generate 'virtual urls', i.e. urls like | 264 | will also cause cgit to generate 'virtual urls', i.e. urls like |
261 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 265 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
262 | value: none. | 266 | value: none. |
263 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 267 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
264 | same kind of virtual urls, so this option will probably be deprecated. | 268 | same kind of virtual urls, so this option will probably be deprecated. |
265 | 269 | ||
266 | REPOSITORY SETTINGS | 270 | REPOSITORY SETTINGS |
267 | ------------------- | 271 | ------------------- |
268 | repo.about-filter:: | 272 | repo.about-filter:: |
269 | Override the default about-filter. Default value: <about-filter>. | 273 | Override the default about-filter. Default value: none. See also: |
274 | "enable-filter-overrides". | ||
270 | 275 | ||
271 | repo.clone-url:: | 276 | repo.clone-url:: |
272 | A list of space-separated urls which can be used to clone this repo. | 277 | A list of space-separated urls which can be used to clone this repo. |
273 | Default value: none. | 278 | Default value: none. |
274 | 279 | ||
275 | repo.commit-filter:: | 280 | repo.commit-filter:: |
276 | Override the default commit-filter. Default value: <commit-filter>. | 281 | Override the default commit-filter. Default value: none. See also: |
282 | "enable-filter-overrides". | ||
277 | 283 | ||
278 | repo.defbranch:: | 284 | repo.defbranch:: |
279 | The name of the default branch for this repository. If no such branch | 285 | The name of the default branch for this repository. If no such branch |
280 | exists in the repository, the first branch name (when sorted) is used | 286 | exists in the repository, the first branch name (when sorted) is used |
281 | as default instead. Default value: "master". | 287 | as default instead. Default value: "master". |
282 | 288 | ||
283 | repo.desc:: | 289 | repo.desc:: |
284 | The value to show as repository description. Default value: none. | 290 | The value to show as repository description. Default value: none. |
285 | 291 | ||
286 | repo.enable-log-filecount:: | 292 | repo.enable-log-filecount:: |
287 | A flag which can be used to disable the global setting | 293 | A flag which can be used to disable the global setting |
288 | `enable-log-filecount'. Default value: none. | 294 | `enable-log-filecount'. Default value: none. |
289 | 295 | ||
290 | repo.enable-log-linecount:: | 296 | repo.enable-log-linecount:: |
291 | A flag which can be used to disable the global setting | 297 | A flag which can be used to disable the global setting |
292 | `enable-log-linecount'. Default value: none. | 298 | `enable-log-linecount'. Default value: none. |
293 | 299 | ||
294 | repo.max-stats:: | 300 | repo.max-stats:: |
295 | Override the default maximum statistics period. Valid values are equal | 301 | Override the default maximum statistics period. Valid values are equal |
296 | to the values specified for the global "max-stats" setting. Default | 302 | to the values specified for the global "max-stats" setting. Default |
297 | value: none. | 303 | value: none. |
298 | 304 | ||
299 | repo.name:: | 305 | repo.name:: |
300 | The value to show as repository name. Default value: <repo.url>. | 306 | The value to show as repository name. Default value: <repo.url>. |
301 | 307 | ||
302 | repo.owner:: | 308 | repo.owner:: |
303 | A value used to identify the owner of the repository. Default value: | 309 | A value used to identify the owner of the repository. Default value: |
304 | none. | 310 | none. |
305 | 311 | ||
306 | repo.path:: | 312 | repo.path:: |
307 | An absolute path to the repository directory. For non-bare repositories | 313 | An absolute path to the repository directory. For non-bare repositories |
308 | this is the .git-directory. Default value: none. | 314 | this is the .git-directory. Default value: none. |
309 | 315 | ||
310 | repo.readme:: | 316 | repo.readme:: |
311 | A path (relative to <repo.path>) which specifies a file to include | 317 | A path (relative to <repo.path>) which specifies a file to include |
312 | verbatim as the "About" page for this repo. Default value: none. | 318 | verbatim as the "About" page for this repo. Default value: none. |
313 | 319 | ||
314 | repo.snapshots:: | 320 | repo.snapshots:: |
315 | A mask of allowed snapshot-formats for this repo, restricted by the | 321 | A mask of allowed snapshot-formats for this repo, restricted by the |
316 | "snapshots" global setting. Default value: <snapshots>. | 322 | "snapshots" global setting. Default value: <snapshots>. |
317 | 323 | ||
318 | repo.section:: | 324 | repo.section:: |
319 | Override the current section name for this repository. Default value: | 325 | Override the current section name for this repository. Default value: |
320 | none. | 326 | none. |
321 | 327 | ||
322 | repo.source-filter:: | 328 | repo.source-filter:: |
323 | Override the default source-filter. Default value: <source-filter>. | 329 | Override the default source-filter. Default value: none. See also: |
330 | "enable-filter-overrides". | ||
324 | 331 | ||
325 | repo.url:: | 332 | repo.url:: |
326 | The relative url used to access the repository. This must be the first | 333 | The relative url used to access the repository. This must be the first |
327 | setting specified for each repo. Default value: none. | 334 | setting specified for each repo. Default value: none. |
328 | 335 | ||
329 | 336 | ||
330 | REPOSITORY-SPECIFIC CGITRC FILE | 337 | REPOSITORY-SPECIFIC CGITRC FILE |
331 | ------------------------------- | 338 | ------------------------------- |
332 | When the option "scan-path" is used to auto-discover git repositories, cgit | 339 | When the option "scan-path" is used to auto-discover git repositories, cgit |
333 | will try to parse the file "cgitrc" within any found repository. Such a | 340 | will try to parse the file "cgitrc" within any found repository. Such a |
334 | repo-specific config file may contain any of the repo-specific options | 341 | repo-specific config file may contain any of the repo-specific options |
335 | described above, except "repo.url" and "repo.path". Also, in a repo-specific | 342 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
336 | config file, the "repo." prefix is dropped from the config option names. | 343 | options are only acknowledged in repo-specific config files when |
344 | "enable-filter-overrides" is set to "1". | ||
345 | |||
346 | Note: the "repo." prefix is dropped from the option names in repo-specific | ||
347 | config files, e.g. "repo.desc" becomes "desc". | ||
337 | 348 | ||
338 | 349 | ||
339 | EXAMPLE CGITRC FILE | 350 | EXAMPLE CGITRC FILE |
340 | ------------------- | 351 | ------------------- |
341 | 352 | ||
342 | .... | 353 | .... |
343 | # Enable caching of up to 1000 output entriess | 354 | # Enable caching of up to 1000 output entriess |
344 | cache-size=1000 | 355 | cache-size=1000 |
345 | 356 | ||
346 | 357 | ||
347 | # Specify some default clone prefixes | 358 | # Specify some default clone prefixes |
348 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 359 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
349 | 360 | ||
350 | # Specify the css url | 361 | # Specify the css url |
351 | css=/css/cgit.css | 362 | css=/css/cgit.css |
352 | 363 | ||
353 | 364 | ||
354 | # Show extra links for each repository on the index page | 365 | # Show extra links for each repository on the index page |
355 | enable-index-links=1 | 366 | enable-index-links=1 |
356 | 367 | ||
357 | 368 | ||
358 | # Show number of affected files per commit on the log pages | 369 | # Show number of affected files per commit on the log pages |
359 | enable-log-filecount=1 | 370 | enable-log-filecount=1 |
360 | 371 | ||