summaryrefslogtreecommitdiff
path: root/man/XISelectEvents.txt
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2009-05-15 14:16:31 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2009-05-18 10:53:35 +1000
commit615545f9cba36ab7732d2325970a7c84b2fa6e8c (patch)
tree925b1d6ee89ae892c1f5ccc3d73cd86c39dd64ed /man/XISelectEvents.txt
parent9966ab40b850c780e439f86e165188919f884b64 (diff)
Switch man pages to asciidoc.
The docbook xml is unreadable and unwritable. Switch everything to asciidoc, at least thay we we can write man pages without losing sanity. asciidoc seems to have some issues with __libmansuffix__, so instead we just use libmansuffix (without underscores). The current asciidoc version is buggy for multiple man targets (more than one man page in a single file), so stick a big warning into configure that a patch is required to the the right asciidoc->docbook conversion. Many thanks to Dan Nicholson for the Makefile.am. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'man/XISelectEvents.txt')
-rw-r--r--man/XISelectEvents.txt75
1 files changed, 75 insertions, 0 deletions
diff --git a/man/XISelectEvents.txt b/man/XISelectEvents.txt
new file mode 100644
index 0000000..a822fb3
--- /dev/null
+++ b/man/XISelectEvents.txt
@@ -0,0 +1,75 @@
+XISELECTEVENTS(libmansuffix)
+============================
+
+NAME
+----
+
+ XISelectEvents - select for XI2 events on the window.
+
+SYNOPSIS
+--------
+
+ #include <X11/extensions/XInput2.h>
+
+ Status XISelectEvents( Display *display,
+ Window win,
+ XIEventMask *masks,
+ int num_masks);
+
+ display
+ Specifies the connection to the X server.
+
+ masks
+ Device event mask.
+
+ num_masks
+ Number of masks in masks.
+
+ win
+ Specifies the window.
+
+DESCRIPTION
+-----------
+
+ XI2 events must be selected using XISelectEvents.
+
+ XISelectEvents sets the event mask for this client on win.
+ Further events are only reported to this client if the event
+ type matches the selected event mask. The masks overrides the
+ previously selected event mask for the given device.
+
+ If deviceid is a valid device, the event mask is selected only
+ for this device. If deviceid is XIAllDevices or
+ XIAllMasterDevices, the event mask is selected for all devices
+ or all master devices, respectively. The effective event mask
+ is the bit-wise OR of the XIAllDevices, XIAllMasterDevices and
+ the respective device's event mask.
+
+ typedef struct {
+ int deviceid;
+ int mask_len;
+ unsigned char* mask;
+ } XIEventMask;
+
+ The mask_len specifies the length of mask in bytes. mask is a
+ binary mask in the form of (1 << event type). deviceid must be
+ either a device or XIAllDevices or XIAllMasterDevices. A client
+ may submit several masks with the same deviceid in one request
+ but only the last mask will be effective.
+
+ XISelectEvents can generate a BadValue, a BadDevice, and a
+ BadWindow error.
+
+DIAGNOSTICS
+-----------
+
+ BadValue
+ A value is outside of the permitted range.
+
+ BadWindow
+ A value for a Window argument does not name a defined
+ window.
+
+ BadDevice
+ An invalid device was specified. The device does not
+ exist.