From 2c9ea341cf2364ac0a4ea05d0d0f3dca983c14de Mon Sep 17 00:00:00 2001 From: Lukas Fleischer Date: Fri, 1 Apr 2016 08:35:14 +0200 Subject: Document the hooks feature Signed-off-by: Lukas Fleischer --- doc/calcurse.1.txt | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'doc/calcurse.1.txt') diff --git a/doc/calcurse.1.txt b/doc/calcurse.1.txt index 9fc37b6..adc3265 100644 --- a/doc/calcurse.1.txt +++ b/doc/calcurse.1.txt @@ -413,6 +413,25 @@ internal representation and were designed to be used for scripting: * *(hash)* * *(raw)* +Hooks +----- + +You can place scripts in `$HOME/.calcurse/hooks/` to trigger actions at certain +events. To enable a hook, add a script with one of the following names to this +directory. Also make sure the scripts are executable. + +*pre-load*:: + Executed before the data files are loaded. +*post-load*:: + Executed after the data files are saved. +*pre-save*:: + Executed before the data files are loaded. +*post-save*:: + Executed after the data files are saved. + +Some examples can be found in the `contrib/hooks/` directory of the calcurse +source tree. + Notes ----- -- cgit v1.2.3-54-g00ecf