summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2011-10-27 10:27:49 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2011-11-11 14:51:00 +1000
commit323730f7fa70190d2ea00e62c6964fee524ca430 (patch)
tree7048cba58f75f3d5f61d52a5498d501a36f97440
parent5189df57e18c79327848fb117a8ede59868c8fdb (diff)
man: passive grabs return the number of failed modifier combinations
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
-rw-r--r--man/XIGrabButton.txt10
-rw-r--r--man/XIGrabEnter.txt10
2 files changed, 18 insertions, 2 deletions
diff --git a/man/XIGrabButton.txt b/man/XIGrabButton.txt
index 0a74f3d..5b14532 100644
--- a/man/XIGrabButton.txt
+++ b/man/XIGrabButton.txt
@@ -64,7 +64,7 @@ SYNOPSIS
or XIAnyKeycode.
num_modifiers
- Number of elements in modifiers or modifiers_return
+ Number of elements in modifiers or modifiers_inout.
modifiers
Specifies the set of latched and base modifiers or
@@ -178,6 +178,14 @@ DESCRIPTION
XIUngrabButton and XIUngrabKeycode can generate BadDevice,
BadMatch, BadValue and BadWindow errors.
+RETURN VALUE
+------------
+ XIGrabButton and XIGrabKeycode return the number of modifier combination
+ that could not establish a passive grab. The modifiers are returned in
+ modifiers_inout, along with the respective error for this modifier
+ combination. If XIGrabButton or XIGrabKeycode return zero, passive grabs
+ with all requested modifier combinations were established successfully.
+
DIAGNOSTICS
-----------
diff --git a/man/XIGrabEnter.txt b/man/XIGrabEnter.txt
index 83e97ca..5203f05 100644
--- a/man/XIGrabEnter.txt
+++ b/man/XIGrabEnter.txt
@@ -51,7 +51,7 @@ SYNOPSIS
Specifies the device that is to be grabbed or released
num_modifiers
- Number of elements in modifiers or modifiers_return
+ Number of elements in modifiers or modifiers_inout.
modifiers
Specifies the set of latched and base modifiers or
@@ -152,6 +152,14 @@ DESCRIPTION
XIUngrabEnter and XIUngrabFocusIn can generate BadDevice,
BadMatch, BadValue and BadWindow errors.
+RETURN VALUE
+------------
+ XIGrabEnter and XIGrabFocusIn return the number of modifier combination
+ that could not establish a passive grab. The modifiers are returned in
+ modifiers_inout, along with the respective error for this modifier
+ combination. If XIGrabEnter or XIGrabFocusIn return zero, passive grabs
+ with all requested modifier combinations were established successfully.
+
DIAGNOSTICS
-----------