mirror of
https://git.zx2c4.com/cgit
synced 2024-11-22 16:38:42 +00:00
cgitrc.5.txt: make the cgitrc options a valid asciidoc labeled list
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
This commit is contained in:
parent
9f9ede3d92
commit
d3b2933cfe
102
cgitrc.5.txt
102
cgitrc.5.txt
@ -16,166 +16,166 @@ lines, and lines starting with '#', are ignored.
|
|||||||
|
|
||||||
GLOBAL SETTINGS
|
GLOBAL SETTINGS
|
||||||
---------------
|
---------------
|
||||||
agefile
|
agefile::
|
||||||
Specifies a path, relative to each repository path, which can be used
|
Specifies a path, relative to each repository path, which can be used
|
||||||
to specify the date and time of the youngest commit in the repository.
|
to specify the date and time of the youngest commit in the repository.
|
||||||
The first line in the file is used as input to the "parse_date"
|
The first line in the file is used as input to the "parse_date"
|
||||||
function in libgit. Recommended timestamp-format is "yyyy-mm-dd
|
function in libgit. Recommended timestamp-format is "yyyy-mm-dd
|
||||||
hh:mm:ss". Default value: "info/web/last-modified".
|
hh:mm:ss". Default value: "info/web/last-modified".
|
||||||
|
|
||||||
cache-root
|
cache-root::
|
||||||
Path used to store the cgit cache entries. Default value:
|
Path used to store the cgit cache entries. Default value:
|
||||||
"/var/cache/cgit".
|
"/var/cache/cgit".
|
||||||
|
|
||||||
cache-dynamic-ttl
|
cache-dynamic-ttl::
|
||||||
Number which specifies the time-to-live, in minutes, for the cached
|
Number which specifies the time-to-live, in minutes, for the cached
|
||||||
version of repository pages accessed without a fixed SHA1. Default
|
version of repository pages accessed without a fixed SHA1. Default
|
||||||
value: "5".
|
value: "5".
|
||||||
|
|
||||||
cache-repo-ttl
|
cache-repo-ttl::
|
||||||
Number which specifies the time-to-live, in minutes, for the cached
|
Number which specifies the time-to-live, in minutes, for the cached
|
||||||
version of the repository summary page. Default value: "5".
|
version of the repository summary page. Default value: "5".
|
||||||
|
|
||||||
cache-root-ttl
|
cache-root-ttl::
|
||||||
Number which specifies the time-to-live, in minutes, for the cached
|
Number which specifies the time-to-live, in minutes, for the cached
|
||||||
version of the repository index page. Default value: "5".
|
version of the repository index page. Default value: "5".
|
||||||
|
|
||||||
cache-size
|
cache-size::
|
||||||
The maximum number of entries in the cgit cache. Default value: "0"
|
The maximum number of entries in the cgit cache. Default value: "0"
|
||||||
(i.e. caching is disabled).
|
(i.e. caching is disabled).
|
||||||
|
|
||||||
cache-static-ttl
|
cache-static-ttl::
|
||||||
Number which specifies the time-to-live, in minutes, for the cached
|
Number which specifies the time-to-live, in minutes, for the cached
|
||||||
version of repository pages accessed with a fixed SHA1. Default value:
|
version of repository pages accessed with a fixed SHA1. Default value:
|
||||||
"5".
|
"5".
|
||||||
|
|
||||||
clone-prefix
|
clone-prefix::
|
||||||
Space-separated list of common prefixes which, when combined with a
|
Space-separated list of common prefixes which, when combined with a
|
||||||
repository url, generates valid clone urls for the repository. This
|
repository url, generates valid clone urls for the repository. This
|
||||||
setting is only used if `repo.clone-url` is unspecified. Default value:
|
setting is only used if `repo.clone-url` is unspecified. Default value:
|
||||||
none.
|
none.
|
||||||
|
|
||||||
css
|
css::
|
||||||
Url which specifies the css document to include in all cgit pages.
|
Url which specifies the css document to include in all cgit pages.
|
||||||
Default value: "/cgit.css".
|
Default value: "/cgit.css".
|
||||||
|
|
||||||
enable-index-links
|
enable-index-links::
|
||||||
Flag which, when set to "1", will make cgit generate extra links for
|
Flag which, when set to "1", will make cgit generate extra links for
|
||||||
each repo in the repository index (specifically, to the "summary",
|
each repo in the repository index (specifically, to the "summary",
|
||||||
"commit" and "tree" pages). Default value: "0".
|
"commit" and "tree" pages). Default value: "0".
|
||||||
|
|
||||||
enable-log-filecount
|
enable-log-filecount::
|
||||||
Flag which, when set to "1", will make cgit print the number of
|
Flag which, when set to "1", will make cgit print the number of
|
||||||
modified files for each commit on the repository log page. Default
|
modified files for each commit on the repository log page. Default
|
||||||
value: "0".
|
value: "0".
|
||||||
|
|
||||||
enable-log-linecount
|
enable-log-linecount::
|
||||||
Flag which, when set to "1", will make cgit print the number of added
|
Flag which, when set to "1", will make cgit print the number of added
|
||||||
and removed lines for each commit on the repository log page. Default
|
and removed lines for each commit on the repository log page. Default
|
||||||
value: "0".
|
value: "0".
|
||||||
|
|
||||||
favicon
|
favicon::
|
||||||
Url used as link to a shortcut icon for cgit. If specified, it is
|
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
|
suggested to use the value "/favicon.ico" since certain browsers will
|
||||||
ignore other values. Default value: none.
|
ignore other values. Default value: none.
|
||||||
|
|
||||||
footer
|
footer::
|
||||||
The content of the file specified with this option will be included
|
The content of the file specified with this option will be included
|
||||||
verbatim at the bottom of all pages (i.e. it replaces the standard
|
verbatim at the bottom of all pages (i.e. it replaces the standard
|
||||||
"generated by..." message. Default value: none.
|
"generated by..." message. Default value: none.
|
||||||
|
|
||||||
header
|
header::
|
||||||
The content of the file specified with this option will be included
|
The content of the file specified with this option will be included
|
||||||
verbatim at the top of all pages. Default value: none.
|
verbatim at the top of all pages. Default value: none.
|
||||||
|
|
||||||
include
|
include::
|
||||||
Name of a configfile to include before the rest of the current config-
|
Name of a configfile to include before the rest of the current config-
|
||||||
file is parsed. Default value: none.
|
file is parsed. Default value: none.
|
||||||
|
|
||||||
index-header
|
index-header::
|
||||||
The content of the file specified with this option will be included
|
The content of the file specified with this option will be included
|
||||||
verbatim above the repository index. This setting is deprecated, and
|
verbatim above the repository index. This setting is deprecated, and
|
||||||
will not be supported by cgit-1.0 (use root-readme instead). Default
|
will not be supported by cgit-1.0 (use root-readme instead). Default
|
||||||
value: none.
|
value: none.
|
||||||
|
|
||||||
index-info
|
index-info::
|
||||||
The content of the file specified with this option will be included
|
The content of the file specified with this option will be included
|
||||||
verbatim below the heading on the repository index page. This setting
|
verbatim below the heading on the repository index page. This setting
|
||||||
is deprecated, and will not be supported by cgit-1.0 (use root-desc
|
is deprecated, and will not be supported by cgit-1.0 (use root-desc
|
||||||
instead). Default value: none.
|
instead). Default value: none.
|
||||||
|
|
||||||
local-time
|
local-time::
|
||||||
Flag which, if set to "1", makes cgit print commit and tag times in the
|
Flag which, if set to "1", makes cgit print commit and tag times in the
|
||||||
servers timezone. Default value: "0".
|
servers timezone. Default value: "0".
|
||||||
|
|
||||||
logo
|
logo::
|
||||||
Url which specifies the source of an image which will be used as a logo
|
Url which specifies the source of an image which will be used as a logo
|
||||||
on all cgit pages.
|
on all cgit pages.
|
||||||
|
|
||||||
logo-link
|
logo-link::
|
||||||
Url loaded when clicking on the cgit logo image. If unspecified the
|
Url loaded when clicking on the cgit logo image. If unspecified the
|
||||||
calculated url of the repository index page will be used. Default
|
calculated url of the repository index page will be used. Default
|
||||||
value: none.
|
value: none.
|
||||||
|
|
||||||
max-commit-count
|
max-commit-count::
|
||||||
Specifies the number of entries to list per page in "log" view. Default
|
Specifies the number of entries to list per page in "log" view. Default
|
||||||
value: "50".
|
value: "50".
|
||||||
|
|
||||||
max-message-length
|
max-message-length::
|
||||||
Specifies the maximum number of commit message characters to display in
|
Specifies the maximum number of commit message characters to display in
|
||||||
"log" view. Default value: "80".
|
"log" view. Default value: "80".
|
||||||
|
|
||||||
max-repo-count
|
max-repo-count::
|
||||||
Specifies the number of entries to list per page on the repository
|
Specifies the number of entries to list per page on the repository
|
||||||
index page. Default value: "50".
|
index page. Default value: "50".
|
||||||
|
|
||||||
max-repodesc-length
|
max-repodesc-length::
|
||||||
Specifies the maximum number of repo description characters to display
|
Specifies the maximum number of repo description characters to display
|
||||||
on the repository index page. Default value: "80".
|
on the repository index page. Default value: "80".
|
||||||
|
|
||||||
max-stats
|
max-stats::
|
||||||
Set the default maximum statistics period. Valid values are "week",
|
Set the default maximum statistics period. Valid values are "week",
|
||||||
"month", "quarter" and "year". If unspecified, statistics are
|
"month", "quarter" and "year". If unspecified, statistics are
|
||||||
disabled. Default value: none. See also: "repo.max-stats".
|
disabled. Default value: none. See also: "repo.max-stats".
|
||||||
|
|
||||||
module-link
|
module-link::
|
||||||
Text which will be used as the formatstring for a hyperlink when a
|
Text which will be used as the formatstring for a hyperlink when a
|
||||||
submodule is printed in a directory listing. The arguments for the
|
submodule is printed in a directory listing. The arguments for the
|
||||||
formatstring are the path and SHA1 of the submodule commit. Default
|
formatstring are the path and SHA1 of the submodule commit. Default
|
||||||
value: "./?repo=%s&page=commit&id=%s"
|
value: "./?repo=%s&page=commit&id=%s"
|
||||||
|
|
||||||
nocache
|
nocache::
|
||||||
If set to the value "1" caching will be disabled. This settings is
|
If set to the value "1" caching will be disabled. This settings is
|
||||||
deprecated, and will not be honored starting with cgit-1.0. Default
|
deprecated, and will not be honored starting with cgit-1.0. Default
|
||||||
value: "0".
|
value: "0".
|
||||||
|
|
||||||
renamelimit
|
renamelimit::
|
||||||
Maximum number of files to consider when detecting renames. The value
|
Maximum number of files to consider when detecting renames. The value
|
||||||
"-1" uses the compiletime value in git (for further info, look at
|
"-1" uses the compiletime value in git (for further info, look at
|
||||||
`man git-diff`). Default value: "-1".
|
`man git-diff`). Default value: "-1".
|
||||||
|
|
||||||
repo.group
|
repo.group::
|
||||||
A value for the current repository group, which all repositories
|
A value for the current repository group, which all repositories
|
||||||
specified after this setting will inherit. Default value: none.
|
specified after this setting will inherit. Default value: none.
|
||||||
|
|
||||||
robots
|
robots::
|
||||||
Text used as content for the "robots" meta-tag. Default value:
|
Text used as content for the "robots" meta-tag. Default value:
|
||||||
"index, nofollow".
|
"index, nofollow".
|
||||||
|
|
||||||
root-desc
|
root-desc::
|
||||||
Text printed below the heading on the repository index page. Default
|
Text printed below the heading on the repository index page. Default
|
||||||
value: "a fast webinterface for the git dscm".
|
value: "a fast webinterface for the git dscm".
|
||||||
|
|
||||||
root-readme:
|
root-readme::
|
||||||
The content of the file specified with this option will be included
|
The content of the file specified with this option will be included
|
||||||
verbatim below the "about" link on the repository index page. Default
|
verbatim below the "about" link on the repository index page. Default
|
||||||
value: none.
|
value: none.
|
||||||
|
|
||||||
root-title
|
root-title::
|
||||||
Text printed as heading on the repository index page. Default value:
|
Text printed as heading on the repository index page. Default value:
|
||||||
"Git Repository Browser".
|
"Git Repository Browser".
|
||||||
|
|
||||||
snapshots
|
snapshots::
|
||||||
Text which specifies the default (and allowed) set of snapshot formats
|
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
|
supported by cgit. The value is a space-separated list of zero or more
|
||||||
of the following values:
|
of the following values:
|
||||||
@ -185,19 +185,19 @@ snapshots
|
|||||||
"zip" zip-file
|
"zip" zip-file
|
||||||
Default value: none.
|
Default value: none.
|
||||||
|
|
||||||
summary-branches
|
summary-branches::
|
||||||
Specifies the number of branches to display in the repository "summary"
|
Specifies the number of branches to display in the repository "summary"
|
||||||
view. Default value: "10".
|
view. Default value: "10".
|
||||||
|
|
||||||
summary-log
|
summary-log::
|
||||||
Specifies the number of log entries to display in the repository
|
Specifies the number of log entries to display in the repository
|
||||||
"summary" view. Default value: "10".
|
"summary" view. Default value: "10".
|
||||||
|
|
||||||
summary-tags
|
summary-tags::
|
||||||
Specifies the number of tags to display in the repository "summary"
|
Specifies the number of tags to display in the repository "summary"
|
||||||
view. Default value: "10".
|
view. Default value: "10".
|
||||||
|
|
||||||
virtual-root
|
virtual-root::
|
||||||
Url which, if specified, will be used as root for all cgit links. It
|
Url which, if specified, will be used as root for all cgit links. It
|
||||||
will also cause cgit to generate 'virtual urls', i.e. urls like
|
will also cause cgit to generate 'virtual urls', i.e. urls like
|
||||||
'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
|
'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
|
||||||
@ -207,51 +207,51 @@ virtual-root
|
|||||||
|
|
||||||
REPOSITORY SETTINGS
|
REPOSITORY SETTINGS
|
||||||
-------------------
|
-------------------
|
||||||
repo.clone-url
|
repo.clone-url::
|
||||||
A list of space-separated urls which can be used to clone this repo.
|
A list of space-separated urls which can be used to clone this repo.
|
||||||
Default value: none.
|
Default value: none.
|
||||||
|
|
||||||
repo.defbranch
|
repo.defbranch::
|
||||||
The name of the default branch for this repository. If no such branch
|
The name of the default branch for this repository. If no such branch
|
||||||
exists in the repository, the first branch name (when sorted) is used
|
exists in the repository, the first branch name (when sorted) is used
|
||||||
as default instead. Default value: "master".
|
as default instead. Default value: "master".
|
||||||
|
|
||||||
repo.desc
|
repo.desc::
|
||||||
The value to show as repository description. Default value: none.
|
The value to show as repository description. Default value: none.
|
||||||
|
|
||||||
repo.enable-log-filecount
|
repo.enable-log-filecount::
|
||||||
A flag which can be used to disable the global setting
|
A flag which can be used to disable the global setting
|
||||||
`enable-log-filecount'. Default value: none.
|
`enable-log-filecount'. Default value: none.
|
||||||
|
|
||||||
repo.enable-log-linecount
|
repo.enable-log-linecount::
|
||||||
A flag which can be used to disable the global setting
|
A flag which can be used to disable the global setting
|
||||||
`enable-log-linecount'. Default value: none.
|
`enable-log-linecount'. Default value: none.
|
||||||
|
|
||||||
repo.max-stats
|
repo.max-stats::
|
||||||
Override the default maximum statistics period. Valid values are equal
|
Override the default maximum statistics period. Valid values are equal
|
||||||
to the values specified for the global "max-stats" setting. Default
|
to the values specified for the global "max-stats" setting. Default
|
||||||
value: none.
|
value: none.
|
||||||
|
|
||||||
repo.name
|
repo.name::
|
||||||
The value to show as repository name. Default value: <repo.url>.
|
The value to show as repository name. Default value: <repo.url>.
|
||||||
|
|
||||||
repo.owner
|
repo.owner::
|
||||||
A value used to identify the owner of the repository. Default value:
|
A value used to identify the owner of the repository. Default value:
|
||||||
none.
|
none.
|
||||||
|
|
||||||
repo.path
|
repo.path::
|
||||||
An absolute path to the repository directory. For non-bare repositories
|
An absolute path to the repository directory. For non-bare repositories
|
||||||
this is the .git-directory. Default value: none.
|
this is the .git-directory. Default value: none.
|
||||||
|
|
||||||
repo.readme
|
repo.readme::
|
||||||
A path (relative to <repo.path>) which specifies a file to include
|
A path (relative to <repo.path>) which specifies a file to include
|
||||||
verbatim as the "About" page for this repo. Default value: none.
|
verbatim as the "About" page for this repo. Default value: none.
|
||||||
|
|
||||||
repo.snapshots
|
repo.snapshots::
|
||||||
A mask of allowed snapshot-formats for this repo, restricted by the
|
A mask of allowed snapshot-formats for this repo, restricted by the
|
||||||
"snapshots" global setting. Default value: <snapshots>.
|
"snapshots" global setting. Default value: <snapshots>.
|
||||||
|
|
||||||
repo.url
|
repo.url::
|
||||||
The relative url used to access the repository. This must be the first
|
The relative url used to access the repository. This must be the first
|
||||||
setting specified for each repo. Default value: none.
|
setting specified for each repo. Default value: none.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user