X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/f43b228d0bca5791be98ff3fbb2f8743219635b6..6ca734da8fb246ad2272826331e0d56428b96fa1:/cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 78f33c8..170e825 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 and an origin page string as its command line arguments,
+	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
@@ -382,10 +390,10 @@ side-by-side-diffs::
 	default. Default value: "0".
 
 snapshots::
-	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", "tar.xz" and "zip". Default value:
-	none.
+	Text which specifies the default set of snapshot formats that cgit
+	generates links for. The value is a space-separated list of zero or
+	more of the values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip".
+	Default value: none.
 
 source-filter::
 	Specifies a command which will be invoked to format plaintext blobs
@@ -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.
@@ -526,8 +538,9 @@ repo.readme::
 	file. Default value: <readme>.
 
 repo.snapshots::
-	A mask of allowed snapshot-formats for this repo, restricted by the
-	"snapshots" global setting. Default value: <snapshots>.
+	A mask of snapshot formats for this repo that cgit generates links for,
+	restricted by the global "snapshots" setting. Default value:
+	<snapshots>.
 
 repo.section::
 	Override the current section name for this repository. Default value:
@@ -577,7 +590,8 @@ specification with the relevant string; available values are:
 		This is called whenever cgit writes data to the webpage.
 	'filter_close()'::
 		This is called when the current filtering operation is
-		completed.
+		completed. It must return an integer value. Usually 0
+		indicates success.
 	
 	Additionally, cgit exposes to the Lua the following built-in functions:
 
@@ -607,6 +621,13 @@ commit filter::
 	be filtered is available on standard input and the filtered text is
 	expected on standard output.
 
+email filter::
+	This filter is given two parameters: the email address of the relevent
+	author and a string indicating the originating page. 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