finally decided the config style

read the template.conf file for examples and the spec.

template.conf

@@ -1,11 +1,32 @@
 # This is a comment
 
-# these are valid entries
+# Every new hotkey starts with one of these markers:
-KEY_ALT +  KEY_S = "xset s on"
+# - -> normal matching
-KEY_LEFTMETA = 'rofi -show drun'
+# * -> fuzzy matching
-KEY_LEFTMETA + KEY_L = '/home/ale/scripts/lock.sh'
+# Normal matching means that the keys need to be pressed in the same order as
+# they are declared, whereas fuzzy matching means that they can be pressed in 
+# any order.
 
-I dont care about whitespaces = true
+# Leading or trailing whitespaces are ignored, whitespaces between the marker
-# will be translated to Idontcareaboutwhitespaces=true
+# And the ':' are also ignored, the general syntax for a hotkey is:
-or	tabs = true
+# marker keys: command
-# is: ortabs=true
+# Whitespaces after the ':' count as that counts as the executed command for
+# the hotkey.
+# Commads are expanded using wordexp(3) so "|&;<>(){}" as well as unescaped
+# newlines are forbidden and will result in error, read the manpage for
+# wordexp(3) for more info about the possible word expansion capabilities.
+
+# Possible keys are taken directly from linux's input.h header file, those
+# include normal keys, multimedia keys and special keys, for the full list
+# of available keys either refer to the header file or this project's hkd.c
+# source file. Keys as specified by the kernel are named "KEY_<name>", in this
+# configuration file only the <name> is required.
+# Key names are always capitalized and do not differenciate between upper or
+# lower case, as such hotkeys that require a capitalized letter need to include
+# RIGHTSHIFT or LEFTSHIFT in the keys section.
+# Keys are intended as a list of comma separated strings.
+
+# Examples:
+# - LEFALT,LEFTSHIFT,S: ~/screenshot.sh -c
+# * LEFTMETA,1,D: $SCRIPTDIR/wonkyscript
+# - LEFTMETA,LEFTALT,LEFTSHIFT,S: shutdown now