-rw-r--r-- | cgitrc.5.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index d74d9e7..1f7ac1e 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -337,182 +337,182 @@ repo.path:: | |||
337 | An absolute path to the repository directory. For non-bare repositories | 337 | An absolute path to the repository directory. For non-bare repositories |
338 | this is the .git-directory. Default value: none. | 338 | this is the .git-directory. Default value: none. |
339 | 339 | ||
340 | repo.readme:: | 340 | repo.readme:: |
341 | A path (relative to <repo.path>) which specifies a file to include | 341 | A path (relative to <repo.path>) which specifies a file to include |
342 | verbatim as the "About" page for this repo. Default value: none. | 342 | verbatim as the "About" page for this repo. Default value: none. |
343 | 343 | ||
344 | repo.snapshots:: | 344 | repo.snapshots:: |
345 | A mask of allowed snapshot-formats for this repo, restricted by the | 345 | A mask of allowed snapshot-formats for this repo, restricted by the |
346 | "snapshots" global setting. Default value: <snapshots>. | 346 | "snapshots" global setting. Default value: <snapshots>. |
347 | 347 | ||
348 | repo.section:: | 348 | repo.section:: |
349 | Override the current section name for this repository. Default value: | 349 | Override the current section name for this repository. Default value: |
350 | none. | 350 | none. |
351 | 351 | ||
352 | repo.source-filter:: | 352 | repo.source-filter:: |
353 | Override the default source-filter. Default value: none. See also: | 353 | Override the default source-filter. Default value: none. See also: |
354 | "enable-filter-overrides". | 354 | "enable-filter-overrides". |
355 | 355 | ||
356 | repo.url:: | 356 | repo.url:: |
357 | The relative url used to access the repository. This must be the first | 357 | The relative url used to access the repository. This must be the first |
358 | setting specified for each repo. Default value: none. | 358 | setting specified for each repo. Default value: none. |
359 | 359 | ||
360 | 360 | ||
361 | REPOSITORY-SPECIFIC CGITRC FILE | 361 | REPOSITORY-SPECIFIC CGITRC FILE |
362 | ------------------------------- | 362 | ------------------------------- |
363 | When the option "scan-path" is used to auto-discover git repositories, cgit | 363 | When the option "scan-path" is used to auto-discover git repositories, cgit |
364 | will try to parse the file "cgitrc" within any found repository. Such a | 364 | will try to parse the file "cgitrc" within any found repository. Such a |
365 | repo-specific config file may contain any of the repo-specific options | 365 | repo-specific config file may contain any of the repo-specific options |
366 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 366 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
367 | options are only acknowledged in repo-specific config files when | 367 | options are only acknowledged in repo-specific config files when |
368 | "enable-filter-overrides" is set to "1". | 368 | "enable-filter-overrides" is set to "1". |
369 | 369 | ||
370 | Note: the "repo." prefix is dropped from the option names in repo-specific | 370 | Note: the "repo." prefix is dropped from the option names in repo-specific |
371 | config files, e.g. "repo.desc" becomes "desc". | 371 | config files, e.g. "repo.desc" becomes "desc". |
372 | 372 | ||
373 | 373 | ||
374 | EXAMPLE CGITRC FILE | 374 | EXAMPLE CGITRC FILE |
375 | ------------------- | 375 | ------------------- |
376 | 376 | ||
377 | .... | 377 | .... |
378 | # Enable caching of up to 1000 output entriess | 378 | # Enable caching of up to 1000 output entriess |
379 | cache-size=1000 | 379 | cache-size=1000 |
380 | 380 | ||
381 | 381 | ||
382 | # Specify some default clone prefixes | 382 | # Specify some default clone prefixes |
383 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 383 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
384 | 384 | ||
385 | # Specify the css url | 385 | # Specify the css url |
386 | css=/css/cgit.css | 386 | css=/css/cgit.css |
387 | 387 | ||
388 | 388 | ||
389 | # Show extra links for each repository on the index page | 389 | # Show extra links for each repository on the index page |
390 | enable-index-links=1 | 390 | enable-index-links=1 |
391 | 391 | ||
392 | 392 | ||
393 | # Show number of affected files per commit on the log pages | 393 | # Show number of affected files per commit on the log pages |
394 | enable-log-filecount=1 | 394 | enable-log-filecount=1 |
395 | 395 | ||
396 | 396 | ||
397 | # Show number of added/removed lines per commit on the log pages | 397 | # Show number of added/removed lines per commit on the log pages |
398 | enable-log-linecount=1 | 398 | enable-log-linecount=1 |
399 | 399 | ||
400 | 400 | ||
401 | # Add a cgit favicon | 401 | # Add a cgit favicon |
402 | favicon=/favicon.ico | 402 | favicon=/favicon.ico |
403 | 403 | ||
404 | 404 | ||
405 | # Use a custom logo | 405 | # Use a custom logo |
406 | logo=/img/mylogo.png | 406 | logo=/img/mylogo.png |
407 | 407 | ||
408 | 408 | ||
409 | # Enable statistics per week, month and quarter | 409 | # Enable statistics per week, month and quarter |
410 | max-stats=quarter | 410 | max-stats=quarter |
411 | 411 | ||
412 | 412 | ||
413 | # Set the title and heading of the repository index page | 413 | # Set the title and heading of the repository index page |
414 | root-title=foobar.com git repositories | 414 | root-title=foobar.com git repositories |
415 | 415 | ||
416 | 416 | ||
417 | # Set a subheading for the repository index page | 417 | # Set a subheading for the repository index page |
418 | root-desc=tracking the foobar development | 418 | root-desc=tracking the foobar development |
419 | 419 | ||
420 | 420 | ||
421 | # Include some more info about foobar.com on the index page | 421 | # Include some more info about foobar.com on the index page |
422 | root-readme=/var/www/htdocs/about.html | 422 | root-readme=/var/www/htdocs/about.html |
423 | 423 | ||
424 | 424 | ||
425 | # Allow download of tar.gz, tar.bz2 and zip-files | 425 | # Allow download of tar.gz, tar.bz2 and zip-files |
426 | snapshots=tar.gz tar.bz2 zip | 426 | snapshots=tar.gz tar.bz2 zip |
427 | 427 | ||
428 | 428 | ||
429 | ## | 429 | ## |
430 | ## List of common mimetypes | 430 | ## List of common mimetypes |
431 | ## | 431 | ## |
432 | 432 | ||
433 | mimetype.git=image/git | 433 | mimetype.gif=image/gif |
434 | mimetype.html=text/html | 434 | mimetype.html=text/html |
435 | mimetype.jpg=image/jpeg | 435 | mimetype.jpg=image/jpeg |
436 | mimetype.jpeg=image/jpeg | 436 | mimetype.jpeg=image/jpeg |
437 | mimetype.pdf=application/pdf | 437 | mimetype.pdf=application/pdf |
438 | mimetype.png=image/png | 438 | mimetype.png=image/png |
439 | mimetype.svg=image/svg+xml | 439 | mimetype.svg=image/svg+xml |
440 | 440 | ||
441 | 441 | ||
442 | ## | 442 | ## |
443 | ## List of repositories. | 443 | ## List of repositories. |
444 | ## PS: Any repositories listed when section is unset will not be | 444 | ## PS: Any repositories listed when section is unset will not be |
445 | ## displayed under a section heading | 445 | ## displayed under a section heading |
446 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') | 446 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') |
447 | ## and included like this: | 447 | ## and included like this: |
448 | ## include=/etc/cgitrepos | 448 | ## include=/etc/cgitrepos |
449 | ## | 449 | ## |
450 | 450 | ||
451 | 451 | ||
452 | repo.url=foo | 452 | repo.url=foo |
453 | repo.path=/pub/git/foo.git | 453 | repo.path=/pub/git/foo.git |
454 | repo.desc=the master foo repository | 454 | repo.desc=the master foo repository |
455 | repo.owner=fooman@foobar.com | 455 | repo.owner=fooman@foobar.com |
456 | repo.readme=info/web/about.html | 456 | repo.readme=info/web/about.html |
457 | 457 | ||
458 | 458 | ||
459 | repo.url=bar | 459 | repo.url=bar |
460 | repo.path=/pub/git/bar.git | 460 | repo.path=/pub/git/bar.git |
461 | repo.desc=the bars for your foo | 461 | repo.desc=the bars for your foo |
462 | repo.owner=barman@foobar.com | 462 | repo.owner=barman@foobar.com |
463 | repo.readme=info/web/about.html | 463 | repo.readme=info/web/about.html |
464 | 464 | ||
465 | 465 | ||
466 | # The next repositories will be displayed under the 'extras' heading | 466 | # The next repositories will be displayed under the 'extras' heading |
467 | section=extras | 467 | section=extras |
468 | 468 | ||
469 | 469 | ||
470 | repo.url=baz | 470 | repo.url=baz |
471 | repo.path=/pub/git/baz.git | 471 | repo.path=/pub/git/baz.git |
472 | repo.desc=a set of extensions for bar users | 472 | repo.desc=a set of extensions for bar users |
473 | 473 | ||
474 | repo.url=wiz | 474 | repo.url=wiz |
475 | repo.path=/pub/git/wiz.git | 475 | repo.path=/pub/git/wiz.git |
476 | repo.desc=the wizard of foo | 476 | repo.desc=the wizard of foo |
477 | 477 | ||
478 | 478 | ||
479 | # Add some mirrored repositories | 479 | # Add some mirrored repositories |
480 | section=mirrors | 480 | section=mirrors |
481 | 481 | ||
482 | 482 | ||
483 | repo.url=git | 483 | repo.url=git |
484 | repo.path=/pub/git/git.git | 484 | repo.path=/pub/git/git.git |
485 | repo.desc=the dscm | 485 | repo.desc=the dscm |
486 | 486 | ||
487 | 487 | ||
488 | repo.url=linux | 488 | repo.url=linux |
489 | repo.path=/pub/git/linux.git | 489 | repo.path=/pub/git/linux.git |
490 | repo.desc=the kernel | 490 | repo.desc=the kernel |
491 | 491 | ||
492 | # Disable adhoc downloads of this repo | 492 | # Disable adhoc downloads of this repo |
493 | repo.snapshots=0 | 493 | repo.snapshots=0 |
494 | 494 | ||
495 | # Disable line-counts for this repo | 495 | # Disable line-counts for this repo |
496 | repo.enable-log-linecount=0 | 496 | repo.enable-log-linecount=0 |
497 | 497 | ||
498 | # Restrict the max statistics period for this repo | 498 | # Restrict the max statistics period for this repo |
499 | repo.max-stats=month | 499 | repo.max-stats=month |
500 | .... | 500 | .... |
501 | 501 | ||
502 | 502 | ||
503 | BUGS | 503 | BUGS |
504 | ---- | 504 | ---- |
505 | Comments currently cannot appear on the same line as a setting; the comment | 505 | Comments currently cannot appear on the same line as a setting; the comment |
506 | will be included as part of the value. E.g. this line: | 506 | will be included as part of the value. E.g. this line: |
507 | 507 | ||
508 | robots=index # allow indexing | 508 | robots=index # allow indexing |
509 | 509 | ||
510 | will generate the following html element: | 510 | will generate the following html element: |
511 | 511 | ||
512 | <meta name='robots' content='index # allow indexing'/> | 512 | <meta name='robots' content='index # allow indexing'/> |
513 | 513 | ||
514 | 514 | ||
515 | 515 | ||
516 | AUTHOR | 516 | AUTHOR |
517 | ------ | 517 | ------ |
518 | Lars Hjemli <hjemli@gmail.com> | 518 | Lars Hjemli <hjemli@gmail.com> |