-rw-r--r-- | cgitrc.5.txt | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 75b6584..8e51ca5 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -242,329 +242,329 @@ remove-suffix:: | |||
242 | If set to "1" and scan-path is enabled, if any repositories are found | 242 | If set to "1" and scan-path is enabled, if any repositories are found |
243 | with a suffix of ".git", this suffix will be removed for the url and | 243 | with a suffix of ".git", this suffix will be removed for the url and |
244 | name. Default value: "0". See also: scan-path. | 244 | name. Default value: "0". See also: scan-path. |
245 | 245 | ||
246 | renamelimit:: | 246 | renamelimit:: |
247 | Maximum number of files to consider when detecting renames. The value | 247 | Maximum number of files to consider when detecting renames. The value |
248 | "-1" uses the compiletime value in git (for further info, look at | 248 | "-1" uses the compiletime value in git (for further info, look at |
249 | `man git-diff`). Default value: "-1". | 249 | `man git-diff`). Default value: "-1". |
250 | 250 | ||
251 | repo.group:: | 251 | repo.group:: |
252 | Legacy alias for "section". This option is deprecated and will not be | 252 | Legacy alias for "section". This option is deprecated and will not be |
253 | supported in cgit-1.0. | 253 | supported in cgit-1.0. |
254 | 254 | ||
255 | robots:: | 255 | robots:: |
256 | Text used as content for the "robots" meta-tag. Default value: | 256 | Text used as content for the "robots" meta-tag. Default value: |
257 | "index, nofollow". | 257 | "index, nofollow". |
258 | 258 | ||
259 | root-desc:: | 259 | root-desc:: |
260 | Text printed below the heading on the repository index page. Default | 260 | Text printed below the heading on the repository index page. Default |
261 | value: "a fast webinterface for the git dscm". | 261 | value: "a fast webinterface for the git dscm". |
262 | 262 | ||
263 | root-readme:: | 263 | root-readme:: |
264 | The content of the file specified with this option will be included | 264 | The content of the file specified with this option will be included |
265 | verbatim below the "about" link on the repository index page. Default | 265 | verbatim below the "about" link on the repository index page. Default |
266 | value: none. | 266 | value: none. |
267 | 267 | ||
268 | root-title:: | 268 | root-title:: |
269 | Text printed as heading on the repository index page. Default value: | 269 | Text printed as heading on the repository index page. Default value: |
270 | "Git Repository Browser". | 270 | "Git Repository Browser". |
271 | 271 | ||
272 | scan-path:: | 272 | scan-path:: |
273 | A path which will be scanned for repositories. If caching is enabled, | 273 | A path which will be scanned for repositories. If caching is enabled, |
274 | the result will be cached as a cgitrc include-file in the cache | 274 | the result will be cached as a cgitrc include-file in the cache |
275 | directory. If project-list has been defined prior to scan-path, | 275 | directory. If project-list has been defined prior to scan-path, |
276 | scan-path loads only the directories listed in the file pointed to by | 276 | scan-path loads only the directories listed in the file pointed to by |
277 | project-list. Default value: none. See also: cache-scanrc-ttl, | 277 | project-list. Default value: none. See also: cache-scanrc-ttl, |
278 | project-list. | 278 | project-list. |
279 | 279 | ||
280 | section:: | 280 | section:: |
281 | The name of the current repository section - all repositories defined | 281 | The name of the current repository section - all repositories defined |
282 | after this option will inherit the current section name. Default value: | 282 | after this option will inherit the current section name. Default value: |
283 | none. | 283 | none. |
284 | 284 | ||
285 | section-from-path:: | 285 | section-from-path:: |
286 | A number which, if specified before scan-path, specifies how many | 286 | A number which, if specified before scan-path, specifies how many |
287 | path elements from each repo path to use as a default section name. | 287 | path elements from each repo path to use as a default section name. |
288 | If negative, cgit will discard the specified number of path elements | 288 | If negative, cgit will discard the specified number of path elements |
289 | above the repo directory. Default value: 0. | 289 | above the repo directory. Default value: 0. |
290 | 290 | ||
291 | side-by-side-diffs:: | 291 | side-by-side-diffs:: |
292 | If set to "1" shows side-by-side diffs instead of unidiffs per | 292 | If set to "1" shows side-by-side diffs instead of unidiffs per |
293 | default. Default value: "0". | 293 | default. Default value: "0". |
294 | 294 | ||
295 | snapshots:: | 295 | snapshots:: |
296 | Text which specifies the default set of snapshot formats generated by | 296 | Text which specifies the default set of snapshot formats generated by |
297 | cgit. The value is a space-separated list of zero or more of the | 297 | cgit. The value is a space-separated list of zero or more of the |
298 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 298 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
299 | 299 | ||
300 | source-filter:: | 300 | source-filter:: |
301 | Specifies a command which will be invoked to format plaintext blobs | 301 | Specifies a command which will be invoked to format plaintext blobs |
302 | in the tree view. The command will get the blob content on its STDIN | 302 | in the tree view. The command will get the blob content on its STDIN |
303 | and the name of the blob as its only command line argument. The STDOUT | 303 | and the name of the blob as its only command line argument. The STDOUT |
304 | from the command will be included verbatim as the blob contents, i.e. | 304 | from the command will be included verbatim as the blob contents, i.e. |
305 | this can be used to implement e.g. syntax highlighting. Default value: | 305 | this can be used to implement e.g. syntax highlighting. Default value: |
306 | none. | 306 | none. |
307 | 307 | ||
308 | summary-branches:: | 308 | summary-branches:: |
309 | Specifies the number of branches to display in the repository "summary" | 309 | Specifies the number of branches to display in the repository "summary" |
310 | view. Default value: "10". | 310 | view. Default value: "10". |
311 | 311 | ||
312 | summary-log:: | 312 | summary-log:: |
313 | Specifies the number of log entries to display in the repository | 313 | Specifies the number of log entries to display in the repository |
314 | "summary" view. Default value: "10". | 314 | "summary" view. Default value: "10". |
315 | 315 | ||
316 | summary-tags:: | 316 | summary-tags:: |
317 | Specifies the number of tags to display in the repository "summary" | 317 | Specifies the number of tags to display in the repository "summary" |
318 | view. Default value: "10". | 318 | view. Default value: "10". |
319 | 319 | ||
320 | strict-export:: | 320 | strict-export:: |
321 | Filename which, if specified, needs to be present within the repository | 321 | Filename which, if specified, needs to be present within the repository |
322 | for cgit to allow access to that repository. This can be used to emulate | 322 | for cgit to allow access to that repository. This can be used to emulate |
323 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's | 323 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's |
324 | repositories to match those exported by git-daemon. This option MUST come | 324 | repositories to match those exported by git-daemon. This option MUST come |
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.max-stats:: | 373 | repo.max-stats:: |
374 | Override the default maximum statistics period. Valid values are equal | 374 | Override the default maximum statistics period. Valid values are equal |
375 | to the values specified for the global "max-stats" setting. Default | 375 | to the values specified for the global "max-stats" setting. Default |
376 | value: none. | 376 | value: none. |
377 | 377 | ||
378 | repo.name:: | 378 | repo.name:: |
379 | The value to show as repository name. Default value: <repo.url>. | 379 | The value to show as repository name. Default value: <repo.url>. |
380 | 380 | ||
381 | repo.owner:: | 381 | repo.owner:: |
382 | A value used to identify the owner of the repository. Default value: | 382 | A value used to identify the owner of the repository. Default value: |
383 | none. | 383 | none. |
384 | 384 | ||
385 | repo.path:: | 385 | repo.path:: |
386 | An absolute path to the repository directory. For non-bare repositories | 386 | An absolute path to the repository directory. For non-bare repositories |
387 | this is the .git-directory. Default value: none. | 387 | this is the .git-directory. Default value: none. |
388 | 388 | ||
389 | repo.readme:: | 389 | repo.readme:: |
390 | A path (relative to <repo.path>) which specifies a file to include | 390 | 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 | 391 | 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 | 392 | 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>. | 393 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. |
394 | 394 | ||
395 | repo.snapshots:: | 395 | repo.snapshots:: |
396 | A mask of allowed snapshot-formats for this repo, restricted by the | 396 | A mask of allowed snapshot-formats for this repo, restricted by the |
397 | "snapshots" global setting. Default value: <snapshots>. | 397 | "snapshots" global setting. Default value: <snapshots>. |
398 | 398 | ||
399 | repo.section:: | 399 | repo.section:: |
400 | Override the current section name for this repository. Default value: | 400 | Override the current section name for this repository. Default value: |
401 | none. | 401 | none. |
402 | 402 | ||
403 | repo.source-filter:: | 403 | repo.source-filter:: |
404 | Override the default source-filter. Default value: none. See also: | 404 | Override the default source-filter. Default value: none. See also: |
405 | "enable-filter-overrides". | 405 | "enable-filter-overrides". |
406 | 406 | ||
407 | repo.url:: | 407 | repo.url:: |
408 | The relative url used to access the repository. This must be the first | 408 | The relative url used to access the repository. This must be the first |
409 | setting specified for each repo. Default value: none. | 409 | setting specified for each repo. Default value: none. |
410 | 410 | ||
411 | 411 | ||
412 | REPOSITORY-SPECIFIC CGITRC FILE | 412 | REPOSITORY-SPECIFIC CGITRC FILE |
413 | ------------------------------- | 413 | ------------------------------- |
414 | When the option "scan-path" is used to auto-discover git repositories, cgit | 414 | 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 | 415 | 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 | 416 | repo-specific config file may contain any of the repo-specific options |
417 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 417 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
418 | options are only acknowledged in repo-specific config files when | 418 | options are only acknowledged in repo-specific config files when |
419 | "enable-filter-overrides" is set to "1". | 419 | "enable-filter-overrides" is set to "1". |
420 | 420 | ||
421 | Note: the "repo." prefix is dropped from the option names in repo-specific | 421 | Note: the "repo." prefix is dropped from the option names in repo-specific |
422 | config files, e.g. "repo.desc" becomes "desc". | 422 | config files, e.g. "repo.desc" becomes "desc". |
423 | 423 | ||
424 | 424 | ||
425 | EXAMPLE CGITRC FILE | 425 | EXAMPLE CGITRC FILE |
426 | ------------------- | 426 | ------------------- |
427 | 427 | ||
428 | .... | 428 | .... |
429 | # Enable caching of up to 1000 output entriess | 429 | # Enable caching of up to 1000 output entriess |
430 | cache-size=1000 | 430 | cache-size=1000 |
431 | 431 | ||
432 | 432 | ||
433 | # Specify some default clone prefixes | 433 | # Specify some default clone prefixes |
434 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 434 | clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git |
435 | 435 | ||
436 | # Specify the css url | 436 | # Specify the css url |
437 | css=/css/cgit.css | 437 | css=/css/cgit.css |
438 | 438 | ||
439 | 439 | ||
440 | # Show extra links for each repository on the index page | 440 | # Show extra links for each repository on the index page |
441 | enable-index-links=1 | 441 | enable-index-links=1 |
442 | 442 | ||
443 | 443 | ||
444 | # Show number of affected files per commit on the log pages | 444 | # Show number of affected files per commit on the log pages |
445 | enable-log-filecount=1 | 445 | enable-log-filecount=1 |
446 | 446 | ||
447 | 447 | ||
448 | # Show number of added/removed lines per commit on the log pages | 448 | # Show number of added/removed lines per commit on the log pages |
449 | enable-log-linecount=1 | 449 | enable-log-linecount=1 |
450 | 450 | ||
451 | 451 | ||
452 | # Add a cgit favicon | 452 | # Add a cgit favicon |
453 | favicon=/favicon.ico | 453 | favicon=/favicon.ico |
454 | 454 | ||
455 | 455 | ||
456 | # Use a custom logo | 456 | # Use a custom logo |
457 | logo=/img/mylogo.png | 457 | logo=/img/mylogo.png |
458 | 458 | ||
459 | 459 | ||
460 | # Enable statistics per week, month and quarter | 460 | # Enable statistics per week, month and quarter |
461 | max-stats=quarter | 461 | max-stats=quarter |
462 | 462 | ||
463 | 463 | ||
464 | # Set the title and heading of the repository index page | 464 | # Set the title and heading of the repository index page |
465 | root-title=foobar.com git repositories | 465 | root-title=example.com git repositories |
466 | 466 | ||
467 | 467 | ||
468 | # Set a subheading for the repository index page | 468 | # Set a subheading for the repository index page |
469 | root-desc=tracking the foobar development | 469 | root-desc=tracking the foobar development |
470 | 470 | ||
471 | 471 | ||
472 | # Include some more info about foobar.com on the index page | 472 | # Include some more info about example.com on the index page |
473 | root-readme=/var/www/htdocs/about.html | 473 | root-readme=/var/www/htdocs/about.html |
474 | 474 | ||
475 | 475 | ||
476 | # Allow download of tar.gz, tar.bz2 and zip-files | 476 | # Allow download of tar.gz, tar.bz2 and zip-files |
477 | snapshots=tar.gz tar.bz2 zip | 477 | snapshots=tar.gz tar.bz2 zip |
478 | 478 | ||
479 | 479 | ||
480 | ## | 480 | ## |
481 | ## List of common mimetypes | 481 | ## List of common mimetypes |
482 | ## | 482 | ## |
483 | 483 | ||
484 | mimetype.gif=image/gif | 484 | mimetype.gif=image/gif |
485 | mimetype.html=text/html | 485 | mimetype.html=text/html |
486 | mimetype.jpg=image/jpeg | 486 | mimetype.jpg=image/jpeg |
487 | mimetype.jpeg=image/jpeg | 487 | mimetype.jpeg=image/jpeg |
488 | mimetype.pdf=application/pdf | 488 | mimetype.pdf=application/pdf |
489 | mimetype.png=image/png | 489 | mimetype.png=image/png |
490 | mimetype.svg=image/svg+xml | 490 | mimetype.svg=image/svg+xml |
491 | 491 | ||
492 | 492 | ||
493 | ## | 493 | ## |
494 | ## List of repositories. | 494 | ## List of repositories. |
495 | ## PS: Any repositories listed when section is unset will not be | 495 | ## PS: Any repositories listed when section is unset will not be |
496 | ## displayed under a section heading | 496 | ## displayed under a section heading |
497 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') | 497 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') |
498 | ## and included like this: | 498 | ## and included like this: |
499 | ## include=/etc/cgitrepos | 499 | ## include=/etc/cgitrepos |
500 | ## | 500 | ## |
501 | 501 | ||
502 | 502 | ||
503 | repo.url=foo | 503 | repo.url=foo |
504 | repo.path=/pub/git/foo.git | 504 | repo.path=/pub/git/foo.git |
505 | repo.desc=the master foo repository | 505 | repo.desc=the master foo repository |
506 | repo.owner=fooman@foobar.com | 506 | repo.owner=fooman@example.com |
507 | repo.readme=info/web/about.html | 507 | repo.readme=info/web/about.html |
508 | 508 | ||
509 | 509 | ||
510 | repo.url=bar | 510 | repo.url=bar |
511 | repo.path=/pub/git/bar.git | 511 | repo.path=/pub/git/bar.git |
512 | repo.desc=the bars for your foo | 512 | repo.desc=the bars for your foo |
513 | repo.owner=barman@foobar.com | 513 | repo.owner=barman@example.com |
514 | repo.readme=info/web/about.html | 514 | repo.readme=info/web/about.html |
515 | 515 | ||
516 | 516 | ||
517 | # The next repositories will be displayed under the 'extras' heading | 517 | # The next repositories will be displayed under the 'extras' heading |
518 | section=extras | 518 | section=extras |
519 | 519 | ||
520 | 520 | ||
521 | repo.url=baz | 521 | repo.url=baz |
522 | repo.path=/pub/git/baz.git | 522 | repo.path=/pub/git/baz.git |
523 | repo.desc=a set of extensions for bar users | 523 | repo.desc=a set of extensions for bar users |
524 | 524 | ||
525 | repo.url=wiz | 525 | repo.url=wiz |
526 | repo.path=/pub/git/wiz.git | 526 | repo.path=/pub/git/wiz.git |
527 | repo.desc=the wizard of foo | 527 | repo.desc=the wizard of foo |
528 | 528 | ||
529 | 529 | ||
530 | # Add some mirrored repositories | 530 | # Add some mirrored repositories |
531 | section=mirrors | 531 | section=mirrors |
532 | 532 | ||
533 | 533 | ||
534 | repo.url=git | 534 | repo.url=git |
535 | repo.path=/pub/git/git.git | 535 | repo.path=/pub/git/git.git |
536 | repo.desc=the dscm | 536 | repo.desc=the dscm |
537 | 537 | ||
538 | 538 | ||
539 | repo.url=linux | 539 | repo.url=linux |
540 | repo.path=/pub/git/linux.git | 540 | repo.path=/pub/git/linux.git |
541 | repo.desc=the kernel | 541 | repo.desc=the kernel |
542 | 542 | ||
543 | # Disable adhoc downloads of this repo | 543 | # Disable adhoc downloads of this repo |
544 | repo.snapshots=0 | 544 | repo.snapshots=0 |
545 | 545 | ||
546 | # Disable line-counts for this repo | 546 | # Disable line-counts for this repo |
547 | repo.enable-log-linecount=0 | 547 | repo.enable-log-linecount=0 |
548 | 548 | ||
549 | # Restrict the max statistics period for this repo | 549 | # Restrict the max statistics period for this repo |
550 | repo.max-stats=month | 550 | repo.max-stats=month |
551 | .... | 551 | .... |
552 | 552 | ||
553 | 553 | ||
554 | BUGS | 554 | BUGS |
555 | ---- | 555 | ---- |
556 | Comments currently cannot appear on the same line as a setting; the comment | 556 | Comments currently cannot appear on the same line as a setting; the comment |
557 | will be included as part of the value. E.g. this line: | 557 | will be included as part of the value. E.g. this line: |
558 | 558 | ||
559 | robots=index # allow indexing | 559 | robots=index # allow indexing |
560 | 560 | ||
561 | will generate the following html element: | 561 | will generate the following html element: |
562 | 562 | ||
563 | <meta name='robots' content='index # allow indexing'/> | 563 | <meta name='robots' content='index # allow indexing'/> |
564 | 564 | ||
565 | 565 | ||
566 | 566 | ||
567 | AUTHOR | 567 | AUTHOR |
568 | ------ | 568 | ------ |
569 | Lars Hjemli <hjemli@gmail.com> | 569 | Lars Hjemli <hjemli@gmail.com> |
570 | Jason A. Donenfeld <Jason@zx2c4.com> | 570 | Jason A. Donenfeld <Jason@zx2c4.com> |