X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/3cb5d86dc68bab4883bf5a7cbc90f3e266237355..dcbc0438b2543a733858d62170f3110a89edbed6:/cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 8a0a9c9..6437ef4 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -29,9 +29,10 @@ 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. See also: "FILTER API".
+	get the content of the about-file on its STDIN, the name of the file
+	as the first argument, and the STDOUT from the command will be
+	included verbatim on the about page. Default value: none. See
+	also: "FILTER API".
 
 agefile::
 	Specifies a path, relative to each repository path, which can be used
@@ -288,8 +289,10 @@ project-list::
 	EXPANSION".
 
 readme::
-	Text which will be used as default value for "repo.readme". Default
-	value: none.
+	Text which will be used as default value for "repo.readme". Multiple
+	config keys may be specified, and cgit will use the first found file
+	in this list. This is useful in conjunction with scan-path. Default
+	value: none. See also: scan-path, repo.readme.
 
 remove-suffix::
 	If set to "1" and scan-path is enabled, if any repositories are found
@@ -507,7 +510,10 @@ repo.readme::
 	git refspec by head or by hash by prepending the refspec followed by
 	a colon. For example, "master:docs/readme.mkd". If the value begins
 	with a colon, i.e. ":docs/readme.rst", the default branch of the
-	repository will be used. Default value: <readme>.
+	repository will be used. Sharing any file will expose that entire
+	directory tree to the "/about/PATH" endpoints, so be sure that there
+	are no non-public files located in the same directory as the readme
+	file. Default value: <readme>.
 
 repo.snapshots::
 	A mask of allowed snapshot-formats for this repo, restricted by the
@@ -542,9 +548,11 @@ config files, e.g. "repo.desc" becomes "desc".
 FILTER API
 ----------
 about filter::
-	This filter is given no arguments. The about text that is to be
-	filtered is available on standard input and the filtered text is
-	expected on standard output.
+	This filter is given a single parameter: the filename of the source
+	file to filter. The filter can use the filename to determine (for
+	example) the type of syntax to follow when formatting the readme file.
+	The about text that is to be filtered is available on standard input
+	and the filtered text is expected on standard output.
 
 commit filter::
 	This filter is given no arguments. The commit message text that is to