1xinput(1)                   General Commands Manual                  xinput(1)
2
3
4

NAME

6       xinput - utility to configure and test X input devices
7
8

SYNOPSIS

10       xinput [OPTIONS] [DEVICE]
11
12

DESCRIPTION

14       xinput  is a utility to list available input devices, query information
15       about a device and change input device settings.
16

OPTIONS

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
23       --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
36       --get-feedbacks device
37               Display the feedbacks of device.
38
39       --set-pointer device
40               Switch device in core pointer.  This option does nothing  on  X
41               servers 1.5 and later.
42
43       --set-mode device ABSOLUTE|RELATIVE
44               Change the mode of device.
45
46       --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
53       --set-integer-feedback device index value
54               Change the value of an integer feedback of device.
55
56       --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
62       --query-state device
63               Query the device state.
64
65       --list-props device [device [...]]
66               Lists properties that can be set for the given device(s).
67
68       --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
73       --set-float-prop device property value
74               Sets a float property for the device.  Deprecated,  use  --set-
75               prop instead.
76
77       --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.
82
83       --watch-props device
84               Prints to standard out when property changes occur.
85
86       --delete-prop device property
87               Delete the property from the device.
88
89       --test [-proximity] device
90               Register all extended events from device and enter  an  endless
91               loop  displaying  events  received. If the -proximity is given,
92               ProximityIn and ProximityOut are registered.
93
94       --test-xi2 [--root] [device]
95               Register for a number of XI2 events  and  display  them.  If  a
96               device  is  given, only events on this device are displayed. If
97               --root is given, events are selected on the root  window  only.
98               Otherwise, a new client window is created (similar to xev).
99
100       --create-master prefix [sendCore] [enable]
101               Create  a  new  pair of master devices on an XI2-enabled server
102               with the given  prefix.  The  server  will  create  one  master
103               pointer  named  "prefix  pointer" and one master keyboard named
104               "prefix keyboard".  If sendCore  is  1,  this  pair  of  master
105               devices  is set to send core events (default).  If enable is 1,
106               this master device pair will be enabled immediately (default).
107
108       --remove-master   master   [Floating|AttachToMaster]    [returnPointer]
109       [returnKeyboard]
110               Remove  master   and  its  paired master device. Attached slave
111               devices are set floating if Floating is specified or the  argu‐
112               ment  is  omitted.   If  the second argument is AttachToMaster,
113               returnPointer specifies the master pointer to attach all  slave
114               pointers to and returnKeyboard specifies the master keyboard to
115               attach all slave keyboards to.
116
117       --reattach slave master
118               Reattach slave to master.
119
120       --float slave
121               Remove slave from its current master device.
122
123       --set-cp window master
124               Set the ClientPointer for the client owning window  to  master.
125               master must specify a master pointer.
126
127       --map-to-output device crtc
128               Restricts  the  movements  of  the absolute device to the RandR
129               crtc. The output name must match a currently  connected  output
130               (see  xrandr(1)).  If  the  NVIDIA binary driver is detected or
131               RandR 1.2 or later is not available, a Xinerama output  may  be
132               specified as "HEAD-N", with N being the Xinerama screen number.
133               This option has no effect on relative devices.
134
135       --enable device
136               Enable the device. This call is equivalent to xinput --set-prop
137               device "Device Enabled" 1
138
139       --disable device
140               Disable  the  device.  This call is equivalent to xinput --set-
141               prop device "Device Enabled" 0
142
143       device can be the device name as a string or the XID of the device.
144
145       slave can be the device name as a string or the XID of a slave device.
146
147       master can be the device name as a  string  or  the  XID  of  a  master
148       device.
149
150       property can be the property as a string or the Atom value.
151

SEE ALSO

153       X(7), xset(1), xrandr(1)
154
156       Copyright 1996,1997, Frederic Lepied.
157
158       Copyright 2007, Peter Hutterer.
159
160       Copyright 2008, Philip Langdale.
161
162       Copyright 2009-2011, Red Hat, Inc.
163
164

AUTHORS

166       Peter Hutterer <peter.hutterer@who-t.net>
167       Philip Langdale, <philipl@alumni.utexas.net>
168       Frederic Lepied, France <Frederic.Lepied@sugix.frmug.org>
169       Julien Cristau <jcristau@debian.org>
170       Thomas Jaeger <ThJaeger@gmail.com>
171       and more.
172
173
174
175X Version 11                     xinput 1.6.2                        xinput(1)
Impressum