summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 5d77973..c643fae 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -310,129 +310,131 @@ summary-tags::
310virtual-root:: 310virtual-root::
311 Url which, if specified, will be used as root for all cgit links. It 311 Url which, if specified, will be used as root for all cgit links. It
312 will also cause cgit to generate 'virtual urls', i.e. urls like 312 will also cause cgit to generate 'virtual urls', i.e. urls like
313 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 313 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
314 value: none. 314 value: none.
315 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 315 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
316 same kind of virtual urls, so this option will probably be deprecated. 316 same kind of virtual urls, so this option will probably be deprecated.
317 317
318REPOSITORY SETTINGS 318REPOSITORY SETTINGS
319------------------- 319-------------------
320repo.about-filter:: 320repo.about-filter::
321 Override the default about-filter. Default value: none. See also: 321 Override the default about-filter. Default value: none. See also:
322 "enable-filter-overrides". 322 "enable-filter-overrides".
323 323
324repo.clone-url:: 324repo.clone-url::
325 A list of space-separated urls which can be used to clone this repo. 325 A list of space-separated urls which can be used to clone this repo.
326 Default value: none. 326 Default value: none.
327 327
328repo.commit-filter:: 328repo.commit-filter::
329 Override the default commit-filter. Default value: none. See also: 329 Override the default commit-filter. Default value: none. See also:
330 "enable-filter-overrides". 330 "enable-filter-overrides".
331 331
332repo.defbranch:: 332repo.defbranch::
333 The name of the default branch for this repository. If no such branch 333 The name of the default branch for this repository. If no such branch
334 exists in the repository, the first branch name (when sorted) is used 334 exists in the repository, the first branch name (when sorted) is used
335 as default instead. Default value: "master". 335 as default instead. Default value: "master".
336 336
337repo.desc:: 337repo.desc::
338 The value to show as repository description. Default value: none. 338 The value to show as repository description. Default value: none.
339 339
340repo.enable-log-filecount:: 340repo.enable-log-filecount::
341 A flag which can be used to disable the global setting 341 A flag which can be used to disable the global setting
342 `enable-log-filecount'. Default value: none. 342 `enable-log-filecount'. Default value: none.
343 343
344repo.enable-log-linecount:: 344repo.enable-log-linecount::
345 A flag which can be used to disable the global setting 345 A flag which can be used to disable the global setting
346 `enable-log-linecount'. Default value: none. 346 `enable-log-linecount'. Default value: none.
347 347
348repo.enable-remote-branches:: 348repo.enable-remote-branches::
349 Flag which, when set to "1", will make cgit display remote branches 349 Flag which, when set to "1", will make cgit display remote branches
350 in the summary and refs views. Default value: <enable-remote-branches>. 350 in the summary and refs views. Default value: <enable-remote-branches>.
351 351
352repo.enable-subject-links:: 352repo.enable-subject-links::
353 A flag which can be used to override the global setting 353 A flag which can be used to override the global setting
354 `enable-subject-links'. Default value: none. 354 `enable-subject-links'. Default value: none.
355 355
356repo.max-stats:: 356repo.max-stats::
357 Override the default maximum statistics period. Valid values are equal 357 Override the default maximum statistics period. Valid values are equal
358 to the values specified for the global "max-stats" setting. Default 358 to the values specified for the global "max-stats" setting. Default
359 value: none. 359 value: none.
360 360
361repo.name:: 361repo.name::
362 The value to show as repository name. Default value: <repo.url>. 362 The value to show as repository name. Default value: <repo.url>.
363 363
364repo.owner:: 364repo.owner::
365 A value used to identify the owner of the repository. Default value: 365 A value used to identify the owner of the repository. Default value:
366 none. 366 none.
367 367
368repo.path:: 368repo.path::
369 An absolute path to the repository directory. For non-bare repositories 369 An absolute path to the repository directory. For non-bare repositories
370 this is the .git-directory. Default value: none. 370 this is the .git-directory. Default value: none.
371 371
372repo.readme:: 372repo.readme::
373 A path (relative to <repo.path>) which specifies a file to include 373 A path (relative to <repo.path>) which specifies a file to include
374 verbatim as the "About" page for this repo. Default value: none. 374 verbatim as the "About" page for this repo. You may also specify a
375 git refspec by head or by hash by prepending the refspec followed by
376 a colon. For example, "master:docs/readme.mkd" Default value: none.
375 377
376repo.snapshots:: 378repo.snapshots::
377 A mask of allowed snapshot-formats for this repo, restricted by the 379 A mask of allowed snapshot-formats for this repo, restricted by the
378 "snapshots" global setting. Default value: <snapshots>. 380 "snapshots" global setting. Default value: <snapshots>.
379 381
380repo.section:: 382repo.section::
381 Override the current section name for this repository. Default value: 383 Override the current section name for this repository. Default value:
382 none. 384 none.
383 385
384repo.source-filter:: 386repo.source-filter::
385 Override the default source-filter. Default value: none. See also: 387 Override the default source-filter. Default value: none. See also:
386 "enable-filter-overrides". 388 "enable-filter-overrides".
387 389
388repo.url:: 390repo.url::
389 The relative url used to access the repository. This must be the first 391 The relative url used to access the repository. This must be the first
390 setting specified for each repo. Default value: none. 392 setting specified for each repo. Default value: none.
391 393
392 394
393REPOSITORY-SPECIFIC CGITRC FILE 395REPOSITORY-SPECIFIC CGITRC FILE
394------------------------------- 396-------------------------------
395When the option "scan-path" is used to auto-discover git repositories, cgit 397When the option "scan-path" is used to auto-discover git repositories, cgit
396will try to parse the file "cgitrc" within any found repository. Such a 398will try to parse the file "cgitrc" within any found repository. Such a
397repo-specific config file may contain any of the repo-specific options 399repo-specific config file may contain any of the repo-specific options
398described above, except "repo.url" and "repo.path". Additionally, the "filter" 400described above, except "repo.url" and "repo.path". Additionally, the "filter"
399options are only acknowledged in repo-specific config files when 401options are only acknowledged in repo-specific config files when
400"enable-filter-overrides" is set to "1". 402"enable-filter-overrides" is set to "1".
401 403
402Note: the "repo." prefix is dropped from the option names in repo-specific 404Note: the "repo." prefix is dropped from the option names in repo-specific
403config files, e.g. "repo.desc" becomes "desc". 405config files, e.g. "repo.desc" becomes "desc".
404 406
405 407
406EXAMPLE CGITRC FILE 408EXAMPLE CGITRC FILE
407------------------- 409-------------------
408 410
409.... 411....
410# Enable caching of up to 1000 output entriess 412# Enable caching of up to 1000 output entriess
411cache-size=1000 413cache-size=1000
412 414
413 415
414# Specify some default clone prefixes 416# Specify some default clone prefixes
415clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 417clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
416 418
417# Specify the css url 419# Specify the css url
418css=/css/cgit.css 420css=/css/cgit.css
419 421
420 422
421# Show extra links for each repository on the index page 423# Show extra links for each repository on the index page
422enable-index-links=1 424enable-index-links=1
423 425
424 426
425# Show number of affected files per commit on the log pages 427# Show number of affected files per commit on the log pages
426enable-log-filecount=1 428enable-log-filecount=1
427 429
428 430
429# Show number of added/removed lines per commit on the log pages 431# Show number of added/removed lines per commit on the log pages
430enable-log-linecount=1 432enable-log-linecount=1
431 433
432 434
433# Add a cgit favicon 435# Add a cgit favicon
434favicon=/favicon.ico 436favicon=/favicon.ico
435 437
436 438
437# Use a custom logo 439# Use a custom logo
438logo=/img/mylogo.png 440logo=/img/mylogo.png