aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Sibiller <uli42@gmx.de>2017-03-27 22:07:51 +0200
committerUlrich Sibiller <uli42@gmx.de>2017-04-03 21:28:11 +0200
commit9f0713c0433ab7b95b301b1cc3118ef4dbc3d8a7 (patch)
treecf0cce7ae577e4bb42d9ea16fa365f3086547b15
parente3240d6b3f9f5dc9ddcd41c24a3c2fbc394c3735 (diff)
downloadnx-libs-9f0713c0433ab7b95b301b1cc3118ef4dbc3d8a7.tar.gz
nx-libs-9f0713c0433ab7b95b301b1cc3118ef4dbc3d8a7.tar.bz2
nx-libs-9f0713c0433ab7b95b301b1cc3118ef4dbc3d8a7.zip
doc: document debugging keystrokes
-rw-r--r--doc/nxagent/README.keystrokes6
-rw-r--r--doc/nxagent/README.keystrokes.debug27
2 files changed, 27 insertions, 6 deletions
diff --git a/doc/nxagent/README.keystrokes b/doc/nxagent/README.keystrokes
index 96bc158d2..f9b4bf3a1 100644
--- a/doc/nxagent/README.keystrokes
+++ b/doc/nxagent/README.keystrokes
@@ -103,11 +103,5 @@ 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
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/doc/nxagent/README.keystrokes.debug b/doc/nxagent/README.keystrokes.debug
new file mode 100644
index 000000000..85ec2613a
--- /dev/null
+++ b/doc/nxagent/README.keystrokes.debug
@@ -0,0 +1,27 @@
+Configurable keybindings for debugging nxagent
+
+Some keystrokes are only available in special debug builds of nxagent
+and will be ignored otherwise. These are
+
+debug_tree
+ Show the window trees of both internal and external
+ windows. Included if DEBUG_TREE is defined.
+
+regions_on_screen
+ Make corrupted regions visible. Included if DUMP is defined.
+
+test_input
+ Activate/deactive input device debugging. Included if NX_DEBUG_INPUT
+ is defined.
+
+deactivate_input_devices_grab
+ Release grab of input devices. Included if NX_DEBUG_INPUT is
+ defined.
+
+They can be configured by adding these lines to keystrokes.cfg, below
+keystrokes represent the default:
+
+<keystroke action="debug_tree" Control="1" AltMeta="1" key="q" />
+<keystroke action="regions_on_screen" Control="1" AltMeta="1" key="a" />
+<keystroke action="test_input" Control="1" AltMeta="1" key="x" />
+<keystroke action="deactivate_input_devices_grab" Control="1" AltMeta="1" key="y" />