diff options
Diffstat (limited to 'contrib/caldav/README.md')
| -rw-r--r-- | contrib/caldav/README.md | 41 |
1 files changed, 23 insertions, 18 deletions
diff --git a/contrib/caldav/README.md b/contrib/caldav/README.md index b6f6cbf..b464dc9 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: @@ -32,20 +34,21 @@ argument. You can choose between the following initialization modes: For subsequent calcurse-caldav invocations, you don't need to specify any additional parameters. -You can specify a username and password for basic authentication in the -config file. Alternatively, the password can be passed securely from another -program (such as *pass*) via the `CALCURSE_CALDAV_PASSWORD` environment variable like -so: -``` -CALCURSE_CALDAV_PASSWORD=$(pass show calcurse) calcurse-caldav -``` +Specify your HTTP Basic authentication credentials under the config file's +`Auth` section. The most secure approach is to save your password in a CLI +encrypted password store (_e.g.,_ [pass](https://www.passwordstore.org/)), and +then set `PasswordCommand` to the shell command used to retrieve it. +If security is not a priority, you may store your password in plain text +instead. 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 +62,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, |