CGIT 0.8.3.2

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index e99c9f7b1f9765341419c17b621b98ebb5f8ca7b..0c1348563568a96e05edf6ed9f617eaaabe69cfa 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,3 +1,6 @@
+:man source:   cgit
+:man manual:   cgit
+
 CGITRC(5)
 ========
 
@@ -88,6 +91,10 @@ embedded::
        suitable for embedding in other html pages. Default value: none. See
        also: "noheader".
        
+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-index-links::
        Flag which, when set to "1", will make cgit generate extra links for
        each repo in the repository index (specifically, to the "summary",
@@ -103,6 +110,10 @@ enable-log-linecount::
        and removed lines for each commit on the repository log page. Default
        value: "0".
 
+enable-tree-linenumbers::
+       Flag which, when set to "1", will make cgit generate linenumber links
+       for plaintext blobs printed in the tree view. Default value: "1".
+
 favicon::
        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
@@ -200,8 +211,8 @@ renamelimit::
          `man git-diff`). Default value: "-1".
 
 repo.group::
-       Legacy alias for 'section' which will be deprecated starting with
-       cgit-1.0.
+       Legacy alias for "section". This option is deprecated and will not be
+       supported in cgit-1.0.
 
 robots::
        Text used as content for the "robots" meta-tag. Default value:
@@ -225,7 +236,7 @@ scan-path::
        the result will be cached as a cgitrc include-file in the cache
        directory. Default value: none. See also: cache-scanrc-ttl.
 
-section:
+section::
        The name of the current repository section - all repositories defined
        after this option will inherit the current section name. Default value:
        none.
@@ -266,14 +277,16 @@ virtual-root::
 REPOSITORY SETTINGS
 -------------------
 repo.about-filter::
-       Override the default about-filter. Default value: <about-filter>.
+       Override the default about-filter. Default value: none. See also:
+       "enable-filter-overrides".
 
 repo.clone-url::
        A list of space-separated urls which can be used to clone this repo.
        Default value: none.
 
 repo.commit-filter::
-       Override the default commit-filter. Default value: <commit-filter>.
+       Override the default commit-filter. Default value: none. See also:
+       "enable-filter-overrides".
 
 repo.defbranch::
        The name of the default branch for this repository. If no such branch
@@ -316,16 +329,31 @@ repo.snapshots::
        "snapshots" global setting. Default value: <snapshots>.
 
 repo.section::
-       Override the current section for this repository. Default value: none.
+       Override the current section name for this repository. Default value:
+       none.
 
 repo.source-filter::
-       Override the default source-filter. Default value: <source-filter>.
+       Override the default source-filter. Default value: none. See also:
+       "enable-filter-overrides".
 
 repo.url::
        The relative url used to access the repository. This must be the first
        setting specified for each repo. Default value: none.
 
 
+REPOSITORY-SPECIFIC CGITRC FILE
+-------------------------------
+When the option "scan-path" is used to auto-discover git repositories, cgit
+will try to parse the file "cgitrc" within any found repository. Such a
+repo-specific config file may contain any of the repo-specific options
+described above, except "repo.url" and "repo.path". Additionally, the "filter"
+options are only acknowledged in repo-specific config files when
+"enable-filter-overrides" is set to "1".
+
+Note: the "repo." prefix is dropped from the option names in repo-specific
+config files, e.g. "repo.desc" becomes "desc".
+
+
 EXAMPLE CGITRC FILE
 -------------------
 
@@ -396,8 +424,8 @@ mimetype.svg=image/svg+xml
 
 ##
 ## List of repositories.
-## PS: Any repositories listed when repo.group is unset will not be
-##     displayed under a group heading
+## PS: Any repositories listed when section is unset will not be
+##     displayed under a section heading
 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 ##      and included like this:
 ##        include=/etc/cgitrepos
@@ -419,7 +447,7 @@ repo.readme=info/web/about.html
 
 
 # The next repositories will be displayed under the 'extras' heading
-repo.group=extras
+section=extras
 
 
 repo.url=baz
@@ -432,7 +460,7 @@ repo.desc=the wizard of foo
 
 
 # Add some mirrored repositories
-repo.group=mirrors
+section=mirrors
 
 
 repo.url=git