scan-tree: Support gitweb.description.

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 4721c1e01335e10bd0fff7060b8281796a7ea557..86a19a93ccf6b80fc0ebbb49e842e55d780b7531 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -106,6 +106,13 @@ 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.
@@ -226,11 +233,22 @@ mimetype.<ext>::
        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
-       value: "./?repo=%s&page=commit&id=%s"
+       value: none.
 
 nocache::
        If set to the value "1" caching will be disabled. This settings is
@@ -377,7 +395,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
-       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.
@@ -417,6 +436,12 @@ repo.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
@@ -500,7 +525,7 @@ Also, all filters are handed the following environment variables:
 
 If a setting is not defined for a repository and the corresponding global
 setting is also not defined (if applicable), then the corresponding
-environment variable will be an empty string.
+environment variable will be unset.
 
 
 MACRO EXPANSION