1xinput(1) General Commands Manual xinput(1)
2
6 xinput - utility to configure and test X input devices
7
10 xinput [OPTIONS] [DEVICE]
11
14 xinput is a utility to list available input devices, query information
15 about a device and change input device settings.
16
18 --version
19 Test if the X Input extension is available and return the ver‐
20 sion number of the program and the version supported by the
21 server. This option does not require a device name.
22 --list [--short || --long || --name-only || --id-only] [device]
24 If no argument is given list all the input devices. If an argu‐
25 ment is given, show all the features of device. If --long is
26 provided, the output includes detailed information about the
27 capabilities of each devices. Otherwise, or if --short is pro‐
28 vided, only the device names and some minimal information is
29 listed. If --name-only is provided, the output is limited to
30 the device names. One device name is listed per line. Note that
31 the order the devices are listed is undefined. If --id-only is
32 provided, the output is limited to the device IDs. One device
33 ID is listed per line. Note that the order the devices are
34 listed is undefined.
35 --get-feedbacks device
37 Display the feedbacks of device.
38 --set-pointer device
40 Switch device in core pointer. This option does nothing on X
41 servers 1.5 and later.
42 --set-mode device ABSOLUTE|RELATIVE
44 Change the mode of device.
45 --set-ptr-feedback device threshold num denom
47 Change the pointer acceleration (or feedback) parameters of
48 device. The xset(1) man page has more details. For X.Org
49 Server 1.7 and above, there are additional device properties
50 pertaining to pointer acceleration. These do not replace, but
51 complement the pointer feedback setting.
52 --set-integer-feedback device index value
54 Change the value of an integer feedback of device.
55 --set-button-map device map_button_1 [map_button_2 [...]]
57 Change the button mapping of device. The buttons are specified
58 in physical order (starting with button 1) and are mapped to
59 the logical button provided. 0 disables a button. The default
60 button mapping for a device is 1 2 3 4 5 6 etc.
61 --query-state device
63 Query the device state.
64 --list-props device [device [...]]
66 Lists properties that can be set for the given device(s).
67 --set-int-prop device property format value
69 Sets an integer property for the device. Appropriate values
70 for format are 8, 16, or 32, depending on the property. Depre‐
71 cated, use --set-prop instead.
72 --set-float-prop device property value
74 Sets a float property for the device. Deprecated, use --set-
75 prop instead.
76 --set-prop [--type=atom|float|int] [--format=8|16|32] device property
78 value [...]
79 Set the property to the given value(s). If not specified, the
80 format and type of the property are left as-is. The arguments
81 are interpreted according to the property type. See Section
82 CHANGING PROPERTIES.
83 --watch-props device
85 Prints to standard out when property changes occur.
86 --delete-prop device property
88 Delete the property from the device.
89 --test [-proximity] device
91 Register all extended events from device and enter an endless
92 loop displaying events received. If the -proximity is given,
93 ProximityIn and ProximityOut are registered.
94 --test-xi2 [--root] [device]
96 Register for a number of XI2 events and display them. If a
97 device is given, only events on this device are displayed. If
98 --root is given, events are selected on the root window only.
99 Otherwise, a new client window is created (similar to xev).
100 --create-master prefix [sendCore] [enable]
102 Create a new pair of master devices on an XI2-enabled server
103 with the given prefix. The server will create one master
104 pointer named "prefix pointer" and one master keyboard named
105 "prefix keyboard". If sendCore is 1, this pair of master
106 devices is set to send core events (default). If enable is 1,
107 this master device pair will be enabled immediately (default).
108 --remove-master master [Floating|AttachToMaster] [returnPointer]
110 [returnKeyboard]
111 Remove master and its paired master device. Attached slave
112 devices are set floating if Floating is specified or the argu‐
113 ment is omitted. If the second argument is AttachToMaster,
114 returnPointer specifies the master pointer to attach all slave
115 pointers to and returnKeyboard specifies the master keyboard to
116 attach all slave keyboards to.
117 --reattach slave master
119 Reattach slave to master.
120 --float slave
122 Remove slave from its current master device.
123 --set-cp window master
125 Set the ClientPointer for the client owning window to master.
126 master must specify a master pointer.
127 --map-to-output device crtc
129 Restricts the movements of the absolute device to the RandR
130 crtc. The output name must match a currently connected output
131 (see xrandr(1)). If the NVIDIA binary driver is detected or
132 RandR 1.2 or later is not available, a Xinerama output may be
133 specified as "HEAD-N", with N being the Xinerama screen number.
134 This option has no effect on relative devices.
135 --enable device
137 Enable the device. This call is equivalent to xinput --set-prop
138 device "Device Enabled" 1
139 --disable device
141 Disable the device. This call is equivalent to xinput --set-
142 prop device "Device Enabled" 0
143 device can be the device name as a string or the XID of the device.
145 slave can be the device name as a string or the XID of a slave device.
147 master can be the device name as a string or the XID of a master
149 device.
150 property can be the property as a string or the Atom value.
152
154 When xinput should modify an existing driver property value, it is suf‐
155 ficient to provide the device name and property name as string, fol‐
156 lowed by the new value(s) of the property. For example:
157 xinput set-prop "my device" "my prop" 1 2 3
159
162 Xwayland is an X server that uses a Wayland Compositor as backend.
163 Xwayland acts as translation layer between the X protocol and the Way‐
164 land protocol but does not have direct access to the hardware. The X
165 Input Extension devices created by Xwayland ("xwayland-pointer", "xway‐
166 land-keyboard", etc.) map to the Wayland protocol devices, not to phys‐
167 ical devices.
168 These X Input Extension devices are only visible to other X clients
170 connected to the same Xwayland process. Changing properties on Xwayland
171 devices only affects the behavior of those clients. For example, dis‐
172 abling an Xwayland device with xinput does not disable the device in
173 Wayland-native applications. Other changes may not have any effect at
174 all.
175 In most instances, using xinput with an Xwayland device is indicative
177 of a bug in a shell script and xinput will print a warning. Use the
178 Wayland Compositor's native device configuration methods instead.
179
182 X(7), xset(1), xrandr(1)
183
185 Copyright 1996,1997, Frederic Lepied.
186 Copyright 2007, Peter Hutterer.
188 Copyright 2008, Philip Langdale.
190 Copyright 2009-2011, Red Hat, Inc.
192
195 Peter Hutterer <peter.hutterer@who-t.net>
196 Philip Langdale, <philipl@alumni.utexas.net>
197 Frederic Lepied, France <Frederic.Lepied@sugix.frmug.org>
198 Julien Cristau <jcristau@debian.org>
199 Thomas Jaeger <ThJaeger@gmail.com>
200 and more.
201X Version 11 xinput 1.6.3 xinput(1)