diplodocus.org Git - xorg-xinput/blob - man/xinput.man

   1 .TH xinput 1 __xorgversion__
   2
   3 .SH NAME
   4 xinput - utility to configure and test X input devices
   5
   6 .SH SYNOPSIS
   7 .B xinput [OPTIONS] [DEVICE]
   8
   9 .SH DESCRIPTION
  10 xinput is a utility to list available input devices, query information about
  11 a device and change input device settings.
  12 .SH OPTIONS
  13 .TP 8
  14 .B --version
  15 Test if the X Input extension is available and return the version number
  16 of the program and the version supported by the server. This option does not
  17 require a device name.
  18 .PP
  19 .TP 8
  20 .B --list [--short || --long || --name-only || --id-only] [\fIdevice\fP]
  21 If no argument is given list all the input devices. If an argument is given,
  22 show all the features of \fIdevice\fP.
  23 If --long is provided, the output includes detailed information about the
  24 capabilities of each devices. Otherwise, or if --short is provided, only the
  25 device names and some minimal information is listed.
  26 If --name-only is provided, the output is limited to the device names. One
  27 device name is listed per line. Note that the order the devices are listed
  28 is undefined.
  29 If --id-only is provided, the output is limited to the device IDs. One
  30 device ID is listed per line. Note that the order the devices are listed is
  31 undefined.
  32 .PP
  33 .TP 8
  34 .B --get-feedbacks \fIdevice\fP
  35 Display the feedbacks of \fIdevice\fP.
  36 .PP
  37 .TP 8
  38 .B --set-pointer \fIdevice\fP
  39 Switch \fIdevice\fP in core pointer.
  40 This option does nothing on X servers 1.5 and later.
  41 .PP
  42 .TP 8
  43 .B --set-mode \fIdevice\fP \fIABSOLUTE|RELATIVE\fP
  44 Change the mode of \fIdevice\fP.
  45 .PP
  46 .TP 8
  47 .B --set-ptr-feedback \fIdevice\fP \fIthreshold\fP \fInum\fP \fIdenom\fP
  48 Change the pointer acceleration (or feedback) parameters of \fIdevice\fP.
  49 The xset(__appmansuffix__) man page has more details. For X.Org Server 1.7
  50 and above, there are additional device properties pertaining to pointer
  51 acceleration. These do not replace, but complement the pointer feedback
  52 setting.
  53 .PP
  54 .TP 8
  55 .B --set-integer-feedback \fIdevice\fP \fIindex\fP \fIvalue\fP
  56 Change the value of an integer feedback of \fIdevice\fP.
  57 .PP
  58 .TP 8
  59 .B --set-button-map \fIdevice\fP \fImap_button_1\fP [\fImap_button_2\fP [\fI...\fP]]
  60 Change the button mapping of \fIdevice\fP. The buttons are specified in
  61 physical order (starting with button 1) and are mapped to the logical button
  62 provided. 0 disables a button. The default button mapping for a device is 1
  63 2 3 4 5 6 etc.
  64 .PP
  65 .TP 8
  66 .B --query-state \fIdevice\fP
  67 Query the device state.
  68 .PP
  69 .TP 8
  70 .B --list-props \fIdevice\fP [\fIdevice\fP [\fI...\fP]]
  71 Lists properties that can be set for the given device(s).
  72 .PP
  73 .TP 8
  74 .B --set-int-prop \fIdevice\fP \fIproperty\fP \fIformat\fP \fIvalue\fP
  75 Sets an integer property for the device.  Appropriate values for \fIformat\fP
  76 are 8, 16, or 32, depending on the property. Deprecated, use
  77 .B --set-prop
  78 instead.
  79 .PP
  80 .TP 8
  81 .B --set-float-prop \fIdevice\fP \fIproperty\fP \fIvalue\fP
  82 Sets a float property for the device. Deprecated, use
  83 .B --set-prop
  84 instead.
  85 .PP
  86 .TP 8
  87 .B --set\-prop [\-\-type=\fIatom|float|int\fP] [\-\-format=\fI8|16|32\fP] \fIdevice\fP \fIproperty\fP \fIvalue\fP [...]
  88 Set the property to the given value(s).  If not specified, the format and type
  89 of the property are left as-is.  The arguments are interpreted according to the
  90 property type. See Section \fICHANGING PROPERTIES\fP.
  91 .PP
  92 .TP 8
  93 .B --watch-props \fIdevice\fP
  94 Prints to standard out when property changes occur.
  95 .PP
  96 .TP 8
  97 .B --delete-prop \fIdevice\fP \fIproperty\fP
  98 Delete the property from the device.
  99 .PP
 100 .TP 8
 101 .B --test [-proximity] \fIdevice\fP
 102 Register all extended events from \fIdevice\fP and enter an endless
 103 loop displaying events received. If the -proximity is given, ProximityIn
 104 and ProximityOut are registered.
 105 .PP
 106 .TP 8
 107 .B --test-xi2 [--root] [\fIdevice\fP]
 108 Register for a number of XI2 events and display them. If a device is given,
 109 only events on this device are displayed. If --root is given, events are
 110 selected on the root window only. Otherwise, a new client window is created
 111 (similar to xev).
 112 .PP
 113 .TP 8
 114 .B --create-master \fIprefix\fP [sendCore] [enable]
 115 Create a new pair of master devices on an XI2-enabled server with the given
 116 \fIprefix\fP. The server will create one master pointer named "\fIprefix\fP
 117 pointer" and one master keyboard named "\fIprefix\fP keyboard".  If
 118 \fIsendCore\fP is 1, this pair of master devices is set to send core events
 119 (default).  If \fIenable\fP is 1, this master device pair will be enabled
 120 immediately (default).
 121 .PP
 122 .TP 8
 123 .B --remove-master \fImaster\fP [Floating|AttachToMaster] [returnPointer] [returnKeyboard]
 124 Remove \fImaster\fP  and its paired master device. Attached slave devices
 125 are set floating if \fIFloating\fP is specified or the argument is omitted.
 126 If the second argument is \fIAttachToMaster\fP, \fIreturnPointer\fP
 127 specifies the master pointer to attach all slave pointers to and
 128 \fIreturnKeyboard\fP specifies the master keyboard to attach all slave
 129 keyboards to.
 130 .PP
 131 .TP 8
 132 .B --reattach \fIslave\fP \fImaster\fP
 133 Reattach \fIslave\fP to \fImaster\fP.
 134 .PP
 135 .TP 8
 136 .B --float \fIslave\fP
 137 Remove \fIslave\fP from its current master device.
 138 .PP
 139 .TP 8
 140 .B --set-cp \fIwindow\fP \fImaster\fP
 141 Set the ClientPointer for the client owning \fIwindow\fP to \fImaster\fP.
 142 \fImaster\fP must specify a master pointer.
 143 .PP
 144 .TP 8
 145 .B --map-to-output \fIdevice\fP \fIcrtc\fP
 146 Restricts the movements of the absolute \fIdevice\fP to the RandR
 147 \fIcrtc\fP. The output name must match a currently connected output (see
 148 \fIxrandr(__appmansuffix__)\fP). If the NVIDIA binary driver is
 149 detected or RandR 1.2 or later is not available, a Xinerama output may be
 150 specified as "HEAD-N", with N being the Xinerama screen number. This option
 151 has no effect on relative devices.
 152 If crtc is set to "all", the default behavior is applied.
 153 .PP
 154 .TP 8
 155 .B --enable \fIdevice\fP
 156 Enable the \fIdevice\fP. This call is equivalent to
 157 .B xinput --set-prop device \fI"Device Enabled"\fP 1
 158 .PP
 159 .TP 8
 160 .B --disable \fIdevice\fP
 161 Disable the \fIdevice\fP. This call is equivalent to
 162 .B xinput --set-prop device \fI"Device Enabled"\fP 0
 163 .PP
 164 \fIdevice\fP can be the device name as a string or the XID of the
 165 device.
 166 .PP
 167 \fIslave\fP can be the device name as a string or the XID of a slave
 168 device.
 169 .PP
 170 \fImaster\fP can be the device name as a string or the XID of a master
 171 device.
 172 .PP
 173 \fIproperty\fP can be the property as a string or the Atom value.
 174 .PP
 175 .SH "CHANGING PROPERTIES"
 176 When xinput should modify an existing driver property value, it is
 177 sufficient to provide the device name and property name as string, followed
 178 by the new value(s) of the property. For example:
 179 .IP
 180 \fBxinput set-prop "my device" "my prop" 1 2 3\fB
 181
 182 .SH "XWAYLAND"
 183 Xwayland is an X server that uses a Wayland Compositor as backend.
 184 Xwayland acts as translation layer between the X protocol and the Wayland
 185 protocol but does not have direct access to the hardware. The X Input
 186 Extension devices created by Xwayland ("xwayland-pointer",
 187 "xwayland-keyboard", etc.) map to the Wayland protocol devices,
 188 not to physical devices.
 189 .PP
 190 These X Input Extension devices are only visible to other X clients
 191 connected to the same Xwayland process. Changing properties on Xwayland
 192 devices only affects the behavior of those clients. For example, disabling
 193 an Xwayland device with xinput does not disable the device in Wayland-native
 194 applications. Other changes may not have any effect at all.
 195 .PP
 196 In most instances, using xinput with an Xwayland device is indicative of a
 197 bug in a shell script and xinput will print a warning. Use the Wayland
 198 Compositor's native device configuration methods instead.
 199
 200 .SH "SEE ALSO"
 201 X(__miscmansuffix__), xset(__appmansuffix__), xrandr(__appmansuffix__)
 202 .SH COPYRIGHT
 203 Copyright 1996,1997, Frederic Lepied.
 204 .PP
 205 Copyright 2007, Peter Hutterer.
 206 .PP
 207 Copyright 2008, Philip Langdale.
 208 .PP
 209 Copyright 2009-2011, Red Hat, Inc.
 210
 211 .SH AUTHORS
 212
 213 .nf
 214 Peter Hutterer <peter.hutterer@who-t.net>
 215 Philip Langdale, <philipl@alumni.utexas.net>
 216 Frederic Lepied, France <Frederic.Lepied@sugix.frmug.org>
 217 Julien Cristau <jcristau@debian.org>
 218 Thomas Jaeger <ThJaeger@gmail.com>
 219 and more.
 220 .fi