X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/b56be4ba3a942dd1978fe4bfecd9afc35aab0027..bafab423f20bc1448b293842c235965e1681f07e:/cgitrc.5.txt diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 86a19a9..4d27d9f 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -70,6 +70,10 @@ cache-static-ttl:: version of repository pages accessed with a fixed SHA1. Default value: "5". +case-sensitive-sort:: + Sort items in the repo list case sensitively. Default value: "1". + See also: repository-sort, section-sort. + clone-prefix:: Space-separated list of common prefixes which, when combined with a repository url, generates valid clone urls for the repository. This @@ -106,18 +110,6 @@ 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-gitweb-desc:: - If set to "1" and scan-path is enabled, we first check each repository - for the git config value "gitweb.description" to determine the owner. - Otherwise, the description is read from a file titled "description" - inside of the repository directory. - Default value: "1". See also: scan-path. - -enable-gitweb-owner:: - If set to "1" and scan-path is enabled, we first check each repository - for the git config value "gitweb.owner" to determine the owner. - Default value: "1". See also: scan-path. - enable-http-clone:: If set to "1", cgit will act as an dumb HTTP endpoint for git clones. If you use an alternate way of serving git repositories, you may wish @@ -128,6 +120,10 @@ enable-index-links:: each repo in the repository index (specifically, to the "summary", "commit" and "tree" pages). Default value: "0". +enable-index-owner:: + Flag which, when set to "1", will make cgit display the owner of + each repo in the repository index. Default value: "1". + enable-log-filecount:: Flag which, when set to "1", will make cgit print the number of modified files for each commit on the repository log page. Default @@ -153,6 +149,15 @@ 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". +enable-git-config:: + Flag which, when set to "1", will allow cgit to use git config to set + any repo specific settings. This option is used in conjunction with + "scan-path" to augment repo-specific settings. The keys gitweb.owner, + gitweb.category, and gitweb.description will map to the cgit keys + repo.owner, repo.section, and repo.desc, respectivly. All git config + keys that begin with "cgit." will be mapped to the corresponding "repo." + key in cgit. Default value: "0". See also: scan-path, section-from-path. + 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 @@ -191,6 +196,12 @@ local-time:: Flag which, if set to "1", makes cgit print commit and tag times in the servers timezone. Default value: "0". +commit-sort:: + Flag which, when set to "date", enables strict date ordering in the + commit log, and when set to "topo" enables strict topological + ordering. If unset, the default ordering of "git log" is used. Default + value: unset. + logo:: Url which specifies the source of an image which will be used as a logo on all cgit pages. Default value: "/cgit.png". @@ -237,12 +248,13 @@ mimetype-file:: Specifies the file to use for automatic mimetype lookup. If specified then this field is used as a fallback when no "mimetype." match is found. If unspecified then no such lookup is performed. The typical file - to use on a Linux system is /etc/mime.types. Default value: none. See - also: "mimetype.". The format of the file must comply to: + to use on a Linux system is /etc/mime.types. The format of the file must + comply to: - a comment line is an empty line or a line starting with a hash (#), optionally preceded by whitespace - a non-comment line starts with the mimetype (like image/png), followed by one or more file extensions (like jpg), all separated by whitespace + Default value: none. See also: "mimetype.". module-link:: Text which will be used as the formatstring for a hyperlink when a @@ -327,11 +339,23 @@ section:: after this option will inherit the current section name. Default value: none. +repository-sort:: + The way in which repositories in each section are sorted. Valid values + are "name" for sorting by the repo name or "age" for sorting by the + most recently updated repository. Default value: "name". See also: + section, case-sensitive-sort, section-sort. + +section-sort:: + Flag which, when set to "1", will sort the sections on the repository + listing by name. Set this flag to "0" if the order in the cgitrc file should + be preserved. Default value: "1". See also: section, + case-sensitive-sort, repository-sort. + section-from-path:: A number which, if specified before scan-path, specifies how many path elements from each repo path to use as a default section name. If negative, cgit will discard the specified number of path elements - above the repo directory. Default value: 0. + above the repo directory. Default value: "0". side-by-side-diffs:: If set to "1" shows side-by-side diffs instead of unidiffs per @@ -378,6 +402,7 @@ virtual-root:: NOTE: cgit has recently learned how to use PATH_INFO to achieve the same kind of virtual urls, so this option will probably be deprecated. + REPOSITORY SETTINGS ------------------- repo.about-filter:: @@ -421,6 +446,12 @@ repo.enable-subject-links:: A flag which can be used to override the global setting `enable-subject-links'. Default value: none. +repo.commit-sort:: + Flag which, when set to "date", enables strict date ordering in the + commit log, and when set to "topo" enables strict topological + ordering. If unset, the default ordering of "git log" is used. Default + value: unset. + repo.logo:: Url which specifies the source of an image which will be used as a logo on this repo's pages. Default value: global logo.