Merge branch 'uli42-pr/cleanup_keystroke' into 3.6.x

Attributes GH PR #392: https://github.com/ArcticaProject/nx-libs/pull/392

1 files changed, 17 insertions, 6 deletions

diff --git a/doc/nxagent/README.keystrokes b/doc/nxagent/README.keystrokes
index 08cdafb46..96bc158d2 100644
--- a/doc/nxagent/README.keystrokes
+++ b/doc/nxagent/README.keystrokes
@@ -16,7 +16,7 @@ If nxagent is called without branding, it searches:
 
 If nxagent is called with X2Go branding (i.e., as x2goagent), it searches:
 - in the location given by the '-keystrokefile' command line parameter
-- in the location given by the NXAGENT_KEYSTROKEFILE environment variable
+- in the location given by the X2GO_KEYSTROKEFILE environment variable
 - in ~/.x2go/config/keystrokes.cfg
 - in /etc/x2go/keystrokes.cfg
 
@@ -52,7 +52,7 @@ XStringToKeysym function. A list of possible keys can be found in
 'Space' and 'escape' won't.
 
 Modifiers are given as boolean attributes, possible modifiers are Mod1, Mod2,
-Mod3, Mod4, Control, Shift, Lock. Sensible combinations strongly depend on your
+Mod3, Mod4, Mod5, Control, Shift, Lock. Sensible combinations strongly depend on your
 keyboard configuration, but usually you will need Mod1 and Control. Boolean in
 this context means '0', 'false' and an unspecified attribute are false, anything
 else is considered true.
@@ -64,12 +64,17 @@ default keybindings, and only one file is read, no merging between different
 configuration files is done. This also means that an empty or invalid configuration
 file deactivates all keybindings.
 
+If an attribute occurs more than once in a line the last one wins.
+
 List of possible 'action' attributes:
 -------------------------------------
 
 close_session
   This terminates the session.
+fullscreen
+  Switches the client window into or out of fullscreen mode, using only the current head.
 switch_all_screens
+  Switches the client window into or out of fullscreen mode, using all available heads.
 minimize
   This will minimize the client window (even for fullscreen sessions.)
 left
@@ -77,13 +82,15 @@ up
 right
 down
 resize
-  This action switches between the auto-resize and viewport mode (static size). The default is auto-resize. In viewport mode one can use the 'viewport_move_up', 'viewport_move_down', 'viewport_move_left' and 'viewport_move_right' actions to move within the image.
+  This action switches between the auto-resize and viewport mode
+  (static size). The default is auto-resize. In viewport mode one can
+  use the 'viewport_move_up', 'viewport_move_down',
+  'viewport_move_left' and 'viewport_move_right' actions to move
+  within the image.
 defer
-  Works like 'ignore' to make some keys be ignored/defunct inside the session.
+  activate/deactivate deferred screen updates.
 ignore
   Makes it possible to add 'ignore', as in nothing happens when certain keys are pressed.
-fullscreen
-  Switches the client window into or out of fullscreen mode.
 viewport_move_left
   Moves the image viewport to the left.
 viewport_move_up
@@ -92,6 +99,10 @@ viewport_move_right
   Moves the image viewport to the right.
 viewport_move_down
   Moves the image viewport down.
+reread_keystrokes
+  forces nxagent to re-read the keystroke
+  configuration. Useful to add/changes keystrokes for a running
+  session.
 
 Only in builds with certain debugging options enabled, ignored otherwise:
 force_synchronization