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 a832830..c3698a6 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -342,96 +342,105 @@ virtual-root::
342 will also cause cgit to generate 'virtual urls', i.e. urls like 342 will also cause cgit to generate 'virtual urls', i.e. urls like
343 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 343 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
344 value: none. 344 value: none.
345 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 345 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
346 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.
347 347
348REPOSITORY SETTINGS 348REPOSITORY SETTINGS
349------------------- 349-------------------
350repo.about-filter:: 350repo.about-filter::
351 Override the default about-filter. Default value: none. See also: 351 Override the default about-filter. Default value: none. See also:
352 "enable-filter-overrides". 352 "enable-filter-overrides".
353 353
354repo.clone-url:: 354repo.clone-url::
355 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.
356 Default value: none. 356 Default value: none.
357 357
358repo.commit-filter:: 358repo.commit-filter::
359 Override the default commit-filter. Default value: none. See also: 359 Override the default commit-filter. Default value: none. See also:
360 "enable-filter-overrides". 360 "enable-filter-overrides".
361 361
362repo.defbranch:: 362repo.defbranch::
363 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
364 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
365 as default instead. Default value: "master". 365 as default instead. Default value: "master".
366 366
367repo.desc:: 367repo.desc::
368 The value to show as repository description. Default value: none. 368 The value to show as repository description. Default value: none.
369 369
370repo.enable-commit-graph:: 370repo.enable-commit-graph::
371 A flag which can be used to disable the global setting 371 A flag which can be used to disable the global setting
372 `enable-commit-graph'. Default value: none. 372 `enable-commit-graph'. Default value: none.
373 373
374repo.enable-log-filecount:: 374repo.enable-log-filecount::
375 A flag which can be used to disable the global setting 375 A flag which can be used to disable the global setting
376 `enable-log-filecount'. Default value: none. 376 `enable-log-filecount'. Default value: none.
377 377
378repo.enable-log-linecount:: 378repo.enable-log-linecount::
379 A flag which can be used to disable the global setting 379 A flag which can be used to disable the global setting
380 `enable-log-linecount'. Default value: none. 380 `enable-log-linecount'. Default value: none.
381 381
382repo.enable-remote-branches:: 382repo.enable-remote-branches::
383 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
384 in the summary and refs views. Default value: <enable-remote-branches>. 384 in the summary and refs views. Default value: <enable-remote-branches>.
385 385
386repo.enable-subject-links:: 386repo.enable-subject-links::
387 A flag which can be used to override the global setting 387 A flag which can be used to override the global setting
388 `enable-subject-links'. Default value: none. 388 `enable-subject-links'. Default value: none.
389 389
390repo.logo::
391 Url which specifies the source of an image which will be used as a logo
392 on this repo's pages. Default value: global logo.
393
394repo.logo-link::
395 Url loaded when clicking on the cgit logo image. If unspecified the
396 calculated url of the repository index page will be used. Default
397 value: global logo-link.
398
390repo.max-stats:: 399repo.max-stats::
391 Override the default maximum statistics period. Valid values are equal 400 Override the default maximum statistics period. Valid values are equal
392 to the values specified for the global "max-stats" setting. Default 401 to the values specified for the global "max-stats" setting. Default
393 value: none. 402 value: none.
394 403
395repo.name:: 404repo.name::
396 The value to show as repository name. Default value: <repo.url>. 405 The value to show as repository name. Default value: <repo.url>.
397 406
398repo.owner:: 407repo.owner::
399 A value used to identify the owner of the repository. Default value: 408 A value used to identify the owner of the repository. Default value:
400 none. 409 none.
401 410
402repo.path:: 411repo.path::
403 An absolute path to the repository directory. For non-bare repositories 412 An absolute path to the repository directory. For non-bare repositories
404 this is the .git-directory. Default value: none. 413 this is the .git-directory. Default value: none.
405 414
406repo.readme:: 415repo.readme::
407 A path (relative to <repo.path>) which specifies a file to include 416 A path (relative to <repo.path>) which specifies a file to include
408 verbatim as the "About" page for this repo. You may also specify a 417 verbatim as the "About" page for this repo. You may also specify a
409 git refspec by head or by hash by prepending the refspec followed by 418 git refspec by head or by hash by prepending the refspec followed by
410 a colon. For example, "master:docs/readme.mkd" Default value: <readme>. 419 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
411 420
412repo.snapshots:: 421repo.snapshots::
413 A mask of allowed snapshot-formats for this repo, restricted by the 422 A mask of allowed snapshot-formats for this repo, restricted by the
414 "snapshots" global setting. Default value: <snapshots>. 423 "snapshots" global setting. Default value: <snapshots>.
415 424
416repo.section:: 425repo.section::
417 Override the current section name for this repository. Default value: 426 Override the current section name for this repository. Default value:
418 none. 427 none.
419 428
420repo.source-filter:: 429repo.source-filter::
421 Override the default source-filter. Default value: none. See also: 430 Override the default source-filter. Default value: none. See also:
422 "enable-filter-overrides". 431 "enable-filter-overrides".
423 432
424repo.url:: 433repo.url::
425 The relative url used to access the repository. This must be the first 434 The relative url used to access the repository. This must be the first
426 setting specified for each repo. Default value: none. 435 setting specified for each repo. Default value: none.
427 436
428 437
429REPOSITORY-SPECIFIC CGITRC FILE 438REPOSITORY-SPECIFIC CGITRC FILE
430------------------------------- 439-------------------------------
431When the option "scan-path" is used to auto-discover git repositories, cgit 440When the option "scan-path" is used to auto-discover git repositories, cgit
432will try to parse the file "cgitrc" within any found repository. Such a 441will try to parse the file "cgitrc" within any found repository. Such a
433repo-specific config file may contain any of the repo-specific options 442repo-specific config file may contain any of the repo-specific options
434described above, except "repo.url" and "repo.path". Additionally, the "filter" 443described above, except "repo.url" and "repo.path". Additionally, the "filter"
435options are only acknowledged in repo-specific config files when 444options are only acknowledged in repo-specific config files when
436"enable-filter-overrides" is set to "1". 445"enable-filter-overrides" is set to "1".
437 446