path: root/contrib
diff options
authorLukas Fleischer <lfleischer@calcurse.org>2016-04-01 08:35:14 +0200
committerLukas Fleischer <lfleischer@calcurse.org>2016-04-01 08:35:14 +0200
commit2c9ea341cf2364ac0a4ea05d0d0f3dca983c14de (patch)
tree3fe9d426395764d5d2aec322e30a167772192cf2 /contrib
parent4633846550a1efd3a758e51551b6a93446b2297d (diff)
Document the hooks feature
Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
Diffstat (limited to 'contrib')
1 files changed, 16 insertions, 1 deletions
diff --git a/contrib/caldav/README b/contrib/caldav/README
index aed1320..008b3fe 100644
--- a/contrib/caldav/README
+++ b/contrib/caldav/README
@@ -26,10 +26,25 @@ argument. You can choose between the following initialization modes:
--init=keep-remote Remove all local calcurse items and import remote objects
--init=keep-local Remove all remote objects and push local calcurse items
--init=two-way Copy local objects to the CalDAV server and vice versa
For subsequent calcurse-caldav invocations, you don't need to specify any
additional parameters.
+You can place scripts in `$HOME/.calcurse/caldav/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.
+ Executed before the data files are synchronized.
+ Executed after the data files are synchronized.
+Some examples can be found in the `contrib/caldav/hooks/` directory of the
+calcurse source tree.
How It Works