Document the hooks feature
Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
This commit is contained in:
@@ -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
|
||||
-----
|
||||
|
||||
|
||||
@@ -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
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
Reference in New Issue
Block a user