Merge branch 'stable'

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 3b16db96c0c2808d2a7d291c76defcf9142f5a3b..c643fae9f99497306a6ddbafc8fbed68d5a71cf2 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,3 +1,6 @@
+:man source:   cgit
+:man manual:   cgit
+

 CGITRC(5)
 ========
 
 CGITRC(5)
 ========
 


@@ -54,6 +57,10 @@ cache-root-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
        version of the repository index page. Default value: "5".
 
        Number which specifies the time-to-live, in minutes, for the cached
        version of the repository index page. Default value: "5".
 

+cache-scanrc-ttl::
+       Number which specifies the time-to-live, in minutes, for the result
+       of scanning a path for git repositories. Default value: "15".
+

 cache-size::
        The maximum number of entries in the cgit cache. Default value: "0"
        (i.e. caching is disabled).
 cache-size::
        The maximum number of entries in the cgit cache. Default value: "0"
        (i.e. caching is disabled).


@@ -84,6 +91,15 @@ embedded::
        suitable for embedding in other html pages. Default value: none. See
        also: "noheader".
        
        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-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-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",
 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",


@@ -99,6 +115,17 @@ enable-log-linecount::
        and removed lines for each commit on the repository log page. Default
        value: "0".
 
        and removed lines for each commit on the repository log page. Default
        value: "0".
 

+enable-remote-branches::
+       Flag which, when set to "1", will make cgit display remote branches
+       in the summary and refs views. Default value: "0". See also:
+       "repo.enable-remote-branches".
+
+enable-subject-links::
+       Flag which, when set to "1", will make cgit use the subject of the
+       parent commit as link text when generating links to parent commits
+       in commit view. Default value: "0". See also:
+       "repo.enable-subject-links".
+

 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".
 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".


@@ -150,6 +177,10 @@ logo-link::
        calculated url of the repository index page will be used. Default
        value: none.
 
        calculated url of the repository index page will be used. Default
        value: none.
 

+max-atom-items::
+       Specifies the number of items to display in atom feeds view. Default
+       value: "10".
+

 max-commit-count::
        Specifies the number of entries to list per page in "log" view. Default
        value: "50".
 max-commit-count::
        Specifies the number of entries to list per page in "log" view. Default
        value: "50".


@@ -166,6 +197,10 @@ max-repodesc-length::
        Specifies the maximum number of repo description characters to display
        on the repository index page. Default value: "80".
 
        Specifies the maximum number of repo description characters to display
        on the repository index page. Default value: "80".
 

+max-blob-size::
+       Specifies the maximum size of a blob to display HTML for in KBytes.
+       Default value: "0" (limit disabled).
+

 max-stats::
        Set the default maximum statistics period. Valid values are "week",
        "month", "quarter" and "year". If unspecified, statistics are
 max-stats::
        Set the default maximum statistics period. Valid values are "week",
        "month", "quarter" and "year". If unspecified, statistics are


@@ -194,14 +229,24 @@ noheader::
        Flag which, when set to "1", will make cgit omit the standard header
        on all pages. Default value: none. See also: "embedded".
 
        Flag which, when set to "1", will make cgit omit the standard header
        on all pages. Default value: none. See also: "embedded".
 

+project-list::
+       A list of subdirectories inside of scan-path, relative to it, that
+       should loaded as git repositories. This must be defined prior to
+       scan-path. Default value: none. See also: scan-path.
+
+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.
+

 renamelimit::
        Maximum number of files to consider when detecting renames. The value
         "-1" uses the compiletime value in git (for further info, look at
          `man git-diff`). Default value: "-1".
 
 repo.group::
 renamelimit::
        Maximum number of files to consider when detecting renames. The value
         "-1" uses the compiletime value in git (for further info, look at
          `man git-diff`). Default value: "-1".
 
 repo.group::

-       A value for the current repository group, which all repositories
-       specified after this setting will inherit. Default value: none.
+       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:
 
 robots::
        Text used as content for the "robots" meta-tag. Default value:


@@ -220,6 +265,23 @@ root-title::
        Text printed as heading on the repository index page. Default value:
        "Git Repository Browser".
 
        Text printed as heading on the repository index page. Default value:
        "Git Repository Browser".
 

+scan-path::
+       A path which will be scanned for repositories. If caching is enabled,
+       the result will be cached as a cgitrc include-file in the cache
+       directory. If project-list has been defined prior to scan-path,
+       scan-path loads only the directories listed in the file pointed to by
+       project-list. Default value: none. See also: cache-scanrc-ttl,
+       project-list.
+
+section::
+       The name of the current repository section - all repositories defined
+       after this option will inherit the current section name. Default value:
+       none.
+
+side-by-side-diffs::
+       If set to "1" shows side-by-side diffs instead of unidiffs per
+       default. Default value: "0".
+

 snapshots::
        Text which specifies the default set of snapshot formats generated by
        cgit. The value is a space-separated list of zero or more of the
 snapshots::
        Text which specifies the default set of snapshot formats generated by
        cgit. The value is a space-separated list of zero or more of the


@@ -256,14 +318,16 @@ virtual-root::
 REPOSITORY SETTINGS
 -------------------
 repo.about-filter::
 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::
 
 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
 
 repo.defbranch::
        The name of the default branch for this repository. If no such branch


@@ -281,6 +345,14 @@ repo.enable-log-linecount::
        A flag which can be used to disable the global setting
        `enable-log-linecount'. Default value: none.
 
        A flag which can be used to disable the global setting
        `enable-log-linecount'. Default value: none.
 

+repo.enable-remote-branches::
+       Flag which, when set to "1", will make cgit display remote branches
+       in the summary and refs views. Default value: <enable-remote-branches>.
+
+repo.enable-subject-links::
+       A flag which can be used to override the global setting
+       `enable-subject-links'. 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


@@ -299,20 +371,40 @@ repo.path::
 
 repo.readme::
        A path (relative to <repo.path>) which specifies a file to include
 
 repo.readme::
        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. You may also specify a
+       git refspec by head or by hash by prepending the refspec followed by
+       a colon. For example, "master:docs/readme.mkd" Default value: none.

 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the
        "snapshots" global setting. Default value: <snapshots>.
 
 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the
        "snapshots" global setting. Default value: <snapshots>.
 

+repo.section::
+       Override the current section name for this repository. Default value:
+       none.
+

 repo.source-filter::
 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.
 
 
 
 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
 -------------------
 
 EXAMPLE CGITRC FILE
 -------------------
 


@@ -372,7 +464,7 @@ snapshots=tar.gz tar.bz2 zip
 ## List of common mimetypes
 ##
 
 ## List of common mimetypes
 ##
 

-mimetype.git=image/git
+mimetype.gif=image/gif

 mimetype.html=text/html
 mimetype.jpg=image/jpeg
 mimetype.jpeg=image/jpeg
 mimetype.html=text/html
 mimetype.jpg=image/jpeg
 mimetype.jpeg=image/jpeg


@@ -383,8 +475,8 @@ mimetype.svg=image/svg+xml
 
 ##
 ## List of repositories.
 
 ##
 ## 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
 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 ##      and included like this:
 ##        include=/etc/cgitrepos


@@ -406,7 +498,7 @@ repo.readme=info/web/about.html
 
 
 # The next repositories will be displayed under the 'extras' heading
 
 
 # The next repositories will be displayed under the 'extras' heading

-repo.group=extras
+section=extras

 
 
 repo.url=baz
 
 
 repo.url=baz


@@ -419,7 +511,7 @@ repo.desc=the wizard of foo
 
 
 # Add some mirrored repositories
 
 
 # Add some mirrored repositories

-repo.group=mirrors
+section=mirrors

 
 
 repo.url=git
 
 
 repo.url=git


@@ -458,3 +550,4 @@ will generate the following html element:
 AUTHOR
 ------
 Lars Hjemli <hjemli@gmail.com>
 AUTHOR
 ------
 Lars Hjemli <hjemli@gmail.com>

+Jason A. Donenfeld <Jason@zx2c4.com>