summaryrefslogtreecommitdiff
path: root/man/XSetDeviceValuators.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/XSetDeviceValuators.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/XSetDeviceValuators.txt')
-rw-r--r--man/XSetDeviceValuators.txt74
1 files changed, 74 insertions, 0 deletions
diff --git a/man/XSetDeviceValuators.txt b/man/XSetDeviceValuators.txt
new file mode 100644
index 0000000..1116cea
--- /dev/null
+++ b/man/XSetDeviceValuators.txt
@@ -0,0 +1,74 @@
+XSETDEVICEVALUATORS(libmansuffix)
+=================================
+
+NAME
+----
+
+ XSetDeviceValuators - initialize the valuators on an extension input device
+
+SYNOPSIS
+--------
+
+ #include <X11/extensions/XInput.h>
+
+ XSetDeviceValuators( Display *display,
+ XDevice *device,
+ int *valuators,
+ int first_valuator,
+ int num_valuators);
+
+ display
+ Specifies the connection to the X server.
+
+ device
+ Specifies the device whose valuators are to be
+ initialized.
+
+ valuators
+ Specifies a pointer to an array of integer values to be
+ used to initialize thedevice valuators.
+
+ first_valuator
+ Specifies the first valuator to be set. Valuators are
+ numbered beginning withzero.
+
+ num_valuators
+ Specifies the number of valuators to be set.
+
+DESCRIPTION
+-----------
+
+ The XSetDeviceValuators request sets the current values of the
+ valuators of an input device. The valuators in the range
+ first_valuator to (first_valuator + num_valuators) are set to
+ the specified values. Valuators are numbered beginning with 0.
+ Not all input devices support initialization of valuator
+ values. If this request is made to a device that does not
+ support valuators initialization, a BadMatch error will occur.
+
+ If the request succeeds, a status of Success is returned. If
+ another client has the device grabbed, a status of
+ AlreadyGrabbed is returned.
+
+ XSetDeviceValuators can generate a BadLength, BadDevice,
+ BadMatch, or BadValue error.
+
+DIAGNOSTICS
+-----------
+
+ BadDevice
+ An invalid device was specified. The specified device
+ does not exist or has not been opened by this client via
+ XOpenInputDevice.
+
+ BadMatch
+ This error may occur if an XSetDeviceValuators request
+ is made specifying a device that has no valuators and
+ reports no axes of motion, or if such a request is made
+ specifying a device that does not support valuator
+ initialization.
+
+ BadValue
+ An invalid first_valuator or num_valuators values was
+ specified.
+