-rw-r--r-- | cgitrc.5.txt | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 01157a9..c3698a6 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -69,49 +69,54 @@ cache-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 | ||
73 | clone-prefix:: | 73 | clone-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 | ||
79 | commit-filter:: | 79 | commit-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 | ||
85 | css:: | 85 | css:: |
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 | ||
89 | embedded:: | 89 | embedded:: |
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 | ||
94 | enable-commit-graph:: | ||
95 | Flag which, when set to "1", will make cgit print an ASCII-art commit | ||
96 | history graph to the left of the commit messages in the repository | ||
97 | log page. Default value: "0". | ||
98 | |||
94 | enable-filter-overrides:: | 99 | enable-filter-overrides:: |
95 | Flag which, when set to "1", allows all filter settings to be | 100 | Flag which, when set to "1", allows all filter settings to be |
96 | overridden in repository-specific cgitrc files. Default value: none. | 101 | overridden in repository-specific cgitrc files. Default value: none. |
97 | 102 | ||
98 | enable-gitweb-owner:: | 103 | enable-gitweb-owner:: |
99 | If set to "1" and scan-path is enabled, we first check each repository | 104 | If set to "1" and scan-path is enabled, we first check each repository |
100 | for the git config value "gitweb.owner" to determine the owner. | 105 | for the git config value "gitweb.owner" to determine the owner. |
101 | Default value: "1". See also: scan-path. | 106 | Default value: "1". See also: scan-path. |
102 | 107 | ||
103 | enable-index-links:: | 108 | enable-index-links:: |
104 | Flag which, when set to "1", will make cgit generate extra links for | 109 | Flag which, when set to "1", will make cgit generate extra links for |
105 | each repo in the repository index (specifically, to the "summary", | 110 | each repo in the repository index (specifically, to the "summary", |
106 | "commit" and "tree" pages). Default value: "0". | 111 | "commit" and "tree" pages). Default value: "0". |
107 | 112 | ||
108 | enable-log-filecount:: | 113 | enable-log-filecount:: |
109 | Flag which, when set to "1", will make cgit print the number of | 114 | Flag which, when set to "1", will make cgit print the number of |
110 | modified files for each commit on the repository log page. Default | 115 | modified files for each commit on the repository log page. Default |
111 | value: "0". | 116 | value: "0". |
112 | 117 | ||
113 | enable-log-linecount:: | 118 | enable-log-linecount:: |
114 | Flag which, when set to "1", will make cgit print the number of added | 119 | Flag which, when set to "1", will make cgit print the number of added |
115 | and removed lines for each commit on the repository log page. Default | 120 | and removed lines for each commit on the repository log page. Default |
116 | value: "0". | 121 | value: "0". |
117 | 122 | ||
@@ -248,48 +253,56 @@ renamelimit:: | |||
248 | "-1" uses the compiletime value in git (for further info, look at | 253 | "-1" uses the compiletime value in git (for further info, look at |
249 | `man git-diff`). Default value: "-1". | 254 | `man git-diff`). Default value: "-1". |
250 | 255 | ||
251 | repo.group:: | 256 | repo.group:: |
252 | Legacy alias for "section". This option is deprecated and will not be | 257 | Legacy alias for "section". This option is deprecated and will not be |
253 | supported in cgit-1.0. | 258 | supported in cgit-1.0. |
254 | 259 | ||
255 | robots:: | 260 | robots:: |
256 | Text used as content for the "robots" meta-tag. Default value: | 261 | Text used as content for the "robots" meta-tag. Default value: |
257 | "index, nofollow". | 262 | "index, nofollow". |
258 | 263 | ||
259 | root-desc:: | 264 | root-desc:: |
260 | Text printed below the heading on the repository index page. Default | 265 | Text printed below the heading on the repository index page. Default |
261 | value: "a fast webinterface for the git dscm". | 266 | value: "a fast webinterface for the git dscm". |
262 | 267 | ||
263 | root-readme:: | 268 | root-readme:: |
264 | The content of the file specified with this option will be included | 269 | The content of the file specified with this option will be included |
265 | verbatim below the "about" link on the repository index page. Default | 270 | verbatim below the "about" link on the repository index page. Default |
266 | value: none. | 271 | value: none. |
267 | 272 | ||
268 | root-title:: | 273 | root-title:: |
269 | Text printed as heading on the repository index page. Default value: | 274 | Text printed as heading on the repository index page. Default value: |
270 | "Git Repository Browser". | 275 | "Git Repository Browser". |
271 | 276 | ||
277 | scan-hidden-path:: | ||
278 | If set to "1" and scan-path is enabled, scan-path will recurse into | ||
279 | directories whose name starts with a period ('.'). Otherwise, | ||
280 | scan-path will stay away from such directories (considered as | ||
281 | "hidden"). Note that this does not apply to the ".git" directory in | ||
282 | non-bare repos. This must be defined prior to scan-path. | ||
283 | Default value: 0. See also: scan-path. | ||
284 | |||
272 | scan-path:: | 285 | scan-path:: |
273 | A path which will be scanned for repositories. If caching is enabled, | 286 | A path which will be scanned for repositories. If caching is enabled, |
274 | the result will be cached as a cgitrc include-file in the cache | 287 | the result will be cached as a cgitrc include-file in the cache |
275 | directory. If project-list has been defined prior to scan-path, | 288 | directory. If project-list has been defined prior to scan-path, |
276 | scan-path loads only the directories listed in the file pointed to by | 289 | scan-path loads only the directories listed in the file pointed to by |
277 | project-list. Default value: none. See also: cache-scanrc-ttl, | 290 | project-list. Default value: none. See also: cache-scanrc-ttl, |
278 | project-list. | 291 | project-list. |
279 | 292 | ||
280 | section:: | 293 | section:: |
281 | The name of the current repository section - all repositories defined | 294 | The name of the current repository section - all repositories defined |
282 | after this option will inherit the current section name. Default value: | 295 | after this option will inherit the current section name. Default value: |
283 | none. | 296 | none. |
284 | 297 | ||
285 | section-from-path:: | 298 | section-from-path:: |
286 | A number which, if specified before scan-path, specifies how many | 299 | A number which, if specified before scan-path, specifies how many |
287 | path elements from each repo path to use as a default section name. | 300 | path elements from each repo path to use as a default section name. |
288 | If negative, cgit will discard the specified number of path elements | 301 | If negative, cgit will discard the specified number of path elements |
289 | above the repo directory. Default value: 0. | 302 | above the repo directory. Default value: 0. |
290 | 303 | ||
291 | side-by-side-diffs:: | 304 | side-by-side-diffs:: |
292 | If set to "1" shows side-by-side diffs instead of unidiffs per | 305 | If set to "1" shows side-by-side diffs instead of unidiffs per |
293 | default. Default value: "0". | 306 | default. Default value: "0". |
294 | 307 | ||
295 | snapshots:: | 308 | snapshots:: |
@@ -333,48 +346,52 @@ virtual-root:: | |||
333 | same kind of virtual urls, so this option will probably be deprecated. | 346 | same kind of virtual urls, so this option will probably be deprecated. |
334 | 347 | ||
335 | REPOSITORY SETTINGS | 348 | REPOSITORY SETTINGS |
336 | ------------------- | 349 | ------------------- |
337 | repo.about-filter:: | 350 | repo.about-filter:: |
338 | Override the default about-filter. Default value: none. See also: | 351 | Override the default about-filter. Default value: none. See also: |
339 | "enable-filter-overrides". | 352 | "enable-filter-overrides". |
340 | 353 | ||
341 | repo.clone-url:: | 354 | repo.clone-url:: |
342 | A list of space-separated urls which can be used to clone this repo. | 355 | A list of space-separated urls which can be used to clone this repo. |
343 | Default value: none. | 356 | Default value: none. |
344 | 357 | ||
345 | repo.commit-filter:: | 358 | repo.commit-filter:: |
346 | Override the default commit-filter. Default value: none. See also: | 359 | Override the default commit-filter. Default value: none. See also: |
347 | "enable-filter-overrides". | 360 | "enable-filter-overrides". |
348 | 361 | ||
349 | repo.defbranch:: | 362 | repo.defbranch:: |
350 | The name of the default branch for this repository. If no such branch | 363 | The name of the default branch for this repository. If no such branch |
351 | exists in the repository, the first branch name (when sorted) is used | 364 | exists in the repository, the first branch name (when sorted) is used |
352 | as default instead. Default value: "master". | 365 | as default instead. Default value: "master". |
353 | 366 | ||
354 | repo.desc:: | 367 | repo.desc:: |
355 | The value to show as repository description. Default value: none. | 368 | The value to show as repository description. Default value: none. |
356 | 369 | ||
370 | repo.enable-commit-graph:: | ||
371 | A flag which can be used to disable the global setting | ||
372 | `enable-commit-graph'. Default value: none. | ||
373 | |||
357 | repo.enable-log-filecount:: | 374 | repo.enable-log-filecount:: |
358 | A flag which can be used to disable the global setting | 375 | A flag which can be used to disable the global setting |
359 | `enable-log-filecount'. Default value: none. | 376 | `enable-log-filecount'. Default value: none. |
360 | 377 | ||
361 | repo.enable-log-linecount:: | 378 | repo.enable-log-linecount:: |
362 | A flag which can be used to disable the global setting | 379 | A flag which can be used to disable the global setting |
363 | `enable-log-linecount'. Default value: none. | 380 | `enable-log-linecount'. Default value: none. |
364 | 381 | ||
365 | repo.enable-remote-branches:: | 382 | repo.enable-remote-branches:: |
366 | Flag which, when set to "1", will make cgit display remote branches | 383 | Flag which, when set to "1", will make cgit display remote branches |
367 | in the summary and refs views. Default value: <enable-remote-branches>. | 384 | in the summary and refs views. Default value: <enable-remote-branches>. |
368 | 385 | ||
369 | repo.enable-subject-links:: | 386 | repo.enable-subject-links:: |
370 | A flag which can be used to override the global setting | 387 | A flag which can be used to override the global setting |
371 | `enable-subject-links'. Default value: none. | 388 | `enable-subject-links'. Default value: none. |
372 | 389 | ||
373 | repo.logo:: | 390 | repo.logo:: |
374 | Url which specifies the source of an image which will be used as a logo | 391 | Url which specifies the source of an image which will be used as a logo |
375 | on this repo's pages. Default value: global logo. | 392 | on this repo's pages. Default value: global logo. |
376 | 393 | ||
377 | repo.logo-link:: | 394 | repo.logo-link:: |
378 | Url loaded when clicking on the cgit logo image. If unspecified the | 395 | Url loaded when clicking on the cgit logo image. If unspecified the |
379 | calculated url of the repository index page will be used. Default | 396 | calculated url of the repository index page will be used. Default |
380 | value: global logo-link. | 397 | value: global logo-link. |
@@ -429,48 +446,52 @@ options are only acknowledged in repo-specific config files when | |||
429 | 446 | ||
430 | Note: the "repo." prefix is dropped from the option names in repo-specific | 447 | Note: the "repo." prefix is dropped from the option names in repo-specific |
431 | config files, e.g. "repo.desc" becomes "desc". | 448 | config files, e.g. "repo.desc" becomes "desc". |
432 | 449 | ||
433 | 450 | ||
434 | EXAMPLE CGITRC FILE | 451 | EXAMPLE CGITRC FILE |
435 | ------------------- | 452 | ------------------- |
436 | 453 | ||
437 | .... | 454 | .... |
438 | # Enable caching of up to 1000 output entriess | 455 | # Enable caching of up to 1000 output entriess |
439 | cache-size=1000 | 456 | cache-size=1000 |
440 | 457 | ||
441 | 458 | ||
442 | # Specify some default clone prefixes | 459 | # Specify some default clone prefixes |
443 | clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git | 460 | clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git |
444 | 461 | ||
445 | # Specify the css url | 462 | # Specify the css url |
446 | css=/css/cgit.css | 463 | css=/css/cgit.css |
447 | 464 | ||
448 | 465 | ||
449 | # Show extra links for each repository on the index page | 466 | # Show extra links for each repository on the index page |
450 | enable-index-links=1 | 467 | enable-index-links=1 |
451 | 468 | ||
452 | 469 | ||
470 | # Enable ASCII art commit history graph on the log pages | ||
471 | enable-commit-graph=1 | ||
472 | |||
473 | |||
453 | # Show number of affected files per commit on the log pages | 474 | # Show number of affected files per commit on the log pages |
454 | enable-log-filecount=1 | 475 | enable-log-filecount=1 |
455 | 476 | ||
456 | 477 | ||
457 | # Show number of added/removed lines per commit on the log pages | 478 | # Show number of added/removed lines per commit on the log pages |
458 | enable-log-linecount=1 | 479 | enable-log-linecount=1 |
459 | 480 | ||
460 | 481 | ||
461 | # Add a cgit favicon | 482 | # Add a cgit favicon |
462 | favicon=/favicon.ico | 483 | favicon=/favicon.ico |
463 | 484 | ||
464 | 485 | ||
465 | # Use a custom logo | 486 | # Use a custom logo |
466 | logo=/img/mylogo.png | 487 | logo=/img/mylogo.png |
467 | 488 | ||
468 | 489 | ||
469 | # Enable statistics per week, month and quarter | 490 | # Enable statistics per week, month and quarter |
470 | max-stats=quarter | 491 | max-stats=quarter |
471 | 492 | ||
472 | 493 | ||
473 | # Set the title and heading of the repository index page | 494 | # Set the title and heading of the repository index page |
474 | root-title=example.com git repositories | 495 | root-title=example.com git repositories |
475 | 496 | ||
476 | 497 | ||