]> gitweb.ps.run Git - ps-cgit/blobdiff - cgitrc.5.txt
cache.c: cache ls_cache output properly
[ps-cgit] / cgitrc.5.txt
index 95a104955424ef2113e1ebea4747814f2698064e..9b803b372ad97832b245f0e1b8adf78ac8d1d388 100644 (file)
@@ -40,6 +40,11 @@ agefile::
        function in libgit. Recommended timestamp-format is "yyyy-mm-dd
        hh:mm:ss". Default value: "info/web/last-modified".
 
+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".
+
 cache-root::
        Path used to store the cgit cache entries. Default value:
        "/var/cache/cgit". See also: "MACRO EXPANSION".
@@ -92,6 +97,12 @@ commit-filter::
        be used to implement bugtracker integration. Default value: none.
        See also: "FILTER API".
 
+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: unset.
+
 css::
        Url which specifies the css document to include in all cgit pages.
        Default value: "/cgit.css".
@@ -120,6 +131,10 @@ enable-index-links::
        each repo in the repository index (specifically, to the "summary",
        "commit" and "tree" pages). Default value: "0".
 
+enable-index-owner::
+       Flag which, when set to "1", will make cgit display the owner of
+       each repo in the repository index. Default value: "1".
+
 enable-log-filecount::
        Flag which, when set to "1", will make cgit print the number of
        modified files for each commit on the repository log page. Default
@@ -148,11 +163,12 @@ enable-tree-linenumbers::
 enable-git-config::
        Flag which, when set to "1", will allow cgit to use git config to set
        any repo specific settings. This option is used in conjunction with
-       "scan-path" to augment repo-specific settings. The keys gitweb.owner,
-       gitweb.category, and gitweb.description will map to the cgit keys
-       repo.owner, repo.section, and repo.desc, respectivly. All git config
-       keys that begin with "cgit." will be mapped to the corresponding "repo."
-       key in cgit. Default value: "0". See also: scan-path, section-from-path.
+       "scan-path", and must be defined prior, to augment repo-specific
+       settings. The keys gitweb.owner, gitweb.category, and gitweb.description
+       will map to the cgit keys repo.owner, repo.section, and repo.desc,
+       respectivly. All git config keys that begin with "cgit." will be mapped
+       to the corresponding "repo." key in cgit. Default value: "0". See also:
+       scan-path, section-from-path.
 
 favicon::
        Url used as link to a shortcut icon for cgit. If specified, it is
@@ -192,12 +208,6 @@ local-time::
        Flag which, if set to "1", makes cgit print commit and tag times in the
        servers timezone. Default value: "0".
 
-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: unset.
-
 logo::
        Url which specifies the source of an image which will be used as a logo
        on all cgit pages. Default value: "/cgit.png".
@@ -244,8 +254,8 @@ 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:
+       to use on a Linux system is /etc/mime.types. 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
@@ -284,7 +294,8 @@ readme::
 remove-suffix::
        If set to "1" and scan-path is enabled, if any repositories are found
        with a suffix of ".git", this suffix will be removed for the url and
-       name. Default value: "0". See also: scan-path.
+       name. This must be defined prior to scan-path. Default value: "0".
+       See also: scan-path.
 
 renamelimit::
        Maximum number of files to consider when detecting renames. The value
@@ -295,6 +306,12 @@ repo.group::
        Legacy alias for "section". This option is deprecated and will not be
        supported in cgit-1.0.
 
+repository-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-sort.
+
 robots::
        Text used as content for the "robots" meta-tag. Default value:
        "index, nofollow".
@@ -335,12 +352,6 @@ section::
        after this option will inherit the current section name. Default value:
        none.
 
-repository-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-sort.
-
 section-sort::
        Flag which, when set to "1", will sort the sections on the repository
        listing by name. Set this flag to "0" if the order in the cgitrc file should
@@ -348,7 +359,7 @@ section-sort::
        case-sensitive-sort, repository-sort.
 
 section-from-path::
-       A number which, if specified before scan-path, specifies how many
+       A number which, if defined prior to 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".
@@ -387,8 +398,8 @@ strict-export::
        Filename which, if specified, needs to be present within the repository
        for cgit to allow access to that repository. This can be used to emulate
        gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
-       repositories to match those exported by git-daemon. This option MUST come
-       before 'scan-path'.
+       repositories to match those exported by git-daemon. This option must
+       be defined prior to scan-path.
 
 virtual-root::
        Url which, if specified, will be used as root for all cgit links. It
@@ -405,6 +416,11 @@ repo.about-filter::
        Override the default about-filter. Default value: none. See also:
        "enable-filter-overrides". See also: "FILTER API".
 
+repo.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".
+
 repo.clone-url::
        A list of space-separated urls which can be used to clone this repo.
        Default value: none. See also: "MACRO EXPANSION".
@@ -413,6 +429,12 @@ repo.commit-filter::
        Override the default commit-filter. Default value: none. See also:
        "enable-filter-overrides". See also: "FILTER API".
 
+repo.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: unset.
+
 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
@@ -442,12 +464,6 @@ repo.enable-subject-links::
        A flag which can be used to override the global setting
        `enable-subject-links'. Default value: none.
 
-repo.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: unset.
-
 repo.logo::
        Url which specifies the source of an image which will be used as a logo
        on this repo's pages. Default value: global logo.