cgitrc.5.txt: document repo.scan and cache-scanrc-ttl

[cgit.git] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 683f3b54853cd398c2159886ebc51dab22eb92a3..68ae2edb1cac1b3dc044e56f53ccf5b883cc9fd3 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -14,8 +14,22 @@ repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 lines, and lines starting with '#', are ignored.
 
 
 lines, and lines starting with '#', are ignored.
 
 

+LOCATION
+--------
+The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
+runtime, cgit will consult the environment variable CGIT_CONFIG and, if
+defined, use its value instead.
+
+

 GLOBAL SETTINGS
 ---------------
 GLOBAL SETTINGS
 ---------------

+about-filter::
+       Specifies a command which will be invoked to format the content of
+       about pages (both top-level and for each repository). The command will
+       get the content of the about-file on its STDIN, and the STDOUT from the
+       command will be included verbatim on the about page. Default value:
+       none.
+

 agefile::
        Specifies a path, relative to each repository path, which can be used
        to specify the date and time of the youngest commit in the repository.
 agefile::
        Specifies a path, relative to each repository path, which can be used
        to specify the date and time of the youngest commit in the repository.


@@ -40,6 +54,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).


@@ -55,10 +73,21 @@ clone-prefix::
        setting is only used if `repo.clone-url` is unspecified. Default value:
        none.
 
        setting is only used if `repo.clone-url` is unspecified. Default value:
        none.
 

+commit-filter::
+       Specifies a command which will be invoked to format commit messages.
+       The command will get the message on its STDIN, and the STDOUT from the
+       command will be included verbatim as the commit message, i.e. this can
+       be used to implement bugtracker integration. Default value: none.
+

 css::
        Url which specifies the css document to include in all cgit pages.
        Default value: "/cgit.css".
 
 css::
        Url which specifies the css document to include in all cgit pages.
        Default value: "/cgit.css".
 

+embedded::
+       Flag which, when set to "1", will make cgit generate a html fragment
+       suitable for embedding in other html pages. Default value: none. See
+       also: "noheader".
+       

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


@@ -114,7 +143,7 @@ local-time::
 
 logo::
        Url which specifies the source of an image which will be used as a logo
 
 logo::
        Url which specifies the source of an image which will be used as a logo

-       on all cgit pages.
+       on all cgit pages. Default value: "/cgit.png".

 
 logo-link::
        Url loaded when clicking on the cgit logo image. If unspecified the
 
 logo-link::
        Url loaded when clicking on the cgit logo image. If unspecified the


@@ -142,6 +171,10 @@ max-stats::
        "month", "quarter" and "year". If unspecified, statistics are
        disabled. Default value: none. See also: "repo.max-stats".
 
        "month", "quarter" and "year". If unspecified, statistics are
        disabled. Default value: none. See also: "repo.max-stats".
 

+mimetype.<ext>::
+       Set the mimetype for the specified filename extension. This is used
+       by the `plain` command when returning blob content.
+

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


@@ -153,6 +186,14 @@ nocache::
        deprecated, and will not be honored starting with cgit-1.0. Default
        value: "0".
 
        deprecated, and will not be honored starting with cgit-1.0. Default
        value: "0".
 

+noplainemail::
+       If set to "1" showing full author email adresses will be disabled.
+       Default value: "0".
+
+noheader::
+       Flag which, when set to "1", will make cgit omit the standard header
+       on all pages. Default value: none. See also: "embedded".
+

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


@@ -162,6 +203,11 @@ repo.group::
        A value for the current repository group, which all repositories
        specified after this setting will inherit. Default value: none.
 
        A value for the current repository group, which all repositories
        specified after this setting will inherit. Default value: none.
 

+repo.scan::
+       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. Default value: none. See also: cache-scanrc-ttl.
+

 robots::
        Text used as content for the "robots" meta-tag. Default value:
        "index, nofollow".
 robots::
        Text used as content for the "robots" meta-tag. Default value:
        "index, nofollow".


@@ -180,14 +226,17 @@ root-title::
        "Git Repository Browser".
 
 snapshots::
        "Git Repository Browser".
 
 snapshots::

-       Text which specifies the default (and allowed) set of snapshot formats
-       supported by cgit. The value is a space-separated list of zero or more
-       of the following values:
-               "tar"           uncompressed tar-file
-               "tar.gz"        gzip-compressed tar-file
-               "tar.bz2"       bzip-compressed tar-file
-               "zip"           zip-file
-       Default value: none.
+       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
+       values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
+
+source-filter::
+       Specifies a command which will be invoked to format plaintext blobs
+       in the tree view. The command will get the blob content on its STDIN
+       and the name of the blob as its only command line argument. The STDOUT
+       from the command will be included verbatim as the blob contents, i.e.
+       this can be used to implement e.g. syntax highlighting. Default value:
+       none.

 
 summary-branches::
        Specifies the number of branches to display in the repository "summary"
 
 summary-branches::
        Specifies the number of branches to display in the repository "summary"


@@ -211,10 +260,16 @@ virtual-root::
 
 REPOSITORY SETTINGS
 -------------------
 
 REPOSITORY SETTINGS
 -------------------

+repo.about-filter::
+       Override the default about-filter. Default value: <about-filter>.
+

 repo.clone-url::
        A list of space-separated urls which can be used to clone this repo.
        Default value: none.
 
 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>.
+

 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


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

+repo.source-filter::
+       Override the default source-filter. Default value: <source-filter>.
+

 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.


@@ -315,6 +373,19 @@ root-readme=/var/www/htdocs/about.html
 snapshots=tar.gz tar.bz2 zip
 
 
 snapshots=tar.gz tar.bz2 zip
 
 

+##
+## List of common mimetypes
+##
+
+mimetype.git=image/git
+mimetype.html=text/html
+mimetype.jpg=image/jpeg
+mimetype.jpeg=image/jpeg
+mimetype.pdf=application/pdf
+mimetype.png=image/png
+mimetype.svg=image/svg+xml
+
+

 ##
 ## List of repositories.
 ## PS: Any repositories listed when repo.group is unset will not be
 ##
 ## List of repositories.
 ## PS: Any repositories listed when repo.group is unset will not be