From efb5fc53c164612dfb53a68e432be87185e45175 Mon Sep 17 00:00:00 2001 From: dec05eba Date: Fri, 7 Feb 2025 19:41:39 +0100 Subject: Show notification when saving a large replay that is taking some time --- tools/gsr-global-hotkeys/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 tools/gsr-global-hotkeys/README.md (limited to 'tools/gsr-global-hotkeys/README.md') diff --git a/tools/gsr-global-hotkeys/README.md b/tools/gsr-global-hotkeys/README.md new file mode 100644 index 0000000..8744107 --- /dev/null +++ b/tools/gsr-global-hotkeys/README.md @@ -0,0 +1,21 @@ +# About +Global hotkeys for X11 and all Wayland compositors by using linux device api. Keyboards are grabbed and only the non-hotkey keys are passed through to the system. +The program accepts text commands as input. Run the program with the option `--virtual` to only grab virtual devices. This is useful when using keyboard input mapping software such as +kanata, otherwise kanata may fail to launch or this program may fail to launch. +# Commands +## Bind +To add a key send `bind ` to the programs stdin, for example: +``` +bind show_hide 56+44 + +``` +which will bind alt+z. When alt+z is pressed the program will output `show_hide` (and a newline) to stdout. +The program only accepts one key for each keybind command but accepts a multiple modifier keys. +The keybinding requires at least one modifier key (ctrl, alt, super or shift) and a key to be used. +The keycodes are values from `` linux api header (which is the same as X11 keycode value minus 8). +## Unbind +To unbind all keys send `unbind_all` to the programs stdin, for example: +``` +unbind_all + +``` \ No newline at end of file -- cgit v1.2.3-70-g09d2