summaryrefslogtreecommitdiff
path: root/man/XChangePointerDevice.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/XChangePointerDevice.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/XChangePointerDevice.txt')
-rw-r--r--man/XChangePointerDevice.txt79
1 files changed, 79 insertions, 0 deletions
diff --git a/man/XChangePointerDevice.txt b/man/XChangePointerDevice.txt
new file mode 100644
index 0000000..606b65e
--- /dev/null
+++ b/man/XChangePointerDevice.txt
@@ -0,0 +1,79 @@
+XCHANGEPOINTERDEVICE(libmansuffix)
+==================================
+
+NAME
+----
+
+ XChangePointerDevice - change which device is the X pointer
+
+SYNOPSIS
+--------
+
+ #include <X11/extensions/XInput.h>
+
+ Status XChangePointerDevice( Display *display,
+ XDevice *device,
+ int xaxis,
+ int yaxis);
+
+ display
+ Specifies the connection to the X server.
+
+ device
+ Specifies the device to be used as the X pointer.
+
+ xaxis
+ Specifies the axis of the device to be used as the X
+ pointer x-axis.
+
+ yaxis
+ Specifies the axis of the device to be used as the X
+ pointer y-axis.
+
+DESCRIPTION
+-----------
+
+ The XChangePointerDevice request causes the server to use the
+ specified device as the X pointer. The device must have been
+ opened by the client via XOpenDevice or a BadDevice error will
+ result. The device must support input class Valuators or a
+ BadMatch error will result. If the implementation does not
+ support use of the specified device as the X pointer, a
+ BadDevice error will result.
+
+ If the specified device is grabbed by another client,
+ AlreadyGrabbed is returned. If the specified device is frozen
+ by a grab on another device, GrabFrozen is returned. If the
+ request is successful, Success is returned.
+
+ If the request succeeds, a ChangeDeviceNotify event is sent to
+ all clients that have selected that event. A MappingNotify
+ event with request = MappingPointer is sent to all clients. The
+ specified device becomes the X pointer, and the old X pointer
+ becomes accessible through the input extension protocol
+ requests.
+
+ XChangePointerDevice can generate a BadDevice or a BadMatch
+ error.
+
+DIAGNOSTICS
+-----------
+
+ BadDevice
+ An invalid device was specified. The specified device
+ does not exist, has not been opened by this client via
+ XOpenInputDevice, or is already one of the core X input
+ devices (pointer or keyboard). This error may also occur
+ if the server implementation does not support using the
+ specified device as the X pointer.
+
+ BadMatch
+ This error may occur if an XChangePointerDevice request
+ was made specifying a device that has less than two
+ valuators, or specifying a valuator index beyond the
+ range supported by the device.
+
+SEE ALSO
+--------
+
+ XChangeKeyboardDevice(libmansuffix)