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

   1 .\" $Id: xinput.man,v 1.5 1997/06/09 16:06:31 fred Exp $
   2 .TH xinput 1 __xorgversion__
   3
   4 .SH NAME
   5 xinput - utility to configure and test XInput devices
   6
   7 .SH SYNOPSIS
   8 .B xinput
   9 [version]
  10 [list [--short || --long] [\fIdevice_name\fP]]
  11 [set-pointer \fIdevice_name\fP]
  12 [get-feedbacks \fIdevice_name\fP]
  13 [set-mode \fIdevice_name\fP \fIABSOLUTE|RELATIVE\fP]
  14 [set-ptr-feedback \fIdevice_name\fP \fIthreshold\fP \fInum\fP \fIdenom\fP]
  15 [set-integer-feedback \fIdevice_name\fP \fIindex\fP \fIvalue\fP]
  16 [set-button-map \fIdevice_name\fP \fImap button 1\fP [\fImap button 2\fP [\fI...\fP]]]
  17 [query-state \fIdevice_name\fP]
  18 [test [-proximity] \fIdevice_name\fP]
  19
  20 .SH DESCRIPTION
  21 .TP 8
  22 .B xinput version
  23 test if the XInput extension is available and return the version number
  24 of the program.
  25 .PP
  26 .TP 8
  27 .B xinput list [--short || --long] [\fIdevice_name\fP]
  28 If no argument is given list all the input devices. If an argument is given,
  29 show all the features of \fIdevice_name\fP. Uses XListInputDevices(3).
  30 If --long is provided, the output includes detailed information about the
  31 capabilities of each devices. Otherwise, or if --short is provided, only the
  32 device names and some minimal information is listed.
  33 .PP
  34 .TP 8
  35 .B xinput get-feedbacks \fIdevice_name\fP
  36 Display the feedbacks of \fIdevice_name\fP. Uses XGetFeedbackControl(3).
  37 .PP
  38 .TP 8
  39 .B xinput set-pointer \fIdevice_name\fP
  40 Switch \fIdevice_name\fP in core pointer. Uses XChangePointerDevice(3).
  41 .PP
  42 .TP 8
  43 .B xinput set-mode \fIdevice_name\fP \fIABSOLUTE|RELATIVE\fP
  44 Change the mode of \fIdevice_name\fP. Uses XSetDeviceMode(3).
  45 .PP
  46 .TP 8
  47 .B xinput set-ptr-feedback \fIdevice_name\fP \fIthreshold\fP \fInum\fP \fIdenom\fP
  48 Change the acceleration of \fIdevice_name\fP. Uses XChangeFeedbackControl(3).
  49 .PP
  50 .TP 8
  51 .B xinput set-integer-feedback \fIdevice_name\fP \fIindex\fP \fIvalue\fP
  52 Change the value of an integer feedback of \fIdevice_name\fP. Uses XChangeFeedbackControl(3).
  53 .PP
  54 .TP 8
  55 .B xinput set-button-map \fIdevice_name\fP \fImap button 1\fP [\fImap button 2\fP [\fI...\fP]]
  56 Change the button mapping of \fIdevice_name\fP. Uses XSetDeviceButtonMapping(3).
  57 .PP
  58 .TP 8
  59 .B xinput query-state \fIdevice_name\fP
  60 Query the device state. Uses XQueryDeviceState(3).
  61 .PP
  62 .TP 8
  63 .B xinput list-props \fIdevice_name\fP [\fIdevice_name\fP...]
  64 Lists properties that can be set for the given device(s).
  65 .PP
  66 .TP 8
  67 .B xinput set-int-prop \fIdevice_name\fP \fIproperty\fP \fIformat\fP \fIvalue\fP
  68 Sets an integer property for the device.  Appropriate values for \fIformat\fP
  69 are 8, 16, or 32, depending on the property.
  70 .PP
  71 .TP 8
  72 .B xinput set-float-prop \fIdevice_name\fP \fIproperty\fP \fIvalue\fP
  73 Sets a float property for the device.
  74 .PP
  75 .TP 8
  76 .B xinput set\-prop [\-\-type=\fIatom|float|int\fP] [\-\-format=\fI8|16|32\fP] \fIdevice_name\fP \fIproperty\fP \fIvalue\fP [...]
  77 Set the property to the given value(s).  If not specified, the format and type
  78 of the property are left as-is.  The arguments are interpreted according to the
  79 property type.
  80 .PP
  81 .TP 8
  82 .B xinput watch-props \fIdevice_name\fP
  83 Prints to standard out when property changes occur.
  84 .PP
  85 .TP 8
  86 .B xinput delete-prop \fIdevice_name\fP \fIproperty\fP
  87 Delete the property from the device.
  88 .PP
  89 .PP
  90 .TP 8
  91 .B xinput test [-proximity] \fIdevice_name\fP
  92 Register all extended events from \fIdevice_name\fP and enter an endless
  93 loop displaying events received. If the -proximity is given, ProximityIn
  94 and ProximityOut are registered.
  95 .PP
  96 \fIdevice_name\fP can be the device name as a string or the XID of the
  97 device.
  98 .PP
  99 \fIproperty\fP can be the property as a string or the Atom value.
 100 .PP
 101
 102 .SH COPYRIGHT
 103 Copyright 1996,1997, Frederic Lepied.
 104 .PP
 105 Copyright 2008, Philip Langdale.
 106
 107 .SH AUTHOR
 108
 109 .nf
 110 Philip Langdale, <philipl@alumni.utexas.net>
 111 Frederic Lepied, France <Frederic.Lepied@sugix.frmug.org>
 112 .fi
 113
 114 Patches, bug reports, and suggestions are welcome.