X2Go Bug report logs - #74
make nxagent keybindings configurable

Full log

🔗 View this message in rfc822 format

X-Loop: git-admin@x2go.org
Subject: Bug#74: add documentation for keystrokes
Reply-To: Alexander Wuerstlein <arw@arw.name>, 74@bugs.x2go.org
Resent-From: Alexander Wuerstlein <arw@arw.name>
Resent-To: x2go-dev@lists.berlios.de
Resent-CC: git-admin@x2go.org
X-Loop: git-admin@x2go.org
Resent-Date: Mon, 03 Dec 2012 14:48:02 +0000
Resent-Message-ID: <handler.74.B74.135454574212676@bugs.x2go.org>
Resent-Sender: git-admin@x2go.org
X-X2Go-PR-Message: followup 74
X-X2Go-PR-Package: nxagent
X-X2Go-PR-Keywords: 
Received: via spool by 74-submit@bugs.x2go.org id=B74.135454574212676
          (code B ref 74); Mon, 03 Dec 2012 14:48:02 +0000
Received: (at 74) by bugs.x2go.org; 3 Dec 2012 14:42:22 +0000
Received: from faui03.informatik.uni-erlangen.de (faui03.informatik.uni-erlangen.de [IPv6:2001:638:a000:4130:131:188:30:103])
	by ymir (Postfix) with ESMTPS id 3F29A5DA79
	for <74@bugs.x2go.org>; Mon,  3 Dec 2012 15:42:22 +0100 (CET)
Received: from faui03c.informatik.uni-erlangen.de (faui03c.informatik.uni-erlangen.de [131.188.30.218])
	by faui03.informatik.uni-erlangen.de (Postfix) with ESMTP id 18CDD683943;
	Mon,  3 Dec 2012 15:42:22 +0100 (CET)
Received: by faui03c.informatik.uni-erlangen.de (Postfix, from userid 31763)
	id 17AE74F208B; Mon,  3 Dec 2012 15:42:22 +0100 (CET)
From: Alexander Wuerstlein <arw@arw.name>
To: 74@bugs.x2go.org
Cc: Alexander Wuerstlein <arw@arw.name>
Date: Mon,  3 Dec 2012 15:42:12 +0100
Message-Id: <1354545732-28961-2-git-send-email-arw@arw.name>
X-Mailer: git-send-email 1.7.10.4
In-Reply-To: <1354545732-28961-1-git-send-email-arw@arw.name>
References: <1354545732-28961-1-git-send-email-arw@arw.name>

---
 README.keystrokes |   83 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 README.keystrokes

diff --git a/README.keystrokes b/README.keystrokes
new file mode 100644
index 0000000..519ffba
--- /dev/null
+++ b/README.keystrokes
@@ -0,0 +1,83 @@
+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 searches for the configuration file in the following order:
+- in the location given by the '-keystrokefile' command line parameter
+- in the location given by the NXAGENT_KEYSTROKEFILE environment variable
+- in ~/.nx/config/keystroke.cfg
+- in /etc/nx/keystroke.cfg
+
+If none of those files is 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:
+
+<!DOCTYPE NXKeystroke>
+<keystrokes>
+	<keystroke action="fullscreen" AltMeta="1" Control="1" key="b" />
+	<keystroke action="minimize" AltMeta="1" Control="1" key="space" />
+	<keystroke action="minimize" key="Escape" Shift="1" />
+	<keystroke action="close_session" key="F7" />
+	<keystroke action="fullscreen" key="F7" Mod1="1" />
+	<keystroke action="fullscreen" key="F6" Mod1="1" />
+	<keystroke action="force_synchronization" key="f" />
+	<keystroke action="fullscreen" key="space" Mod1="0" Mod2="0" Control="0" Shift="0" AltMeta="0" />
+</keystrokes>
+
+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
+switch_all_screens
+minimize
+left
+up
+right
+down
+resize
+defer
+ignore
+fullscreen
+viewport_move_left
+viewport_move_up
+viewport_move_right
+viewport_move_down
+
+Only in builds with certain debugging options enabled, ignored otherwise:
+force_synchronization
+debug_tree
+regions_on_screen
+test_input
+deactivate_input_devices_grab
-- 
1.7.10.4

Send a report that this bug log contains spam.