X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/7e5c048505efe1902fb476cc2cb3160ff7df013d..537c05f138d59c1eb3ac8e2d8b0dca3a38aa5dd4:/cgitrc.5.txt diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 7879f75..d8e4b97 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -16,6 +16,13 @@ lines, and lines starting with '#', are ignored. GLOBAL SETTINGS --------------- +about-filter:: + Specifies a command which will be invoked to format the content of + about pages (both top-level and for each repository). The command will + get the content of the about-file on its STDIN, and the STDOUT from the + command will be included verbatim on the about page. Default value: + none. + agefile:: Specifies a path, relative to each repository path, which can be used to specify the date and time of the youngest commit in the repository. @@ -55,10 +62,21 @@ clone-prefix:: setting is only used if `repo.clone-url` is unspecified. Default value: none. +commit-filter:: + Specifies a command which will be invoked to format commit messages. + The command will get the message on its STDIN, and the STDOUT from the + command will be included verbatim as the commit message, i.e. this can + be used to implement bugtracker integration. Default value: none. + css:: Url which specifies the css document to include in all cgit pages. Default value: "/cgit.css". +embedded:: + Flag which, when set to "1", will make cgit generate a html fragment + suitable for embedding in other html pages. Default value: none. See + also: "noheader". + enable-index-links:: Flag which, when set to "1", will make cgit generate extra links for each repo in the repository index (specifically, to the "summary", @@ -84,6 +102,10 @@ footer:: verbatim at the bottom of all pages (i.e. it replaces the standard "generated by..." message. Default value: none. +head-include:: + The content of the file specified with this option will be included + verbatim in the html HEAD section on all pages. Default value: none. + header:: The content of the file specified with this option will be included verbatim at the top of all pages. Default value: none. @@ -149,6 +171,10 @@ nocache:: deprecated, and will not be honored starting with cgit-1.0. Default value: "0". +noheader:: + Flag which, when set to "1", will make cgit omit the standard header + on all pages. Default value: none. See also: "embedded". + renamelimit:: Maximum number of files to consider when detecting renames. The value "-1" uses the compiletime value in git (for further info, look at @@ -185,6 +211,14 @@ snapshots:: "zip" zip-file Default value: none. +source-filter:: + Specifies a command which will be invoked to format plaintext blobs + in the tree view. The command will get the blob content on its STDIN + and the name of the blob as its only command line argument. The STDOUT + from the command will be included verbatim as the blob contents, i.e. + this can be used to implement e.g. syntax highlighting. Default value: + none. + summary-branches:: Specifies the number of branches to display in the repository "summary" view. Default value: "10". @@ -207,10 +241,16 @@ virtual-root:: REPOSITORY SETTINGS ------------------- +repo.about-filter:: + Override the default about-filter. Default value: . + repo.clone-url:: A list of space-separated urls which can be used to clone this repo. Default value: none. +repo.commit-filter:: + Override the default commit-filter. Default value: . + repo.defbranch:: The name of the default branch for this repository. If no such branch exists in the repository, the first branch name (when sorted) is used @@ -251,6 +291,9 @@ repo.snapshots:: A mask of allowed snapshot-formats for this repo, restricted by the "snapshots" global setting. Default value: . +repo.source-filter:: + Override the default source-filter. Default value: . + repo.url:: The relative url used to access the repository. This must be the first setting specified for each repo. Default value: none.