aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorNitroretro <nitroretro@protonmail.com>2019-12-17 17:24:48 +0200
committerLukas Fleischer <lfleischer@calcurse.org>2019-12-23 13:16:39 -0500
commit19d2d9229e62ea5e993b462f0cdedd868ec6c2d9 (patch)
tree8e17be1def6c0013831f17f261f031d08887f374 /src
parent04162de6ddcdbc5c1b2410f4f5f7dbae72cc62d9 (diff)
downloadcalcurse-19d2d9229e62ea5e993b462f0cdedd868ec6c2d9.tar.gz
calcurse-19d2d9229e62ea5e993b462f0cdedd868ec6c2d9.zip
Change documentation to reflect the new file structure
Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
Diffstat (limited to 'src')
-rw-r--r--src/io.c11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/io.c b/src/io.c
index 5333d66..6488401 100644
--- a/src/io.c
+++ b/src/io.c
@@ -136,10 +136,11 @@ unsigned io_fprintln(const char *fname, const char *fmt, ...)
/*
* Initialization of data paths. The cfile argument is the variable
* which contains the calendar file. If none is given, then the default
- * one (~/.calcurse/apts) is taken. If the one given does not exist, it
- * is created.
+ * one (~/.local/share/calcurse/apts) is taken. If the one given does not exist,
+ * it is created.
* The datadir argument can be used to specify an alternative data root dir.
* The confdir argument can be used to specify an alternative configuration dir.
+ * If ~/.calcurse exists, it will be used instead for backward compatibility.
*/
void io_init(const char *cfile, const char *datadir, const char *confdir)
{
@@ -1163,11 +1164,15 @@ int io_check_file(const char *file)
* Checks if data files exist. If not, create them.
* The following structure has to be created:
*
- * <datadir> <configdir> (default for both: $HOME/.calcurse/)
+ * <datadir> <configdir>
* | |
* |__ apts |___ conf
* |__ todo |___ keys
* |__ notes/ |___ hooks/
+ *
+ * Defaults:
+ * - datadir: $XDG_DATA_HOME/calcurse (~/.local/share/calcurse)
+ * - configdir: $XDG_CONFIG_HOME/calcurse (~/.config/calcurse)
*/
int io_check_data_files(void)
{