X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/a8d613efdc827a400fee89fc73e34c2666e37be6..fe36f84d843cd755c6dab629a0758264de5bcc00:/cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 9b803b3..12a843b 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,9 @@ 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
+	files may be specified, separated by a space, and cgit will use the
+	first found file in this list. Default value: none.
 
 remove-suffix::
 	If set to "1" and scan-path is enabled, if any repositories are found
@@ -505,7 +507,12 @@ repo.readme::
 	A path (relative to <repo.path>) which specifies a file to include
 	verbatim as the "About" page for this repo. You may also specify a
 	git refspec by head or by hash by prepending the refspec followed by
-	a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
+	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. 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
@@ -540,9 +547,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