aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkoekeishiya <aasvi93@hotmail.com>2017-08-07 22:46:47 +0200
committerkoekeishiya <aasvi93@hotmail.com>2017-08-07 22:46:47 +0200
commitadb24a2015a3c1388f12427fc0bad35ebcef4aa8 (patch)
treecb011f70aac86c57af06b8a2c20447fdb9f2ac60
parent7d48e5edf40815e8744d5ec05be0008106a6e2ee (diff)
downloadskhd-adb24a2015a3c1388f12427fc0bad35ebcef4aa8.tar.gz
skhd-adb24a2015a3c1388f12427fc0bad35ebcef4aa8.zip
update readme
-rw-r--r--README.md29
1 files changed, 28 insertions, 1 deletions
diff --git a/README.md b/README.md
index cf4eba6..c0fc6e4 100644
--- a/README.md
+++ b/README.md
@@ -62,4 +62,31 @@ Requires xcode-8 command-line tools,
A list of all built-in modifier and literal keywords can be found [here](https://github.com/koekeishiya/skhd/issues/1)
-See [sample config](https://github.com/koekeishiya/skhd/blob/master/examples/skhdrc) for syntax information.
+A hotkey is written according to the following rules:
+```
+hotkey = <keysym> ':' <command> |
+ <keysym> '->' ':' <command>
+
+keysym = <mod> '-' <key> | <key>
+
+mod = 'built-in mod keyword' | <mod> '+' <mod>
+
+key = <literal> | <keycode>
+
+literal = 'single letter or built-in keyword'
+
+keycode = 'apple keyboard kVK_<Key> values (0x3C)'
+
+-> = keypress is not consumed by skhd
+
+command = command is executed through '$SHELL -c' and
+ follows valid shell syntax. if the $SHELL environment
+ variable is not set, it will default to '/bin/bash'.
+ when bash is used, the ';' delimeter can be specified
+ to chain commands.
+
+ to allow a command to extend into multiple lines,
+ prepend '\' at the end of the previous line.
+
+ an EOL character signifies the end of the bind.
+```