diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/calcurse.1.txt | 19 | ||||
| -rw-r--r-- | doc/manual.txt | 19 |
2 files changed, 38 insertions, 0 deletions
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 ----- diff --git a/doc/manual.txt b/doc/manual.txt index d140dfa..f79f42e 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -632,6 +632,25 @@ The following environment variables affect the way `calcurse` operates: Specifies the default viewer to be used for reading notes. If this variable is not set, then `/usr/bin/less` is used. +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. + User interface ~~~~~~~~~~~~~~ |