summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRasmus Steinke <rasi@xssn.at>2017-10-30 17:54:15 +0100
committerRasmus Steinke <rasi@xssn.at>2017-10-30 17:54:15 +0100
commite71d21c0869189ae6c39d8d9e3cf69cb15755bf0 (patch)
tree31439f3831e80a115838208e539af811d265cca9 /README.md
parent98e97d8336517109416b7c3b99bbf837a3aefd4c (diff)
downloadclerk-e71d21c0869189ae6c39d8d9e3cf69cb15755bf0.tar.gz
clerk-e71d21c0869189ae6c39d8d9e3cf69cb15755bf0.tar.bz2
add info about XDG_DATA_HOME
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index 75d3624..e3bfe40 100644
--- a/README.md
+++ b/README.md
@@ -130,13 +130,16 @@ All tmux hotkeys can be changed in clerk.tmux file.
## Files and Variables
-clerk Uses `$XDG_CONFIG_HOME` to store it's files. Normally this variable is not set
-and defaults to `$HOME/.config`.
+clerk uses `$XDG_CONFIG_HOME` and `$XDG_DATA_HOME` for its files. Both variables are usally unset
+and default to `$HOME/.config` and `$HOME/local/share`. These files are stored by clerk:
-Files used:
+### XDG_CONFIG_HOME
* `clerk.conf`: config file.
* `clerk.tmux`: clerk's tmux config
+
+### XDG_DATA_HOME
+
* `database.mpk`: clerk's local database
Use `CLERK_CONF`, `CLERK_TMUX` and `CLERK_DATABASE` variables to override file locations.