aboutsummaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorkoekeishiya <aasvi93@hotmail.com>2018-05-10 16:49:33 +0200
committerkoekeishiya <aasvi93@hotmail.com>2018-05-10 16:49:33 +0200
commitc5f03f1f96c7f707c078c3b6e4355808033127a0 (patch)
treeabc6de2e2b035fd164d97fa76bd9a73823ff8340 /examples
parent73abf77e71c75aaea8ee181da26b7994ba69de6f (diff)
downloadskhd-c5f03f1f96c7f707c078c3b6e4355808033127a0.tar.gz
skhd-c5f03f1f96c7f707c078c3b6e4355808033127a0.zip
#15 update sample and code cleanup
Diffstat (limited to 'examples')
-rw-r--r--examples/skhdrc39
1 files changed, 28 insertions, 11 deletions
diff --git a/examples/skhdrc b/examples/skhdrc
index 411ceb3..2b0e6d8 100644
--- a/examples/skhdrc
+++ b/examples/skhdrc
@@ -34,23 +34,40 @@
# an EOL character signifies the end of the bind.
#
#
-# NOTE(koekeishiya): Modal operations
+# NOTE(koekeishiya): A mode is declared according to the following rules:
#
-# defines a new mode 'switcher' with an on_enter command
-# :: switcher : chunkc border::color 0xff24ccaa
+# mode_decl = '::' <name> '@' ':' <command> | '::' <name> ':' <command> |
+# '::' <name> '@' | '::' <name>
#
-# defines a new mode named 'test'
-# :: test
+# name = desired name for this mode,
#
-# from 'default' mode, activate mode 'test'
-# cmd - x ; test
+# @ = capture keypresses regardless of being bound to an action
#
-# from 'test' mode, activate mode 'default'
-# test < cmd - x ; default
+# 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.
#
-# launch a new terminal instance when in either 'default' or 'test' mode
-# default, test < cmd - return : open -na /Applications/Terminal.app
+# 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.
+# add an on_enter command to the default mode
+# :: default : chunkc border::color 0xff775759
+#
+# defines a new mode 'test' with an on_enter command, that captures keypresses
+# :: test @ : chunkc border::color 0xff24ccaa
+#
+# from 'default' mode, activate mode 'test'
+# cmd - x ; test
+#
+# from 'test' mode, activate mode 'default'
+# test < cmd - x ; default
+#
+# launch a new terminal instance when in either 'default' or 'test' mode
+# default, test < cmd - return : open -na /Applications/Terminal.app
# open terminal, blazingly fast compared to iTerm/Hyper
cmd - return : open -na /Applications/Kitty.app