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