-rw-r--r-- | cgitrc.5.txt | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 8e51ca5..3c20fe1 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 | ||
@@ -333,48 +338,52 @@ virtual-root:: | |||
333 | same kind of virtual urls, so this option will probably be deprecated. | 338 | same kind of virtual urls, so this option will probably be deprecated. |
334 | 339 | ||
335 | REPOSITORY SETTINGS | 340 | REPOSITORY SETTINGS |
336 | ------------------- | 341 | ------------------- |
337 | repo.about-filter:: | 342 | repo.about-filter:: |
338 | Override the default about-filter. Default value: none. See also: | 343 | Override the default about-filter. Default value: none. See also: |
339 | "enable-filter-overrides". | 344 | "enable-filter-overrides". |
340 | 345 | ||
341 | repo.clone-url:: | 346 | repo.clone-url:: |
342 | A list of space-separated urls which can be used to clone this repo. | 347 | A list of space-separated urls which can be used to clone this repo. |
343 | Default value: none. | 348 | Default value: none. |
344 | 349 | ||
345 | repo.commit-filter:: | 350 | repo.commit-filter:: |
346 | Override the default commit-filter. Default value: none. See also: | 351 | Override the default commit-filter. Default value: none. See also: |
347 | "enable-filter-overrides". | 352 | "enable-filter-overrides". |
348 | 353 | ||
349 | repo.defbranch:: | 354 | repo.defbranch:: |
350 | The name of the default branch for this repository. If no such branch | 355 | 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 | 356 | exists in the repository, the first branch name (when sorted) is used |
352 | as default instead. Default value: "master". | 357 | as default instead. Default value: "master". |
353 | 358 | ||
354 | repo.desc:: | 359 | repo.desc:: |
355 | The value to show as repository description. Default value: none. | 360 | The value to show as repository description. Default value: none. |
356 | 361 | ||
362 | repo.enable-commit-graph:: | ||
363 | A flag which can be used to disable the global setting | ||
364 | `enable-commit-graph'. Default value: none. | ||
365 | |||
357 | repo.enable-log-filecount:: | 366 | repo.enable-log-filecount:: |
358 | A flag which can be used to disable the global setting | 367 | A flag which can be used to disable the global setting |
359 | `enable-log-filecount'. Default value: none. | 368 | `enable-log-filecount'. Default value: none. |
360 | 369 | ||
361 | repo.enable-log-linecount:: | 370 | repo.enable-log-linecount:: |
362 | A flag which can be used to disable the global setting | 371 | A flag which can be used to disable the global setting |
363 | `enable-log-linecount'. Default value: none. | 372 | `enable-log-linecount'. Default value: none. |
364 | 373 | ||
365 | repo.enable-remote-branches:: | 374 | repo.enable-remote-branches:: |
366 | Flag which, when set to "1", will make cgit display remote branches | 375 | Flag which, when set to "1", will make cgit display remote branches |
367 | in the summary and refs views. Default value: <enable-remote-branches>. | 376 | in the summary and refs views. Default value: <enable-remote-branches>. |
368 | 377 | ||
369 | repo.enable-subject-links:: | 378 | repo.enable-subject-links:: |
370 | A flag which can be used to override the global setting | 379 | A flag which can be used to override the global setting |
371 | `enable-subject-links'. Default value: none. | 380 | `enable-subject-links'. Default value: none. |
372 | 381 | ||
373 | repo.max-stats:: | 382 | repo.max-stats:: |
374 | Override the default maximum statistics period. Valid values are equal | 383 | Override the default maximum statistics period. Valid values are equal |
375 | to the values specified for the global "max-stats" setting. Default | 384 | to the values specified for the global "max-stats" setting. Default |
376 | value: none. | 385 | value: none. |
377 | 386 | ||
378 | repo.name:: | 387 | repo.name:: |
379 | The value to show as repository name. Default value: <repo.url>. | 388 | The value to show as repository name. Default value: <repo.url>. |
380 | 389 | ||
@@ -420,48 +429,52 @@ options are only acknowledged in repo-specific config files when | |||
420 | 429 | ||
421 | Note: the "repo." prefix is dropped from the option names in repo-specific | 430 | Note: the "repo." prefix is dropped from the option names in repo-specific |
422 | config files, e.g. "repo.desc" becomes "desc". | 431 | config files, e.g. "repo.desc" becomes "desc". |
423 | 432 | ||
424 | 433 | ||
425 | EXAMPLE CGITRC FILE | 434 | EXAMPLE CGITRC FILE |
426 | ------------------- | 435 | ------------------- |
427 | 436 | ||
428 | .... | 437 | .... |
429 | # Enable caching of up to 1000 output entriess | 438 | # Enable caching of up to 1000 output entriess |
430 | cache-size=1000 | 439 | cache-size=1000 |
431 | 440 | ||
432 | 441 | ||
433 | # Specify some default clone prefixes | 442 | # Specify some default clone prefixes |
434 | clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git | 443 | clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git |
435 | 444 | ||
436 | # Specify the css url | 445 | # Specify the css url |
437 | css=/css/cgit.css | 446 | css=/css/cgit.css |
438 | 447 | ||
439 | 448 | ||
440 | # Show extra links for each repository on the index page | 449 | # Show extra links for each repository on the index page |
441 | enable-index-links=1 | 450 | enable-index-links=1 |
442 | 451 | ||
443 | 452 | ||
453 | # Enable ASCII art commit history graph on the log pages | ||
454 | enable-commit-graph=1 | ||
455 | |||
456 | |||
444 | # Show number of affected files per commit on the log pages | 457 | # Show number of affected files per commit on the log pages |
445 | enable-log-filecount=1 | 458 | enable-log-filecount=1 |
446 | 459 | ||
447 | 460 | ||
448 | # Show number of added/removed lines per commit on the log pages | 461 | # Show number of added/removed lines per commit on the log pages |
449 | enable-log-linecount=1 | 462 | enable-log-linecount=1 |
450 | 463 | ||
451 | 464 | ||
452 | # Add a cgit favicon | 465 | # Add a cgit favicon |
453 | favicon=/favicon.ico | 466 | favicon=/favicon.ico |
454 | 467 | ||
455 | 468 | ||
456 | # Use a custom logo | 469 | # Use a custom logo |
457 | logo=/img/mylogo.png | 470 | logo=/img/mylogo.png |
458 | 471 | ||
459 | 472 | ||
460 | # Enable statistics per week, month and quarter | 473 | # Enable statistics per week, month and quarter |
461 | max-stats=quarter | 474 | max-stats=quarter |
462 | 475 | ||
463 | 476 | ||
464 | # Set the title and heading of the repository index page | 477 | # Set the title and heading of the repository index page |
465 | root-title=example.com git repositories | 478 | root-title=example.com git repositories |
466 | 479 | ||
467 | 480 | ||