From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jason at zx2c4.com (Jason A. Donenfeld) Date: Mon, 13 Jan 2014 05:11:14 +0100 Subject: [PATCH 07/12] filter: document lua filter type In-Reply-To: <1389586279-23724-1-git-send-email-Jason@zx2c4.com> References: <1389586279-23724-1-git-send-email-Jason@zx2c4.com> Message-ID: <1389586279-23724-8-git-send-email-Jason@zx2c4.com> Signed-off-by: Jason A. Donenfeld --- cgitrc.5.txt | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 60159f6..d1e872f 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -564,6 +564,29 @@ specification with the relevant string; available values are: 'exec:':: The default "one process per filter" mode. +'lua:':: + Executes the script using a built-in Lua interpreter. The script is + loaded once per execution of cgit, and may be called multiple times + during cgit's lifetime, making it a good choice for repeated filters + such as the 'email filter'. It responds to three functions: + + 'filter_open(argument1, argument2, argument3, ...)':: + This is called upon activation of the filter for a particular + set of data. + + 'filter_write(buffer)':: + This is called whenever cgit writes data to the webpage. + + 'filter_close()':: + This is called when the current filtering operation is + completed. + + Additionally, cgit exposes to the Lua the following built-in function: + + 'html(str)':: + Writes 'str' to the webpage. + + Parameters are provided to filters as follows. about filter:: -- 1.8.5.2