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] [\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 .PP
  27 .TP 8
  28 .B --get-feedbacks \fIdevice\fP
  29 Display the feedbacks of \fIdevice\fP.
  30 .PP
  31 .TP 8
  32 .B --set-pointer \fIdevice\fP
  33 Switch \fIdevice\fP in core pointer.
  34 This option does nothing on X servers 1.5 and later.
  35 .PP
  36 .TP 8
  37 .B --set-mode \fIdevice\fP \fIABSOLUTE|RELATIVE\fP
  38 Change the mode of \fIdevice\fP.
  39 .PP
  40 .TP 8
  41 .B --set-ptr-feedback \fIdevice\fP \fIthreshold\fP \fInum\fP \fIdenom\fP
  42 Change the pointer acceleration (or feedback) parameters of \fIdevice\fP.
  43 The xset(1) man page has more details. For X.Org Server 1.7
  44 and above, there are additional device properties pertaining to pointer
  45 acceleration. These do not replace, but complement the pointer feedback
  46 setting.
  47 .PP
  48 .TP 8
  49 .B --set-integer-feedback \fIdevice\fP \fIindex\fP \fIvalue\fP
  50 Change the value of an integer feedback of \fIdevice\fP.
  51 .PP
  52 .TP 8
  53 .B --set-button-map \fIdevice\fP \fImap_button_1\fP [\fImap_button_2\fP [\fI...\fP]]
  54 Change the button mapping of \fIdevice\fP. The buttons are specified in
  55 physical order (starting with button 1) and are mapped to the logical button
  56 provided. 0 disables a button. The default button mapping for a device is 1
  57 2 3 4 5 6 etc.
  58 .PP
  59 .TP 8
  60 .B --query-state \fIdevice\fP
  61 Query the device state.
  62 .PP
  63 .TP 8
  64 .B --list-props \fIdevice\fP [\fIdevice\fP [\fI...\fP]]
  65 Lists properties that can be set for the given device(s).
  66 .PP
  67 .TP 8
  68 .B --set-int-prop \fIdevice\fP \fIproperty\fP \fIformat\fP \fIvalue\fP
  69 Sets an integer property for the device.  Appropriate values for \fIformat\fP
  70 are 8, 16, or 32, depending on the property. Deprecated, use
  71 .B --set-prop
  72 instead.
  73 .PP
  74 .TP 8
  75 .B --set-float-prop \fIdevice\fP \fIproperty\fP \fIvalue\fP
  76 Sets a float property for the device. Deprecated, use
  77 .B --set-prop
  78 instead.
  79 .PP
  80 .TP 8
  81 .B --set\-prop [\-\-type=\fIatom|float|int\fP] [\-\-format=\fI8|16|32\fP] \fIdevice\fP \fIproperty\fP \fIvalue\fP [...]
  82 Set the property to the given value(s).  If not specified, the format and type
  83 of the property are left as-is.  The arguments are interpreted according to the
  84 property type.
  85 .PP
  86 .TP 8
  87 .B --watch-props \fIdevice\fP
  88 Prints to standard out when property changes occur.
  89 .PP
  90 .TP 8
  91 .B --delete-prop \fIdevice\fP \fIproperty\fP
  92 Delete the property from the device.
  93 .PP
  94 .TP 8
  95 .B --test [-proximity] \fIdevice\fP
  96 Register all extended events from \fIdevice\fP and enter an endless
  97 loop displaying events received. If the -proximity is given, ProximityIn
  98 and ProximityOut are registered.
  99 .PP
 100 .TP 8
 101 .B --test_xi2
 102 Register for a number of XI2 events and display them. This option does not
 103 take a device argument.
 104 .PP
 105 \fIdevice\fP can be the device name as a string or the XID of the
 106 device.
 107 .PP
 108 \fIproperty\fP can be the property as a string or the Atom value.
 109 .PP
 110 .SH "SEE ALSO"
 111 X(__miscmansuffix__), xset(1)
 112 .SH COPYRIGHT
 113 Copyright 1996,1997, Frederic Lepied.
 114 .PP
 115 Copyright 2008, Philip Langdale.
 116
 117 .SH AUTHORS
 118
 119 .nf
 120 Philip Langdale, <philipl@alumni.utexas.net>
 121 Frederic Lepied, France <Frederic.Lepied@sugix.frmug.org>
 122 Peter Hutterer <peter.hutterer@who-t.net>
 123 Julien Cristau <jcristau@debian.org>
 124 Thomas Jaeger <ThJaeger@gmail.com>
 125 and more.
 126 .fi