X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/db8b8cb9467625cb8d9ecb67863aa67590e59cc0..e7af002d5c405c82652f739d08ced3908d1f57e7:/cgitrc.5.txt diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 4d656fe..4d009f9 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -14,6 +14,13 @@ repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank lines, and lines starting with '#', are ignored. +LOCATION +-------- +The default location of cgitrc, defined at compile time, is /etc/cgitrc. At +runtime, cgit will consult the environment variable CGIT_CONFIG and, if +defined, use its value instead. + + GLOBAL SETTINGS --------------- about-filter:: @@ -47,6 +54,10 @@ cache-root-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of the repository index page. Default value: "5". +cache-scanrc-ttl:: + Number which specifies the time-to-live, in minutes, for the result + of scanning a path for git repositories. Default value: "15". + cache-size:: The maximum number of entries in the cgit cache. Default value: "0" (i.e. caching is disabled). @@ -132,7 +143,7 @@ local-time:: logo:: Url which specifies the source of an image which will be used as a logo - on all cgit pages. + on all cgit pages. Default value: "/cgit.png". logo-link:: Url loaded when clicking on the cgit logo image. If unspecified the @@ -189,8 +200,8 @@ renamelimit:: `man git-diff`). Default value: "-1". repo.group:: - A value for the current repository group, which all repositories - specified after this setting will inherit. Default value: none. + Legacy alias for 'section' which will be deprecated starting with + cgit-1.0. robots:: Text used as content for the "robots" meta-tag. Default value: @@ -209,15 +220,20 @@ root-title:: Text printed as heading on the repository index page. Default value: "Git Repository Browser". +scan-path:: + A path which will be scanned for repositories. If caching is enabled, + the result will be cached as a cgitrc include-file in the cache + directory. Default value: none. See also: cache-scanrc-ttl. + +section: + The name of the current repository section - all repositories defined + after this option will inherit the current section name. Default value: + none. + snapshots:: - Text which specifies the default (and allowed) set of snapshot formats - supported by cgit. The value is a space-separated list of zero or more - of the following values: - "tar" uncompressed tar-file - "tar.gz" gzip-compressed tar-file - "tar.bz2" bzip-compressed tar-file - "zip" zip-file - Default value: none. + Text which specifies the default set of snapshot formats generated by + cgit. The value is a space-separated list of zero or more of the + values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. source-filter:: Specifies a command which will be invoked to format plaintext blobs