Merge branch 'lh/about'

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 33ac958b488675381d4393adca9930d49d2846e4..4d656fee5323fb35f0846ec086d7dfbd016d21c3 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -4,7 +4,7 @@ CGITRC(5)
 
 NAME
 ----
-       cgitrc - runtime configuration for cgit
+cgitrc - runtime configuration for cgit
 
 
 SYNOPSIS
@@ -16,6 +16,13 @@ lines, and lines starting with '#', are ignored.
 
 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,10 +62,21 @@ 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".
 
+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",
@@ -84,6 +102,10 @@ footer::
        verbatim at the bottom of all pages (i.e. it replaces the standard
        "generated by..." message. Default value: none.
 
+head-include::
+       The content of the file specified with this option will be included
+       verbatim in the html HEAD section on all pages. Default value: none.
+
 header::
        The content of the file specified with this option will be included
        verbatim at the top of all pages. Default value: none.
@@ -138,6 +160,10 @@ 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
@@ -149,6 +175,14 @@ nocache::
        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
@@ -185,6 +219,14 @@ snapshots::
                "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".
@@ -207,10 +249,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
@@ -251,6 +299,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.
@@ -311,6 +362,19 @@ root-readme=/var/www/htdocs/about.html
 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