Diff options
Diffstat (limited to 'MANUAL.txt')
| -rw-r--r-- | MANUAL.txt | 82 |
1 file changed, 41 insertions, 41 deletions
@@ -43,24 +43,24 @@ branch-sort:: cache-about-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of the repository about page. See also: "The cache". Default - value: "15". + version of the repository about page. Default value: "15". See also: + "The cache". cache-dynamic-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of repository pages accessed without a fixed object id. See - also: "The cache". Default value: "5". + version of repository pages accessed without a fixed object id. Default + value: "5". See also: "The cache". cache-index-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of the repository index page. See also: "The cache". Default - value: "5". + version of the repository index page. Default value: "5". See also: "The + cache". cache-max-slot-size:: Number which specifies the largest response, in kilobytes, that a cache slot may keep. A larger response is still served but not kept, so one archive cannot take a slot's worth of disk. Set to "0" to remove the - limit. See also: "The cache". Default value: "65536" (64 MB). + limit. Default value: "65536" (64 MB). See also: "The cache". cache-root:: Path used to store the cgit cache entries. Default value: @@ -69,28 +69,28 @@ cache-root:: cache-scan-ttl:: Number which specifies the time-to-live, in minutes, for the result of - scanning a path for git repositories. See also: "The cache". Default - value: "15". + scanning a path for git repositories. Default value: "15". See also: + "The cache". cache-size:: The maximum number of entries in the cgit cache. When set to "0", - caching is disabled. See also: "The cache". Default value: "0". + caching is disabled. Default value: "0". See also: "The cache". cache-snapshot-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of snapshots. A snapshot requested with a fixed object id uses - "cache-static-ttl" instead, since its content can never change. See - also: "The cache". Default value: "5". + "cache-static-ttl" instead, since its content can never change. Default + value: "5". See also: "The cache". cache-static-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of repository pages accessed with a fixed object id. See also: - "The cache". Default value: "-1". + version of repository pages accessed with a fixed object id. Default + value: "-1". See also: "The cache". cache-summary-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of the repository summary page. See also: "The cache". Default - value: "5". + version of the repository summary page. Default value: "5". See also: + "The cache". case-sensitive-sort:: Sort items in the repository list case sensitively. Default value: "1". @@ -121,11 +121,11 @@ commit-sort:: none. css:: - Url which specifies the css document to include in all cgit pages. - Default value: "/cgit.css". May be given multiple times, each css URL - path is added in the head section of the document in turn. Setting this - to an empty string will disable generation of the link to this file in - the head section. + Url which specifies the css document to include in all cgit pages. May + be given multiple times, and each css URL path is added in the head + section of the document in turn. Setting this to an empty string will + disable generation of the link to this file in the head section. Default + value: "/cgit.css". date-format:: Format used for the calendar dates in the age columns of the log, refs @@ -317,12 +317,11 @@ include:: js:: Url which specifies the javascript script document to include in all - cgit pages. Default value: "/cgit.js". May be given multiple times, each - script URL path is added in the head section of the document in turn. - Each is loaded with defer, so it runs once the page has been parsed, - still in the order given. - Setting this to an empty string will disable generation of the link to - this file in the head section. + cgit pages. May be given multiple times, and each script URL path is + added in the head section of the document in turn. Each is loaded with + defer, so it runs once the page has been parsed, still in the order + given. Setting this to an empty string will disable generation of the + link to this file in the head section. Default value: "/cgit.js". local-time:: Flag which, if set to "1", makes cgit print commit and tag times in the @@ -344,7 +343,7 @@ max-blob-size:: Specifies the maximum size in KBytes of a blob that cgit will read into memory to serve. It caps both the HTML blob page and the raw "plain" and "blob" output, and a larger object is refused rather than loaded whole. - Default value: "10240" (10 MB). Set to "0" to disable the limit. + Set to "0" to disable the limit. Default value: "10240" (10 MB). max-commit-count:: Specifies the number of entries to list per page in "log" page. Default @@ -353,14 +352,14 @@ max-commit-count:: max-diff-files:: If a commit changes more files than this, the "commit" and "diff" pages show only the diffstat, where each file links to its own diff page. The - "rawdiff" and "patch" pages are never limited. Default value: "200". Set - to "0" to always render every file inline. + "rawdiff" and "patch" pages are never limited. Set to "0" to always + render every file inline. Default value: "200". max-diff-lines:: If a single file's diff spans more lines than this, the whole-commit pages print a note in its place linking to the file's own diff page, - which always renders in full. Default value: "1000". Set to "0" to - always render oversized files inline. + which always renders in full. Set to "0" to always render oversized + files inline. Default value: "1000". max-message-length:: Specifies the maximum number of commit message characters to display in @@ -369,13 +368,13 @@ max-message-length:: max-patch-count:: Specifies the maximum number of commits emitted as a series by the "patch" page when an explicit revision range is requested. A single - commit is unaffected. Default value: "50". Set to "0" for no limit. + commit is unaffected. Set to "0" for no limit. Default value: "50". max-ref-count:: Specifies the number of branches and tags to list per section on the "refs" page, and per page on the dedicated branch and tag pages that its - overflow links lead to. Default value: "200". A value of "0" or less lists - every ref on one page. + overflow links lead to. A value of "0" or less lists every ref on one + page. Default value: "200". max-repo-count:: Specifies the number of entries to list per page on the repository index @@ -507,10 +506,11 @@ snapshots:: Text which specifies the default set of snapshot formats that cgit generates links for. The value is a space-separated list of zero or more of the values "tar", "tar.gz", "tar.bz2", "tar.lz", "tar.xz", "tar.zst" - and "zip". The special value "all" enables all snapshot formats. Default - value: none. All compressors use default settings. Some settings can be - influenced with environment variables, for example set ZSTD_CLEVEL=10 in - web server environment for higher (but slower) zstd compression. + and "zip". The special value "all" enables all snapshot formats. All + compressors use default settings. Some settings can be influenced with + environment variables, for example set ZSTD_CLEVEL=10 in the web server + environment for higher (but slower) zstd compression. Default value: + none. source-filter:: Specifies a command which will be invoked to format plaintext blobs in @@ -529,7 +529,7 @@ strict-export:: summary-branches:: Specifies the number of branches to display in the repository "summary" - page. Default value: "10". A value of "0" or less lists every branch. + page. A value of "0" or less lists every branch. Default value: "10". summary-log:: Specifies the number of log entries to display in the repository @@ -537,7 +537,7 @@ summary-log:: summary-tags:: Specifies the number of tags to display in the repository "summary" - page. Default value: "10". A value of "0" or less lists every tag. + page. A value of "0" or less lists every tag. Default value: "10". trailer-filter:: Specifies a command which will be invoked to format the value of a |