fix ORG syntax

This commit is contained in:
2022-11-12 12:42:58 +01:00
parent d3c84caad8
commit cdb7cf2b14

View File

@@ -3,15 +3,15 @@
This document will explain how to setup g910-gkeys by limiting as much as possible the usage of a global config, the idea being to setup global mapping in a static manner, and let the user set the actions in his/her own environment.
** Preamble
~g910-gkeys~ allows different actions : `typeout`, `shortcut` and `run`. All of these actions will be performed on the process environment, that is `root`. Also, these actions will be *global*.
** g910-gkeys
~g910-gkeys~ allows different actions : `typeout`, `shortcut` and `run`. All of these actions will be performed on the process environment, that is `root`. Also, these actions are *global*.
** g910-gkeys configuration file (/etc/g910-gkeys/config.json)
The configuration chosen will ba basic: assign each ~g-key~ to a key which does not exist on physical keyboard. Any key could be used, like specific localized keys which do not exist on your keyboard (example: Japanese keys for an English keyboard), or function keys above F12.
We will choose to map them to Function keys `F13` to `F21`. It is possible that some of these F-keys are already used on your system (example: some media keys may be assigned to `F20`). In this case, simply use another F-key.
The ~g910-gkeys~ will be (skipping ~F20~ on my system):
#+begin_src json
#+BEGIN_SRC json
{
"__comment": "I was unable to use F20, even xev does not show the keycode. It just mutes/unmutes sound, same as the G910's <mute> button",
"keyboard_mapping": "en",
@@ -52,7 +52,7 @@ The ~g910-gkeys~ will be (skipping ~F20~ on my system):
"do": "F22"
}
}
#end_src
#+END_SRC
** User configuration
*Note*: Configuration below will make the ~G-keys~ active only when user is logged-on, as any other key.