summaryrefslogtreecommitdiff
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2014-01-13 03:04:52 +0000
committerJason A. Donenfeld <Jason@zx2c4.com>2014-01-14 01:00:07 +0000
commita5e15537268410e268c7b26aa69d03b347c326c8 (patch)
tree77f42b7f03788d4741bfd60b49719fbc649181ff /cgitrc.5.txt
parent800380dde797ae35d738a644acdae2fabb9a0d44 (diff)
downloadcgit-a5e15537268410e268c7b26aa69d03b347c326c8.tar
cgit-a5e15537268410e268c7b26aa69d03b347c326c8.tar.gz
cgit-a5e15537268410e268c7b26aa69d03b347c326c8.zip
filter: add support for email filter
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 78f33c8..b7dc5a4 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -117,6 +117,14 @@ css::
Url which specifies the css document to include in all cgit pages.
Default value: "/cgit.css".
+email-filter::
+ Specifies a command which will be invoked to format names and email
+ address of committers, authors, and taggers, as represented in various
+ places throughout the cgit interface. This command will receive an
+ email address as its only command line argument, and the text to
+ format on STDIN. It is to write the formatted text back out onto
+ STDOUT. Default value: none. See also: "FILTER API".
+
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
@@ -457,6 +465,10 @@ repo.defbranch::
repo.desc::
The value to show as repository description. Default value: none.
+repo.email-filter::
+ Override the default email-filter. Default value: none. See also:
+ "enable-filter-overrides". See also: "FILTER API".
+
repo.enable-commit-graph::
A flag which can be used to disable the global setting
`enable-commit-graph'. Default value: none.
@@ -607,6 +619,12 @@ commit filter::
be filtered is available on standard input and the filtered text is
expected on standard output.
+email filter::
+ This filter is given a single parameter: the email address of the
+ relevent user. The filter will then receive the text string to format
+ on standard input and is expected to write to standard output the
+ formatted text to be included in the page.
+
source filter::
This filter is given a single parameter: the filename of the source
file to filter. The filter can use the filename to determine (for