-rw-r--r-- | cgitrc.5.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 8e51ca5..01157a9 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -325,96 +325,105 @@ strict-export:: | |||
325 | before 'scan-path'. | 325 | before 'scan-path'. |
326 | 326 | ||
327 | virtual-root:: | 327 | virtual-root:: |
328 | Url which, if specified, will be used as root for all cgit links. It | 328 | Url which, if specified, will be used as root for all cgit links. It |
329 | will also cause cgit to generate 'virtual urls', i.e. urls like | 329 | will also cause cgit to generate 'virtual urls', i.e. urls like |
330 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 330 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
331 | value: none. | 331 | value: none. |
332 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 332 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
333 | same kind of virtual urls, so this option will probably be deprecated. | 333 | same kind of virtual urls, so this option will probably be deprecated. |
334 | 334 | ||
335 | REPOSITORY SETTINGS | 335 | REPOSITORY SETTINGS |
336 | ------------------- | 336 | ------------------- |
337 | repo.about-filter:: | 337 | repo.about-filter:: |
338 | Override the default about-filter. Default value: none. See also: | 338 | Override the default about-filter. Default value: none. See also: |
339 | "enable-filter-overrides". | 339 | "enable-filter-overrides". |
340 | 340 | ||
341 | repo.clone-url:: | 341 | repo.clone-url:: |
342 | A list of space-separated urls which can be used to clone this repo. | 342 | A list of space-separated urls which can be used to clone this repo. |
343 | Default value: none. | 343 | Default value: none. |
344 | 344 | ||
345 | repo.commit-filter:: | 345 | repo.commit-filter:: |
346 | Override the default commit-filter. Default value: none. See also: | 346 | Override the default commit-filter. Default value: none. See also: |
347 | "enable-filter-overrides". | 347 | "enable-filter-overrides". |
348 | 348 | ||
349 | repo.defbranch:: | 349 | repo.defbranch:: |
350 | The name of the default branch for this repository. If no such branch | 350 | 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 | 351 | exists in the repository, the first branch name (when sorted) is used |
352 | as default instead. Default value: "master". | 352 | as default instead. Default value: "master". |
353 | 353 | ||
354 | repo.desc:: | 354 | repo.desc:: |
355 | The value to show as repository description. Default value: none. | 355 | The value to show as repository description. Default value: none. |
356 | 356 | ||
357 | repo.enable-log-filecount:: | 357 | repo.enable-log-filecount:: |
358 | A flag which can be used to disable the global setting | 358 | A flag which can be used to disable the global setting |
359 | `enable-log-filecount'. Default value: none. | 359 | `enable-log-filecount'. Default value: none. |
360 | 360 | ||
361 | repo.enable-log-linecount:: | 361 | repo.enable-log-linecount:: |
362 | A flag which can be used to disable the global setting | 362 | A flag which can be used to disable the global setting |
363 | `enable-log-linecount'. Default value: none. | 363 | `enable-log-linecount'. Default value: none. |
364 | 364 | ||
365 | repo.enable-remote-branches:: | 365 | repo.enable-remote-branches:: |
366 | Flag which, when set to "1", will make cgit display remote branches | 366 | Flag which, when set to "1", will make cgit display remote branches |
367 | in the summary and refs views. Default value: <enable-remote-branches>. | 367 | in the summary and refs views. Default value: <enable-remote-branches>. |
368 | 368 | ||
369 | repo.enable-subject-links:: | 369 | repo.enable-subject-links:: |
370 | A flag which can be used to override the global setting | 370 | A flag which can be used to override the global setting |
371 | `enable-subject-links'. Default value: none. | 371 | `enable-subject-links'. Default value: none. |
372 | 372 | ||
373 | repo.logo:: | ||
374 | 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. | ||
376 | |||
377 | repo.logo-link:: | ||
378 | Url loaded when clicking on the cgit logo image. If unspecified the | ||
379 | calculated url of the repository index page will be used. Default | ||
380 | value: global logo-link. | ||
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 | ||
381 | repo.owner:: | 390 | repo.owner:: |
382 | A value used to identify the owner of the repository. Default value: | 391 | A value used to identify the owner of the repository. Default value: |
383 | none. | 392 | none. |
384 | 393 | ||
385 | repo.path:: | 394 | repo.path:: |
386 | An absolute path to the repository directory. For non-bare repositories | 395 | An absolute path to the repository directory. For non-bare repositories |
387 | this is the .git-directory. Default value: none. | 396 | this is the .git-directory. Default value: none. |
388 | 397 | ||
389 | repo.readme:: | 398 | repo.readme:: |
390 | A path (relative to <repo.path>) which specifies a file to include | 399 | A path (relative to <repo.path>) which specifies a file to include |
391 | verbatim as the "About" page for this repo. You may also specify a | 400 | verbatim as the "About" page for this repo. You may also specify a |
392 | git refspec by head or by hash by prepending the refspec followed by | 401 | git refspec by head or by hash by prepending the refspec followed by |
393 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. | 402 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. |
394 | 403 | ||
395 | repo.snapshots:: | 404 | repo.snapshots:: |
396 | A mask of allowed snapshot-formats for this repo, restricted by the | 405 | A mask of allowed snapshot-formats for this repo, restricted by the |
397 | "snapshots" global setting. Default value: <snapshots>. | 406 | "snapshots" global setting. Default value: <snapshots>. |
398 | 407 | ||
399 | repo.section:: | 408 | repo.section:: |
400 | Override the current section name for this repository. Default value: | 409 | Override the current section name for this repository. Default value: |
401 | none. | 410 | none. |
402 | 411 | ||
403 | repo.source-filter:: | 412 | repo.source-filter:: |
404 | Override the default source-filter. Default value: none. See also: | 413 | Override the default source-filter. Default value: none. See also: |
405 | "enable-filter-overrides". | 414 | "enable-filter-overrides". |
406 | 415 | ||
407 | repo.url:: | 416 | repo.url:: |
408 | The relative url used to access the repository. This must be the first | 417 | The relative url used to access the repository. This must be the first |
409 | setting specified for each repo. Default value: none. | 418 | setting specified for each repo. Default value: none. |
410 | 419 | ||
411 | 420 | ||
412 | REPOSITORY-SPECIFIC CGITRC FILE | 421 | REPOSITORY-SPECIFIC CGITRC FILE |
413 | ------------------------------- | 422 | ------------------------------- |
414 | When the option "scan-path" is used to auto-discover git repositories, cgit | 423 | When the option "scan-path" is used to auto-discover git repositories, cgit |
415 | will try to parse the file "cgitrc" within any found repository. Such a | 424 | will try to parse the file "cgitrc" within any found repository. Such a |
416 | repo-specific config file may contain any of the repo-specific options | 425 | repo-specific config file may contain any of the repo-specific options |
417 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 426 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
418 | options are only acknowledged in repo-specific config files when | 427 | options are only acknowledged in repo-specific config files when |
419 | "enable-filter-overrides" is set to "1". | 428 | "enable-filter-overrides" is set to "1". |
420 | 429 | ||