X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/007df98d2114fac4e9134cd7bc7e2960d0d730b4..676d17b22f09faf99295505f68d558b92f3281cb:/cgitrc.5.txt?ds=sidebyside diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 46df291..e7f1a78 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -1,3 +1,6 @@ +:man source: cgit +:man manual: cgit + CGITRC(5) ======== @@ -88,6 +91,10 @@ embedded:: suitable for embedding in other html pages. Default value: none. See also: "noheader". +enable-filter-overrides:: + Flag which, when set to "1", allows all filter settings to be + overridden in repository-specific cgitrc files. Default value: none. + 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", @@ -103,6 +110,10 @@ enable-log-linecount:: and removed lines for each commit on the repository log page. Default value: "0". +enable-tree-linenumbers:: + Flag which, when set to "1", will make cgit generate linenumber links + for plaintext blobs printed in the tree view. Default value: "1". + favicon:: Url used as link to a shortcut icon for cgit. If specified, it is suggested to use the value "/favicon.ico" since certain browsers will @@ -266,14 +277,16 @@ virtual-root:: REPOSITORY SETTINGS ------------------- repo.about-filter:: - Override the default about-filter. Default value: . + Override the default about-filter. Default value: none. See also: + "enable-filter-overrides". 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: . + Override the default commit-filter. Default value: none. See also: + "enable-filter-overrides". repo.defbranch:: The name of the default branch for this repository. If no such branch @@ -320,7 +333,8 @@ repo.section:: none. repo.source-filter:: - Override the default source-filter. Default value: . + Override the default source-filter. Default value: none. See also: + "enable-filter-overrides". repo.url:: The relative url used to access the repository. This must be the first @@ -332,8 +346,12 @@ REPOSITORY-SPECIFIC CGITRC FILE When the option "scan-path" is used to auto-discover git repositories, cgit will try to parse the file "cgitrc" within any found repository. Such a repo-specific config file may contain any of the repo-specific options -described above, except "repo.url" and "repo.path". Also, in a repo-specific -config file, the "repo." prefix is dropped from the config option names. +described above, except "repo.url" and "repo.path". Additionally, the "filter" +options are only acknowledged in repo-specific config files when +"enable-filter-overrides" is set to "1". + +Note: the "repo." prefix is dropped from the option names in repo-specific +config files, e.g. "repo.desc" becomes "desc". EXAMPLE CGITRC FILE