Diff options
| -rw-r--r-- | MANUAL.txt | 33 |
1 file changed, 18 insertions, 15 deletions
@@ -30,7 +30,7 @@ about-filter:: set, a repository's readme is escaped and served as plain text. A bundled Lua filter, about-render.lua, renders markdown, man pages and plain text when about-filter points at it. Default value: none. See - also: "Filter API". + also: "Filter API", "repo.about-filter". age-file:: Specifies a path, relative to each repository path, which can be used to @@ -47,7 +47,7 @@ auth-filter:: branch-sort:: Flag which, when set to "age", enables date ordering in the branch ref list, and when set to "name" enables ordering by branch name. Default - value: "name". + value: "name". See also: "repo.branch-sort". cache-about-ttl:: Number which specifies the time-to-live, in minutes, for the cached @@ -124,13 +124,13 @@ commit-filter:: example to link a bug tracker. A ready filter linking object names and configurable text references ships as custom/extensions/link-commits.lua. Default value: none. See also: - "Filter API". + "Filter API", "repo.commit-filter". 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: - none. + none. See also: "repo.commit-sort". css:: Url which specifies the CSS document to include in all cgit pages. May @@ -159,7 +159,7 @@ email-filter:: places throughout the cgit interface. Ready filters adding a Gravatar or Libravatar icon ship as custom/extensions/email-gravatar.lua and custom/extensions/email-libravatar.lua. Default value: none. See also: - "Filter API". + "Filter API", "repo.email-filter". embedded:: Flag which, when set to "1", makes cgit generate an HTML fragment @@ -169,7 +169,7 @@ embedded:: enable-blame:: Flag which, when set to "1", lets cgit provide a "blame" page for files and makes it generate links to that page in appropriate places. Default - value: "0". + value: "0". See also: "repo.enable-blame". enable-cache-list:: Flag which, when set to "1", exposes the "ls_cache" page. That page @@ -179,7 +179,7 @@ enable-cache-list:: enable-commit-graph:: Flag which, when set to "1", makes cgit print an ASCII-art commit history graph to the left of the commit messages in the repository log - page. Default value: "0". + page. Default value: "0". See also: "repo.enable-commit-graph". enable-commit-trailers:: Flag which, when set to "1", makes the commit page split the trailer @@ -190,7 +190,7 @@ enable-commit-trailers:: enable-follow-links:: Flag which, when set to "1", allows users to follow a file in the log - page. Default value: "0". + page. Default value: "0". See also: "repo.enable-follow-links". enable-git-config:: Flag which, when set to "1", lets cgit read repository settings from git @@ -248,11 +248,12 @@ enable-index-owner:: enable-log-filecount:: Flag which, when set to "1", makes cgit print the number of modified files for each commit on the repository log page. Default value: "0". + See also: "repo.enable-log-filecount". enable-log-linecount:: Flag which, when set to "1", makes cgit print the number of added and removed lines for each commit on the repository log page. Default value: - "0". + "0". See also: "repo.enable-log-linecount". enable-mailmap:: Flag which, when set to "1", applies the repository's mailmap to every @@ -342,11 +343,11 @@ local-time:: logo:: Url which specifies the source of an image which will be used as a logo - on all cgit pages. Default value: "/cgit.png". + on all cgit pages. Default value: "/cgit.png". See also: "repo.logo". logo-link:: Url loaded when clicking on the cgit logo image. Default value: the url - of the repository index page. + of the repository index page. See also: "repo.logo-link". max-atom-items:: Specifies the number of items to display in the atom feed. Default @@ -425,7 +426,8 @@ module-link:: Text which will be used as the format string for a hyperlink when a submodule is printed in a directory listing. The arguments for the format string are the name of the submodule directory and the object id - of the submodule commit. Default value: none. + of the submodule commit. Default value: none. See also: + "repo.module-link". project-list:: A file listing the subdirectories of scan-path, relative to it, that @@ -504,7 +506,7 @@ scan-path:: section:: The name of the current repository section. All repositories defined after this option will inherit the current section name. Default value: - none. + none. See also: "repo.section". section-from-path:: A number which, if defined prior to scan-path, specifies how many path @@ -542,7 +544,8 @@ source-filter:: no source-filter is configured, cgit serves the text plain. A ready syntax highlighter using the Scintillua lexer collection ships as custom/extensions/syntax-highlight.lua, see the comments in that file - for its dependencies. Default value: none. See also: "Filter API". + for its dependencies. Default value: none. See also: "Filter API", + "repo.source-filter". strict-export:: Filename which, if specified, needs to be present within the repository @@ -573,7 +576,7 @@ trailer-filter:: remaining values go through the commit-filter. A ready filter linking Fixes, Reverts, Closes, Bug and URL values ships as custom/extensions/link-trailers.lua. Default value: none. See also: - "Filter API". + "Filter API", "repo.trailer-filter". trust-scan-config:: Flag which, when set to "1", honours every setting in a repository's own |