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] [\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 .PP
  30 .TP 8
  31 .B --get-feedbacks \fIdevice\fP
  32 Display the feedbacks of \fIdevice\fP.
  33 .PP
  34 .TP 8
  35 .B --set-pointer \fIdevice\fP
  36 Switch \fIdevice\fP in core pointer.
  37 This option does nothing on X servers 1.5 and later.
  38 .PP
  39 .TP 8
  40 .B --set-mode \fIdevice\fP \fIABSOLUTE|RELATIVE\fP
  41 Change the mode of \fIdevice\fP.
  42 .PP
  43 .TP 8
  44 .B --set-ptr-feedback \fIdevice\fP \fIthreshold\fP \fInum\fP \fIdenom\fP
  45 Change the pointer acceleration (or feedback) parameters of \fIdevice\fP.
  46 The xset(1) man page has more details. For X.Org Server 1.7
  47 and above, there are additional device properties pertaining to pointer
  48 acceleration. These do not replace, but complement the pointer feedback
  49 setting.
  50 .PP
  51 .TP 8
  52 .B --set-integer-feedback \fIdevice\fP \fIindex\fP \fIvalue\fP
  53 Change the value of an integer feedback of \fIdevice\fP.
  54 .PP
  55 .TP 8
  56 .B --set-button-map \fIdevice\fP \fImap_button_1\fP [\fImap_button_2\fP [\fI...\fP]]
  57 Change the button mapping of \fIdevice\fP. The buttons are specified in
  58 physical order (starting with button 1) and are mapped to the logical button
  59 provided. 0 disables a button. The default button mapping for a device is 1
  60 2 3 4 5 6 etc.
  61 .PP
  62 .TP 8
  63 .B --query-state \fIdevice\fP
  64 Query the device state.
  65 .PP
  66 .TP 8
  67 .B --list-props \fIdevice\fP [\fIdevice\fP [\fI...\fP]]
  68 Lists properties that can be set for the given device(s).
  69 .PP
  70 .TP 8
  71 .B --set-int-prop \fIdevice\fP \fIproperty\fP \fIformat\fP \fIvalue\fP
  72 Sets an integer property for the device.  Appropriate values for \fIformat\fP
  73 are 8, 16, or 32, depending on the property. Deprecated, use
  74 .B --set-prop
  75 instead.
  76 .PP
  77 .TP 8
  78 .B --set-float-prop \fIdevice\fP \fIproperty\fP \fIvalue\fP
  79 Sets a float property for the device. Deprecated, use
  80 .B --set-prop
  81 instead.
  82 .PP
  83 .TP 8
  84 .B --set\-prop [\-\-type=\fIatom|float|int\fP] [\-\-format=\fI8|16|32\fP] \fIdevice\fP \fIproperty\fP \fIvalue\fP [...]
  85 Set the property to the given value(s).  If not specified, the format and type
  86 of the property are left as-is.  The arguments are interpreted according to the
  87 property type.
  88 .PP
  89 .TP 8
  90 .B --watch-props \fIdevice\fP
  91 Prints to standard out when property changes occur.
  92 .PP
  93 .TP 8
  94 .B --delete-prop \fIdevice\fP \fIproperty\fP
  95 Delete the property from the device.
  96 .PP
  97 .TP 8
  98 .B --test [-proximity] \fIdevice\fP
  99 Register all extended events from \fIdevice\fP and enter an endless
 100 loop displaying events received. If the -proximity is given, ProximityIn
 101 and ProximityOut are registered.
 102 .PP
 103 .TP 8
 104 .B --test-xi2
 105 Register for a number of XI2 events and display them. This option does not
 106 take a device argument.
 107 .PP
 108 .TP 8
 109 .B --create-master \fIprefix\fP [sendCore] [enable]
 110 Create a new pair of master devices on an XI2-enabled server with the given
 111 \fIprefix\fP. The server will create one master pointer named "\fIprefix\fP
 112 pointer" and one master keyboard named "\fIprefix\fP keyboard".  If
 113 \fIsendCore\fP is 1, this pair of master devices is set to send core events
 114 (default).  If \fIenable\fP is 1, this master device pair will be enabled
 115 immediately (default).
 116 .PP
 117 .TP 8
 118 .B --remove-master \fImaster\fP [Floating|AttachToMaster] [returnPointer] [returnKeyboard]
 119 Remove \fImaster\fP  and its paired master device. Attached slave devices
 120 are set floating if \fIFloating\fP is specified or the argument is omitted.
 121 If the second argument is \fIAttachToMaster\fP, \fIreturnPointer\fP
 122 specifies the master pointer to attach all slave pointers to and
 123 \fIreturnKeyboard\fP specifies the master keyboard to attach all slave
 124 keyboards to.
 125 .PP
 126 .TP 8
 127 .B --reattach \fIslave\fP \fImaster\fP
 128 Reattach \fIslave\fP to \fImaster\fP.
 129 .PP
 130 .TP 8
 131 .B --float \fIslave\fP
 132 Remove \fIslave\fP from its current master device.
 133 .PP
 134 .TP 8
 135 .B --set-cp \fIwindow\fP \fImaster\fP
 136 Set the ClientPointer for the client owning \fIwindow\fP to \fImaster\fP.
 137 \fImaster\fP must specify a master pointer.
 138 .PP
 139 \fIdevice\fP can be the device name as a string or the XID of the
 140 device.
 141 .PP
 142 \fIslave\fP can be the device name as a string or the XID of a slave
 143 device.
 144 .PP
 145 \fImaster\fP can be the device name as a string or the XID of a master
 146 device.
 147 .PP
 148 \fIproperty\fP can be the property as a string or the Atom value.
 149 .PP
 150 .SH "SEE ALSO"
 151 X(__miscmansuffix__), xset(1)
 152 .SH COPYRIGHT
 153 Copyright 1996,1997, Frederic Lepied.
 154 .PP
 155 Copyright 2008, Philip Langdale.
 156
 157 .SH AUTHORS
 158
 159 .nf
 160 Philip Langdale, <philipl@alumni.utexas.net>
 161 Frederic Lepied, France <Frederic.Lepied@sugix.frmug.org>
 162 Peter Hutterer <peter.hutterer@who-t.net>
 163 Julien Cristau <jcristau@debian.org>
 164 Thomas Jaeger <ThJaeger@gmail.com>
 165 and more.
 166 .fi