aboutsummaryrefslogtreecommitdiff
path: root/README.keystrokes
diff options
context:
space:
mode:
Diffstat (limited to 'README.keystrokes')
-rw-r--r--README.keystrokes23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.keystrokes b/README.keystrokes
index 26782aa18..08cdafb46 100644
--- a/README.keystrokes
+++ b/README.keystrokes
@@ -6,13 +6,21 @@ by the user. This is done via a configuration file.
File location
-------------
-nxagent searches for the configuration file in the following order:
+nxagent parses the first available configuration file and ignores all others.
+
+If nxagent is called without branding, it searches:
- in the location given by the '-keystrokefile' command line parameter
- in the location given by the NXAGENT_KEYSTROKEFILE environment variable
- in ~/.nx/config/keystrokes.cfg
- in /etc/nxagent/keystrokes.cfg
-If none of those files is accessible, the default configuration is used which
+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 ~/.x2go/config/keystrokes.cfg
+- in /etc/x2go/keystrokes.cfg
+
+If none of these files are accessible, the default configuration is used which
is the same as the old, traditional nxagent keybindings.
File format
@@ -60,23 +68,34 @@ List of possible 'action' attributes:
-------------------------------------
close_session
+ This terminates the session.
switch_all_screens
minimize
+ This will minimize the client window (even for fullscreen sessions.)
left
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.
defer
+ Works like 'ignore' to make some keys be ignored/defunct inside the session.
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
+ Moves the image viewport up.
viewport_move_right
+ Moves the image viewport to the right.
viewport_move_down
+ Moves the image viewport down.
Only in builds with certain debugging options enabled, ignored otherwise:
force_synchronization
+ Forces the drawing of elements to be synchronized which can fix some visual bugs.
debug_tree
regions_on_screen
test_input