summaryrefslogtreecommitdiffabout
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt10
1 files changed, 5 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index ce78d41..ea1b18a 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -235,329 +235,329 @@ project-list::
235 scan-path. Default value: none. See also: scan-path. 235 scan-path. Default value: none. See also: scan-path.
236 236
237readme:: 237readme::
238 Text which will be used as default value for "repo.readme". Default 238 Text which will be used as default value for "repo.readme". Default
239 value: none. 239 value: none.
240 240
241remove-suffix:: 241remove-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
246renamelimit:: 246renamelimit::
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
251repo.group:: 251repo.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
255robots:: 255robots::
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
259root-desc:: 259root-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
263root-readme:: 263root-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
268root-title:: 268root-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
272scan-path:: 272scan-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
280section:: 280section::
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
285section-from-path:: 285section-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
291side-by-side-diffs:: 291side-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
295snapshots:: 295snapshots::
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
300source-filter:: 300source-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
308summary-branches:: 308summary-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
312summary-log:: 312summary-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
316summary-tags:: 316summary-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
320virtual-root:: 320virtual-root::
321 Url which, if specified, will be used as root for all cgit links. It 321 Url which, if specified, will be used as root for all cgit links. It
322 will also cause cgit to generate 'virtual urls', i.e. urls like 322 will also cause cgit to generate 'virtual urls', i.e. urls like
323 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 323 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
324 value: none. 324 value: none.
325 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 325 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
326 same kind of virtual urls, so this option will probably be deprecated. 326 same kind of virtual urls, so this option will probably be deprecated.
327 327
328REPOSITORY SETTINGS 328REPOSITORY SETTINGS
329------------------- 329-------------------
330repo.about-filter:: 330repo.about-filter::
331 Override the default about-filter. Default value: none. See also: 331 Override the default about-filter. Default value: none. See also:
332 "enable-filter-overrides". 332 "enable-filter-overrides".
333 333
334repo.clone-url:: 334repo.clone-url::
335 A list of space-separated urls which can be used to clone this repo. 335 A list of space-separated urls which can be used to clone this repo.
336 Default value: none. 336 Default value: none.
337 337
338repo.commit-filter:: 338repo.commit-filter::
339 Override the default commit-filter. Default value: none. See also: 339 Override the default commit-filter. Default value: none. See also:
340 "enable-filter-overrides". 340 "enable-filter-overrides".
341 341
342repo.defbranch:: 342repo.defbranch::
343 The name of the default branch for this repository. If no such branch 343 The name of the default branch for this repository. If no such branch
344 exists in the repository, the first branch name (when sorted) is used 344 exists in the repository, the first branch name (when sorted) is used
345 as default instead. Default value: "master". 345 as default instead. Default value: "master".
346 346
347repo.desc:: 347repo.desc::
348 The value to show as repository description. Default value: none. 348 The value to show as repository description. Default value: none.
349 349
350repo.enable-log-filecount:: 350repo.enable-log-filecount::
351 A flag which can be used to disable the global setting 351 A flag which can be used to disable the global setting
352 `enable-log-filecount'. Default value: none. 352 `enable-log-filecount'. Default value: none.
353 353
354repo.enable-log-linecount:: 354repo.enable-log-linecount::
355 A flag which can be used to disable the global setting 355 A flag which can be used to disable the global setting
356 `enable-log-linecount'. Default value: none. 356 `enable-log-linecount'. Default value: none.
357 357
358repo.enable-remote-branches:: 358repo.enable-remote-branches::
359 Flag which, when set to "1", will make cgit display remote branches 359 Flag which, when set to "1", will make cgit display remote branches
360 in the summary and refs views. Default value: <enable-remote-branches>. 360 in the summary and refs views. Default value: <enable-remote-branches>.
361 361
362repo.enable-subject-links:: 362repo.enable-subject-links::
363 A flag which can be used to override the global setting 363 A flag which can be used to override the global setting
364 `enable-subject-links'. Default value: none. 364 `enable-subject-links'. Default value: none.
365 365
366repo.max-stats:: 366repo.max-stats::
367 Override the default maximum statistics period. Valid values are equal 367 Override the default maximum statistics period. Valid values are equal
368 to the values specified for the global "max-stats" setting. Default 368 to the values specified for the global "max-stats" setting. Default
369 value: none. 369 value: none.
370 370
371repo.name:: 371repo.name::
372 The value to show as repository name. Default value: <repo.url>. 372 The value to show as repository name. Default value: <repo.url>.
373 373
374repo.owner:: 374repo.owner::
375 A value used to identify the owner of the repository. Default value: 375 A value used to identify the owner of the repository. Default value:
376 none. 376 none.
377 377
378repo.path:: 378repo.path::
379 An absolute path to the repository directory. For non-bare repositories 379 An absolute path to the repository directory. For non-bare repositories
380 this is the .git-directory. Default value: none. 380 this is the .git-directory. Default value: none.
381 381
382repo.readme:: 382repo.readme::
383 A path (relative to <repo.path>) which specifies a file to include 383 A path (relative to <repo.path>) which specifies a file to include
384 verbatim as the "About" page for this repo. You may also specify a 384 verbatim as the "About" page for this repo. You may also specify a
385 git refspec by head or by hash by prepending the refspec followed by 385 git refspec by head or by hash by prepending the refspec followed by
386 a colon. For example, "master:docs/readme.mkd" Default value: <readme>. 386 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
387 387
388repo.snapshots:: 388repo.snapshots::
389 A mask of allowed snapshot-formats for this repo, restricted by the 389 A mask of allowed snapshot-formats for this repo, restricted by the
390 "snapshots" global setting. Default value: <snapshots>. 390 "snapshots" global setting. Default value: <snapshots>.
391 391
392repo.section:: 392repo.section::
393 Override the current section name for this repository. Default value: 393 Override the current section name for this repository. Default value:
394 none. 394 none.
395 395
396repo.source-filter:: 396repo.source-filter::
397 Override the default source-filter. Default value: none. See also: 397 Override the default source-filter. Default value: none. See also:
398 "enable-filter-overrides". 398 "enable-filter-overrides".
399 399
400repo.url:: 400repo.url::
401 The relative url used to access the repository. This must be the first 401 The relative url used to access the repository. This must be the first
402 setting specified for each repo. Default value: none. 402 setting specified for each repo. Default value: none.
403 403
404 404
405REPOSITORY-SPECIFIC CGITRC FILE 405REPOSITORY-SPECIFIC CGITRC FILE
406------------------------------- 406-------------------------------
407When the option "scan-path" is used to auto-discover git repositories, cgit 407When the option "scan-path" is used to auto-discover git repositories, cgit
408will try to parse the file "cgitrc" within any found repository. Such a 408will try to parse the file "cgitrc" within any found repository. Such a
409repo-specific config file may contain any of the repo-specific options 409repo-specific config file may contain any of the repo-specific options
410described above, except "repo.url" and "repo.path". Additionally, the "filter" 410described above, except "repo.url" and "repo.path". Additionally, the "filter"
411options are only acknowledged in repo-specific config files when 411options are only acknowledged in repo-specific config files when
412"enable-filter-overrides" is set to "1". 412"enable-filter-overrides" is set to "1".
413 413
414Note: the "repo." prefix is dropped from the option names in repo-specific 414Note: the "repo." prefix is dropped from the option names in repo-specific
415config files, e.g. "repo.desc" becomes "desc". 415config files, e.g. "repo.desc" becomes "desc".
416 416
417 417
418EXAMPLE CGITRC FILE 418EXAMPLE CGITRC FILE
419------------------- 419-------------------
420 420
421.... 421....
422# Enable caching of up to 1000 output entriess 422# Enable caching of up to 1000 output entriess
423cache-size=1000 423cache-size=1000
424 424
425 425
426# Specify some default clone prefixes 426# Specify some default clone prefixes
427clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 427clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
428 428
429# Specify the css url 429# Specify the css url
430css=/css/cgit.css 430css=/css/cgit.css
431 431
432 432
433# Show extra links for each repository on the index page 433# Show extra links for each repository on the index page
434enable-index-links=1 434enable-index-links=1
435 435
436 436
437# Show number of affected files per commit on the log pages 437# Show number of affected files per commit on the log pages
438enable-log-filecount=1 438enable-log-filecount=1
439 439
440 440
441# Show number of added/removed lines per commit on the log pages 441# Show number of added/removed lines per commit on the log pages
442enable-log-linecount=1 442enable-log-linecount=1
443 443
444 444
445# Add a cgit favicon 445# Add a cgit favicon
446favicon=/favicon.ico 446favicon=/favicon.ico
447 447
448 448
449# Use a custom logo 449# Use a custom logo
450logo=/img/mylogo.png 450logo=/img/mylogo.png
451 451
452 452
453# Enable statistics per week, month and quarter 453# Enable statistics per week, month and quarter
454max-stats=quarter 454max-stats=quarter
455 455
456 456
457# Set the title and heading of the repository index page 457# Set the title and heading of the repository index page
458root-title=foobar.com git repositories 458root-title=example.com git repositories
459 459
460 460
461# Set a subheading for the repository index page 461# Set a subheading for the repository index page
462root-desc=tracking the foobar development 462root-desc=tracking the foobar development
463 463
464 464
465# Include some more info about foobar.com on the index page 465# Include some more info about example.com on the index page
466root-readme=/var/www/htdocs/about.html 466root-readme=/var/www/htdocs/about.html
467 467
468 468
469# Allow download of tar.gz, tar.bz2 and zip-files 469# Allow download of tar.gz, tar.bz2 and zip-files
470snapshots=tar.gz tar.bz2 zip 470snapshots=tar.gz tar.bz2 zip
471 471
472 472
473## 473##
474## List of common mimetypes 474## List of common mimetypes
475## 475##
476 476
477mimetype.gif=image/gif 477mimetype.gif=image/gif
478mimetype.html=text/html 478mimetype.html=text/html
479mimetype.jpg=image/jpeg 479mimetype.jpg=image/jpeg
480mimetype.jpeg=image/jpeg 480mimetype.jpeg=image/jpeg
481mimetype.pdf=application/pdf 481mimetype.pdf=application/pdf
482mimetype.png=image/png 482mimetype.png=image/png
483mimetype.svg=image/svg+xml 483mimetype.svg=image/svg+xml
484 484
485 485
486## 486##
487## List of repositories. 487## List of repositories.
488## PS: Any repositories listed when section is unset will not be 488## PS: Any repositories listed when section is unset will not be
489## displayed under a section heading 489## displayed under a section heading
490## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 490## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
491## and included like this: 491## and included like this:
492## include=/etc/cgitrepos 492## include=/etc/cgitrepos
493## 493##
494 494
495 495
496repo.url=foo 496repo.url=foo
497repo.path=/pub/git/foo.git 497repo.path=/pub/git/foo.git
498repo.desc=the master foo repository 498repo.desc=the master foo repository
499repo.owner=fooman@foobar.com 499repo.owner=fooman@example.com
500repo.readme=info/web/about.html 500repo.readme=info/web/about.html
501 501
502 502
503repo.url=bar 503repo.url=bar
504repo.path=/pub/git/bar.git 504repo.path=/pub/git/bar.git
505repo.desc=the bars for your foo 505repo.desc=the bars for your foo
506repo.owner=barman@foobar.com 506repo.owner=barman@example.com
507repo.readme=info/web/about.html 507repo.readme=info/web/about.html
508 508
509 509
510# The next repositories will be displayed under the 'extras' heading 510# The next repositories will be displayed under the 'extras' heading
511section=extras 511section=extras
512 512
513 513
514repo.url=baz 514repo.url=baz
515repo.path=/pub/git/baz.git 515repo.path=/pub/git/baz.git
516repo.desc=a set of extensions for bar users 516repo.desc=a set of extensions for bar users
517 517
518repo.url=wiz 518repo.url=wiz
519repo.path=/pub/git/wiz.git 519repo.path=/pub/git/wiz.git
520repo.desc=the wizard of foo 520repo.desc=the wizard of foo
521 521
522 522
523# Add some mirrored repositories 523# Add some mirrored repositories
524section=mirrors 524section=mirrors
525 525
526 526
527repo.url=git 527repo.url=git
528repo.path=/pub/git/git.git 528repo.path=/pub/git/git.git
529repo.desc=the dscm 529repo.desc=the dscm
530 530
531 531
532repo.url=linux 532repo.url=linux
533repo.path=/pub/git/linux.git 533repo.path=/pub/git/linux.git
534repo.desc=the kernel 534repo.desc=the kernel
535 535
536# Disable adhoc downloads of this repo 536# Disable adhoc downloads of this repo
537repo.snapshots=0 537repo.snapshots=0
538 538
539# Disable line-counts for this repo 539# Disable line-counts for this repo
540repo.enable-log-linecount=0 540repo.enable-log-linecount=0
541 541
542# Restrict the max statistics period for this repo 542# Restrict the max statistics period for this repo
543repo.max-stats=month 543repo.max-stats=month
544.... 544....
545 545
546 546
547BUGS 547BUGS
548---- 548----
549Comments currently cannot appear on the same line as a setting; the comment 549Comments currently cannot appear on the same line as a setting; the comment
550will be included as part of the value. E.g. this line: 550will be included as part of the value. E.g. this line:
551 551
552 robots=index # allow indexing 552 robots=index # allow indexing
553 553
554will generate the following html element: 554will generate the following html element:
555 555
556 <meta name='robots' content='index # allow indexing'/> 556 <meta name='robots' content='index # allow indexing'/>
557 557
558 558
559 559
560AUTHOR 560AUTHOR
561------ 561------
562Lars Hjemli <hjemli@gmail.com> 562Lars Hjemli <hjemli@gmail.com>
563Jason A. Donenfeld <Jason@zx2c4.com> 563Jason A. Donenfeld <Jason@zx2c4.com>