|author||Jason A. Donenfeld <Jason@zx2c4.com>||2014-01-13 14:18:51 +0100|
|committer||Jason A. Donenfeld <Jason@zx2c4.com>||2014-01-14 02:00:07 +0100|
|parent||filter: basic write hooking infrastructure (diff)|
filter: add lua support
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to '')
1 files changed, 29 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 60159f6..78f33c8 100644
@@ -564,6 +564,35 @@ specification with the relevant string; available values are:
The default "one process per filter" mode.
+ 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.
+ This is called whenever cgit writes data to the webpage.
+ This is called when the current filtering operation is
+ Additionally, cgit exposes to the Lua the following built-in functions:
+ Writes 'str' to the webpage.
+ HTML escapes and writes 'str' to the webpage.
+ HTML escapes for an attribute and writes "str' to the webpage.
+ URL escapes for a path and writes 'str' to the webpage.
+ URL escapes for an argument and writes 'str' to the webpage.
Parameters are provided to filters as follows.