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