Change documentation to reflect the new file structure

Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>

6 files changed, 35 insertions, 17 deletions

diff --git a/contrib/caldav/README.md b/contrib/caldav/README.md
index b6f6cbf..a842081 100644
--- a/contrib/caldav/README.md
+++ b/contrib/caldav/README.md
@@ -17,10 +17,12 @@ Usage
 -----
 
 calcurse-caldav requires an up-to-date version of calcurse and a configuration
-file located at ~/.calcurse/caldav/config. An example configuration file can be
-found under contrib/caldav/config.sample in the calcurse source tree. You will
-also need to install *httplib2* for Python 3 using *pip* (e.g. `pip3 install
---user httplib2`) or your distribution's package manager.
+file located at $XDG_CONFIG_HOME/calcurse/caldav/config
+(~/.local/share/calcurse/caldav/config) or ~/.calcurse/caldav/config if
+~/.calcurse exists. An example configuration file can be found under
+contrib/caldav/config.sample in the calcurse source tree.  You will also need to
+install *httplib2* for Python 3 using *pip* (e.g. `pip3 install --user
+httplib2`) or your distribution's package manager.
 
 If you run calcurse-caldav for the first time, you need to provide the `--init`
 argument. You can choose between the following initialization modes:
@@ -43,9 +45,11 @@ CALCURSE_CALDAV_PASSWORD=$(pass show calcurse) calcurse-caldav
 Hooks
 -----
 
-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.
+You can place scripts in `$XDG_CONFIG_HOME/calcurse/caldav/hooks/`
+(`~/.config/calcurse/caldav/hooks`) or `~/.calcurse/caldav/hooks` if
+`~/.calcurse` exists in order 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-sync*::
   Executed before the data files are synchronized.
@@ -59,10 +63,12 @@ How It Works
 ------------
 
 calcurse-caldav creates a so-called synchronization database at
-`~/.calcurse/caldav/sync.db` that always keeps a snapshot of the last time the
-script was executed. When running the script, it compares the objects on the
-server and the local objects with that snapshot to identify items that were
-added or deleted. It then
+`$XDG_DATA_HOME/calcurse/caldav/sync.db`
+(`~/.local/share/calcurse/caldav/sync.db`) or `~/.calcurse/caldav/sync.db` if
+`~/.calcurse` exists that always keeps a snapshot of the last time the script
+was executed. When running the script, it compares the objects on the server
+and the local objects with that snapshot to identify items that were added or
+deleted. It then
 
 * downloads new objects from the server and imports them into calcurse,
 * deletes local objects that no longer exist on the server,
diff --git a/contrib/caldav/config.sample b/contrib/caldav/config.sample
index 4d87681..c89cfb7 100644
--- a/contrib/caldav/config.sample
+++ b/contrib/caldav/config.sample
@@ -1,6 +1,11 @@
 # If you want to synchronize calcurse with a CalDAV server using
-# calcurse-caldav, create a new directory ~/.calcurse/caldav/, copy this file
-# to ~/.calcurse/caldav/config and adjust the configuration below.
+# calcurse-caldav, create a new directory at $XDG_CONFIG_HOME/calcurse/caldav/
+# (~/.config/calcurse/caldav/) and $XDG_DATA_HOME/calcurse/caldav/
+# (~/.local/share/calcurse/caldav/) and copy this file to
+# $XDG_CONFIG_HOME/calcurse/caldav/config and adjust the configuration below.
+# Alternatively, if using ~/.calcurse, create a new directory at
+# ~/.calcurse/caldav/ and copy this file to ~/.calcurse/caldav/config and adjust
+# the configuration file below.
 
 [General]
 # Path to the calcurse binary that is used for importing/exporting items.
diff --git a/contrib/caldav/hooks/post-sync b/contrib/caldav/hooks/post-sync
index 1ac028c..372d260 100755
--- a/contrib/caldav/hooks/post-sync
+++ b/contrib/caldav/hooks/post-sync
@@ -4,7 +4,9 @@
 # repository, it automatically makes a commit whenever synchronizing with a
 # CalDAV server.
 #
-# In order to install this hook, copy this file to ~/.calcurse/caldav/hooks/.
+# In order to install this hook, copy this file to
+# $XDG_CONFIG_HOME/calcurse/caldav/hooks/ (~/.config/calcurse/caldav/hooks/) or
+# ~/.calcurse/caldav/hooks/ if using ~/.calcurse.
 
 cd "$HOME"/.calcurse/
 
diff --git a/contrib/hooks/post-save b/contrib/hooks/post-save
index bb582e2..6113ce6 100755
--- a/contrib/hooks/post-save
+++ b/contrib/hooks/post-save
@@ -5,7 +5,9 @@
 # 1. Make a commit if the calcurse data directory contains a Git repository.
 # 2. Synchronize with a CalDAV server if calcurse-caldav is configured.
 #
-# In order to install this hook, copy this file to ~/.calcurse/hooks/.
+# In order to install this hook, copy this file to
+# $XDG_CONFIG_HOME/calcurse/hooks/ (~/.config/calcurse/hooks/) or
+# ~/.calcurse/hooks/ if using ~/.calcurse.
 
 cd "$HOME"/.calcurse/
 
diff --git a/contrib/hooks/pre-load b/contrib/hooks/pre-load
index c9ab62d..38edea0 100755
--- a/contrib/hooks/pre-load
+++ b/contrib/hooks/pre-load
@@ -3,7 +3,9 @@
 # This is an example hook. It synchronizes calcurse with a CalDAV server before
 # loading the data files.
 #
-# In order to install this hook, copy this file to ~/.calcurse/hooks/.
+# In order to install this hook, copy this file to
+# $XDG_CONFIG_HOME/calcurse/hooks/ (~/.config/calcurse/hooks/) or
+# ~/.calcurse/hooks/ if using ~/.calcurse.
 
 cd "$HOME"/.calcurse/
 
diff --git a/contrib/vdir/README.md b/contrib/vdir/README.md
index b040d04..676b94c 100644
--- a/contrib/vdir/README.md
+++ b/contrib/vdir/README.md
@@ -39,7 +39,8 @@ destination, potentially deleting events in the destination that are no longer
 present in the origin.
 
 You can optionally specify an alternative directory for local calcurse data
-using the `-D` flag if it differs from the default `~/.calcurse`.
+using the `-D` flag if it differs from the default `$XDG_DATA_HOME/calcurse`
+(`~/.local/share/calcurse`) or `~/.calcurse`.
 
 Integration with vdirsyncer
 ---------------------------