From 754d33d81590ffe5831b28312ee16d9db7ef7db8 Mon Sep 17 00:00:00 2001 From: Mike Gabriel Date: Tue, 5 Jul 2016 22:17:51 +0200 Subject: README.keystrokes: Move from base folder to doc/nxagent/. --- README.keystrokes | 102 ------------------------------------------ debian/nxagent.docs | 2 +- doc/nxagent/README.keystrokes | 102 ++++++++++++++++++++++++++++++++++++++++++ nx-libs.spec | 1 + 4 files changed, 104 insertions(+), 103 deletions(-) delete mode 100644 README.keystrokes create mode 100644 doc/nxagent/README.keystrokes diff --git a/README.keystrokes b/README.keystrokes deleted file mode 100644 index 08cdafb46..000000000 --- a/README.keystrokes +++ /dev/null @@ -1,102 +0,0 @@ -Configurable keybindings in nxagent - -Keybindings in the redistributed x2go version of nxagent can now be configured -by the user. This is done via a configuration file. - -File location -------------- - -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 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 ------------ - -The configuration file is XML with the following format: - - - - - - - - - - - - - -Each 'action' defines an action to be executed when receiving that keystroke. A -list of possible actions is given below. Some of those actions are only -available with debug builds of nxagent. - -Keys are given as a combination of 'key' and (optionally) a number of -modifiers. The key attribute is evaluated into a X11 key via the usual -XStringToKeysym function. A list of possible keys can be found in -/usr/include/X11/keysymdef.h, the names are specified without the leading -'XK_'. Evaluation is case-sensitive, so, 'space' and 'Escape' will work while -'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 -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. - -Everything in this file is case-sensitive. Unknown lines are ignored. -Keybindings are evaluated from top to bottom, so if a keybinding matches, other -keybindings further down will be ignored. The contents of the file replaces the -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. - -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 -deactivate_input_devices_grab diff --git a/debian/nxagent.docs b/debian/nxagent.docs index 5d7d87aed..adb5f1bb3 100644 --- a/debian/nxagent.docs +++ b/debian/nxagent.docs @@ -1 +1 @@ -README.keystrokes \ No newline at end of file +doc/nxagent/README.keystrokes \ No newline at end of file diff --git a/doc/nxagent/README.keystrokes b/doc/nxagent/README.keystrokes new file mode 100644 index 000000000..08cdafb46 --- /dev/null +++ b/doc/nxagent/README.keystrokes @@ -0,0 +1,102 @@ +Configurable keybindings in nxagent + +Keybindings in the redistributed x2go version of nxagent can now be configured +by the user. This is done via a configuration file. + +File location +------------- + +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 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 +----------- + +The configuration file is XML with the following format: + + + + + + + + + + + + + +Each 'action' defines an action to be executed when receiving that keystroke. A +list of possible actions is given below. Some of those actions are only +available with debug builds of nxagent. + +Keys are given as a combination of 'key' and (optionally) a number of +modifiers. The key attribute is evaluated into a X11 key via the usual +XStringToKeysym function. A list of possible keys can be found in +/usr/include/X11/keysymdef.h, the names are specified without the leading +'XK_'. Evaluation is case-sensitive, so, 'space' and 'Escape' will work while +'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 +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. + +Everything in this file is case-sensitive. Unknown lines are ignored. +Keybindings are evaluated from top to bottom, so if a keybinding matches, other +keybindings further down will be ignored. The contents of the file replaces the +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. + +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 +deactivate_input_devices_grab diff --git a/nx-libs.spec b/nx-libs.spec index 73a9017cd..7328ccf9c 100644 --- a/nx-libs.spec +++ b/nx-libs.spec @@ -573,6 +573,7 @@ rm -r %{buildroot}%{_includedir}/nx-X11/Xtrans %config(noreplace) %{_sysconfdir}/nxagent/keystrokes.cfg %config(noreplace) %{_sysconfdir}/nxagent/nxagent.keyboard %config(noreplace) %{_sysconfdir}/nxagent/rgb +%doc doc/nxagent/README.keystrokes %{_bindir}/nxagent %dir %{_libdir}/nx/bin %{_libdir}/nx/bin/nxagent -- cgit v1.2.3