README: times, they are a-changin

[cgit.git] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index a22423bcaeb9ebce08f73e1c219707511635dea7..902fff3e6674115e708cfe2b3f917632468f0070 100644 (file)
--- 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".
 
        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: 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
 clone-prefix::
        Space-separated list of common prefixes which, when combined with a
        repository url, generates valid clone urls for the repository. This


@@ -106,11 +110,24 @@ enable-filter-overrides::
        Flag which, when set to "1", allows all filter settings to be
        overridden in repository-specific cgitrc files. Default value: none.
 
        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-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-gitweb-section::
+       If set to "1" and scan-path is enabled, we first check each repository
+       for the git config value "gitweb.category" to determine the repository's
+       section. This value is overridden if section-from-path is enabled.
+       Default value: "1". See also: scan-path section-from-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
 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


@@ -226,11 +243,22 @@ mimetype.<ext>::
        Set the mimetype for the specified filename extension. This is used
        by the `plain` command when returning blob content.
 
        Set the mimetype for the specified filename extension. This is used
        by the `plain` command when returning blob content.
 

+mimetype-file::
+       Specifies the file to use for automatic mimetype lookup. If specified
+       then this field is used as a fallback when no "mimetype.<ext>" 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.<ext>". 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
+

 module-link::
        Text which will be used as the formatstring for a hyperlink when a
        submodule is printed in a directory listing. The arguments for the
        formatstring are the path and SHA1 of the submodule commit. Default
 module-link::
        Text which will be used as the formatstring for a hyperlink when a
        submodule is printed in a directory listing. The arguments for the
        formatstring are the path and SHA1 of the submodule commit. Default

-       value: "./?repo=%s&page=commit&id=%s"
+       value: none.

 
 nocache::
        If set to the value "1" caching will be disabled. This settings is
 
 nocache::
        If set to the value "1" caching will be disabled. This settings is


@@ -309,11 +337,17 @@ section::
        after this option will inherit the current section name. Default value:
        none.
 
        after this option will inherit the current section name. Default value:
        none.
 

+section-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-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
 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
 
 side-by-side-diffs::
        If set to "1" shows side-by-side diffs instead of unidiffs per


@@ -377,7 +411,8 @@ repo.commit-filter::
 repo.defbranch::
        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
 repo.defbranch::
        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

-       as default instead. Default value: "master".
+       as default instead. Default value: branch pointed to by HEAD, or
+       "master" if there is no suitable HEAD.

 
 repo.desc::
        The value to show as repository description. Default value: none.
 
 repo.desc::
        The value to show as repository description. Default value: none.


@@ -417,6 +452,12 @@ repo.module-link::
        formatstring are the path and SHA1 of the submodule commit. Default
        value: <module-link>
 
        formatstring are the path and SHA1 of the submodule commit. Default
        value: <module-link>
 

+repo.module-link.<path>::
+       Text which will be used as the formatstring for a hyperlink when a
+       submodule with the specified subdirectory path is printed in a
+       directory listing. The only argument for the formatstring is the SHA1
+       of the submodule commit. Default value: none.
+

 repo.max-stats::
        Override the default maximum statistics period. Valid values are equal
        to the values specified for the global "max-stats" setting. Default
 repo.max-stats::
        Override the default maximum statistics period. Valid values are equal
        to the values specified for the global "max-stats" setting. Default