cgitrc.5.txt: fix description and markup for 'snapshots' option

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0412f64acb507b3a2fa652108890e367017c0732..0d1829069c7a4465ea02525eb9844ff33a86f2ef 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.
 
 
+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
 ---------------
+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.
@@ -55,6 +69,12 @@ clone-prefix::
        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".
@@ -119,7 +139,7 @@ local-time::
 
 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
@@ -197,14 +217,17 @@ root-title::
        "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"
@@ -228,10 +251,16 @@ virtual-root::
 
 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.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
@@ -272,6 +301,9 @@ repo.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.