cgitrc.5.txt: describe where/how cgit will locate cgitrc

[cgit.git] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 7256ec0d0fa1a0f6baad63cde084102190cfbce9..3c35b02ad5b6eb8983e3144a8796db6591e2b50a 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.


@@ -55,6 +69,12 @@ 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".


@@ -119,7 +139,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


@@ -162,6 +182,10 @@ 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".
 noheader::
        Flag which, when set to "1", will make cgit omit the standard header
        on all pages. Default value: none. See also: "embedded".


@@ -202,6 +226,14 @@ snapshots::
                "zip"           zip-file
        Default value: none.
 
                "zip"           zip-file
        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"
        view. Default value: "10".
 summary-branches::
        Specifies the number of branches to display in the repository "summary"
        view. Default value: "10".


@@ -224,10 +256,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


@@ -268,6 +306,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.