khal
reads configuration files in the ini syntax, meaning it understands keys separated from values by a =, while section and subsection names are enclosed by single or double square brackets (like [sectionname] and [[subsectionname]]). Any line beginning with a # will be treated as a comment.
If you do not have a configuration file yet, running khal configure
will launch a small, interactive tool that should help you with initial configuration of khal
.
khal
is looking for configuration files in the following places and order: $XDG_CONFIG_HOME/khal/config
(on most systems this is ~/.config/khal/config
), ~/.khal/khal.conf
(deprecated) and a file called khal.conf
in the current directory (deprecated). Alternatively you can specify which configuration file to use with -c
path/to/config
at runtime.
A minimal sample configuration could look like this:
../../tests/configs/simple.conf
If you have the following directory layout:
~/calendars
├- work/
├- home/
└─ family/
where work, home and family are all different vdirs, each containing one calendar, a matching calendar section could look like this:
ini
[[calendars]]
path = ~/calendars/*
type = discover
color = dark green
To get khal
working with CalDAV you will first need to setup vdirsyncer. After each start khal
will automatically check if anything has changed and automatically update its caching db (this may take some time after the initial sync, especially for large calendar collections). Therefore, you might want to execute khal
automatically after syncing with vdirsyncer
(e.g. via cron
).