diff options
-rw-r--r-- | cgitrc.5.txt | 50 |
1 files changed, 24 insertions, 26 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 8e31578..9a9965b 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -460,39 +460,37 @@ config files, e.g. "repo.desc" becomes "desc". | |||
460 | 460 | ||
461 | FILTER API | 461 | FILTER API |
462 | ---------- | 462 | ---------- |
463 | - about filter:: | 463 | about filter:: |
464 | This filter is given no arguments. | 464 | This filter is given no arguments. The about text that is to be |
465 | The about text that is to be filtered is available on standard input and the | 465 | filtered is available on standard input and the filtered text is |
466 | filtered text is expected on standard output. | 466 | expected on standard output. |
467 | - commit filter:: | 467 | |
468 | This filter is given no arguments. | 468 | commit filter:: |
469 | The commit message text that is to be filtered is available on standard input | 469 | This filter is given no arguments. The commit message text that is to |
470 | and the filtered text is expected on standard output. | 470 | be filtered is available on standard input and the filtered text is |
471 | - source filter:: | 471 | expected on standard output. |
472 | This filter is given a single parameter: the filename of the source file to | 472 | |
473 | filter. The filter can use the filename to determine (for example) the syntax | 473 | source filter:: |
474 | highlighting mode. | 474 | This filter is given a single parameter: the filename of the source |
475 | The contents of the source file that is to be filtered is available on | 475 | file to filter. The filter can use the filename to determine (for |
476 | standard input and the filtered contents is expected on standard output. | 476 | example) the syntax highlighting mode. The contents of the source |
477 | file that is to be filtered is available on standard input and the | ||
478 | filtered contents is expected on standard output. | ||
477 | 479 | ||
478 | Also, all filters are handed the following environment variables: | 480 | Also, all filters are handed the following environment variables: |
479 | - CGIT_REPO_URL ( = repo.url setting ) | 481 | |
480 | - CGIT_REPO_NAME ( = repo.name setting ) | 482 | - CGIT_REPO_URL (from repo.url) |
481 | - CGIT_REPO_PATH ( = repo.path setting ) | 483 | - CGIT_REPO_NAME (from repo.name) |
482 | - CGIT_REPO_OWNER ( = repo.owner setting ) | 484 | - CGIT_REPO_PATH (from repo.path) |
483 | - CGIT_REPO_DEFBRANCH ( = repo.defbranch setting ) | 485 | - CGIT_REPO_OWNER (from repo.owner) |
484 | - CGIT_REPO_SECTION ( = section setting ) | 486 | - CGIT_REPO_DEFBRANCH (from repo.defbranch) |
485 | - CGIT_REPO_CLONE_URL ( = repo.clone-url setting ) | 487 | - CGIT_REPO_SECTION (from repo.section) |
488 | - CGIT_REPO_CLONE_URL (from repo.clone-url) | ||
486 | 489 | ||
487 | If a setting is not defined for a repository and the corresponding global | 490 | If a setting is not defined for a repository and the corresponding global |
488 | setting is also not defined (if applicable), then the corresponding | 491 | setting is also not defined (if applicable), then the corresponding |
489 | environment variable will be an empty string. | 492 | environment variable will be an empty string. |
490 | 493 | ||
491 | Note that under normal circumstance all these environment variables are | ||
492 | defined. If however the total size of the defined settings exceed the | ||
493 | allocated buffer within cgit then only the environment variables that fit | ||
494 | in the allocated buffer are handed to the filter. | ||
495 | |||
496 | 494 | ||
497 | MACRO EXPANSION | 495 | MACRO EXPANSION |
498 | --------------- | 496 | --------------- |