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