384 lines
10 KiB
HTML
384 lines
10 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of xinput</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>xinput</H1>
|
|
Section: User Commands (1)<BR>Updated: xinput 1.6.3<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<P>
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
xinput - utility to configure and test X input devices
|
|
<P>
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>xinput [OPTIONS] [DEVICE]</B>
|
|
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
xinput is a utility to list available input devices, query information about
|
|
a device and change input device settings.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>--version</B>
|
|
|
|
<DD>
|
|
Test if the X Input extension is available and return the version number
|
|
of the program and the version supported by the server. This option does not
|
|
require a device name.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="2"><B>--list [--short || --long || --name-only || --id-only] [</B><I>device</I>]
|
|
|
|
<DD>
|
|
If no argument is given list all the input devices. If an argument is given,
|
|
show all the features of <I>device</I>.
|
|
If --long is provided, the output includes detailed information about the
|
|
capabilities of each devices. Otherwise, or if --short is provided, only the
|
|
device names and some minimal information is listed.
|
|
If --name-only is provided, the output is limited to the device names. One
|
|
device name is listed per line. Note that the order the devices are listed
|
|
is undefined.
|
|
If --id-only is provided, the output is limited to the device IDs. One
|
|
device ID is listed per line. Note that the order the devices are listed is
|
|
undefined.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="3"><B>--get-feedbacks </B><I>device</I>
|
|
|
|
<DD>
|
|
Display the feedbacks of <I>device</I>.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="4"><B>--set-pointer </B><I>device</I>
|
|
|
|
<DD>
|
|
Switch <I>device</I> in core pointer.
|
|
This option does nothing on X servers 1.5 and later.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="5"><B>--set-mode </B><I>device</I> <I>ABSOLUTE|RELATIVE</I>
|
|
|
|
<DD>
|
|
Change the mode of <I>device</I>.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="6"><B>--set-ptr-feedback </B><I>device</I> <I>threshold</I> <I>num</I> <I>denom</I>
|
|
|
|
<DD>
|
|
Change the pointer acceleration (or feedback) parameters of <I>device</I>.
|
|
The <A HREF="/cgi-bin/man/man2html?1+xset">xset</A>(1) man page has more details. For X.Org Server 1.7
|
|
and above, there are additional device properties pertaining to pointer
|
|
acceleration. These do not replace, but complement the pointer feedback
|
|
setting.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="7"><B>--set-integer-feedback </B><I>device</I> <I>index</I> <I>value</I>
|
|
|
|
<DD>
|
|
Change the value of an integer feedback of <I>device</I>.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="8"><B>--set-button-map </B><I>device</I> <I>map_button_1</I> [<I>map_button_2</I> [<I>...</I>]]
|
|
|
|
<DD>
|
|
Change the button mapping of <I>device</I>. The buttons are specified in
|
|
physical order (starting with button 1) and are mapped to the logical button
|
|
provided. 0 disables a button. The default button mapping for a device is 1
|
|
2 3 4 5 6 etc.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="9"><B>--query-state </B><I>device</I>
|
|
|
|
<DD>
|
|
Query the device state.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="10"><B>--list-props </B><I>device</I> [<I>device</I> [<I>...</I>]]
|
|
|
|
<DD>
|
|
Lists properties that can be set for the given device(s).
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="11"><B>--set-int-prop </B><I>device</I> <I>property</I> <I>format</I> <I>value</I>
|
|
|
|
<DD>
|
|
Sets an integer property for the device. Appropriate values for <I>format</I>
|
|
are 8, 16, or 32, depending on the property. Deprecated, use
|
|
<B>--set-prop</B>
|
|
|
|
instead.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="12"><B>--set-float-prop </B><I>device</I> <I>property</I> <I>value</I>
|
|
|
|
<DD>
|
|
Sets a float property for the device. Deprecated, use
|
|
<B>--set-prop</B>
|
|
|
|
instead.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="13"><B>--set-prop [--type=</B><I>atom|float|int</I>] [--format=<I>8|16|32</I>] <I>device</I> <I>property</I> <I>value</I> [...]
|
|
|
|
<DD>
|
|
Set the property to the given value(s). If not specified, the format and type
|
|
of the property are left as-is. The arguments are interpreted according to the
|
|
property type. See Section <I>CHANGING PROPERTIES</I>.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="14"><B>--watch-props </B><I>device</I>
|
|
|
|
<DD>
|
|
Prints to standard out when property changes occur.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="15"><B>--delete-prop </B><I>device</I> <I>property</I>
|
|
|
|
<DD>
|
|
Delete the property from the device.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="16"><B>--test [-proximity] </B><I>device</I>
|
|
|
|
<DD>
|
|
Register all extended events from <I>device</I> and enter an endless
|
|
loop displaying events received. If the -proximity is given, ProximityIn
|
|
and ProximityOut are registered.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="17"><B>--test-xi2 [--root] [</B><I>device</I>]
|
|
|
|
<DD>
|
|
Register for a number of XI2 events and display them. If a device is given,
|
|
only events on this device are displayed. If --root is given, events are
|
|
selected on the root window only. Otherwise, a new client window is created
|
|
(similar to xev).
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="18"><B>--create-master </B><I>prefix</I> [sendCore] [enable]
|
|
|
|
<DD>
|
|
Create a new pair of master devices on an XI2-enabled server with the given
|
|
<I>prefix</I>. The server will create one master pointer named "<I>prefix</I>
|
|
pointer" and one master keyboard named "<I>prefix</I> keyboard". If
|
|
<I>sendCore</I> is 1, this pair of master devices is set to send core events
|
|
(default). If <I>enable</I> is 1, this master device pair will be enabled
|
|
immediately (default).
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="19"><B>--remove-master </B><I>master</I> [Floating|AttachToMaster] [returnPointer] [returnKeyboard]
|
|
|
|
<DD>
|
|
Remove <I>master</I> and its paired master device. Attached slave devices
|
|
are set floating if <I>Floating</I> is specified or the argument is omitted.
|
|
If the second argument is <I>AttachToMaster</I>, <I>returnPointer</I>
|
|
specifies the master pointer to attach all slave pointers to and
|
|
<I>returnKeyboard</I> specifies the master keyboard to attach all slave
|
|
keyboards to.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="20"><B>--reattach </B><I>slave</I> <I>master</I>
|
|
|
|
<DD>
|
|
Reattach <I>slave</I> to <I>master</I>.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="21"><B>--float </B><I>slave</I>
|
|
|
|
<DD>
|
|
Remove <I>slave</I> from its current master device.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="22"><B>--set-cp </B><I>window</I> <I>master</I>
|
|
|
|
<DD>
|
|
Set the ClientPointer for the client owning <I>window</I> to <I>master</I>.
|
|
<I>master</I> must specify a master pointer.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="23"><B>--map-to-output </B><I>device</I> <I>crtc</I>
|
|
|
|
<DD>
|
|
Restricts the movements of the absolute <I>device</I> to the RandR
|
|
<I>crtc</I>. The output name must match a currently connected output (see
|
|
<I><A HREF="/cgi-bin/man/man2html?1+xrandr">xrandr</A>(1)</I>). If the NVIDIA binary driver is
|
|
detected or RandR 1.2 or later is not available, a Xinerama output may be
|
|
specified as "HEAD-N", with N being the Xinerama screen number. This option
|
|
has no effect on relative devices.
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="24"><B>--enable </B><I>device</I>
|
|
|
|
<DD>
|
|
Enable the <I>device</I>. This call is equivalent to
|
|
<B>xinput --set-prop device </B><I>Device Enabled</I> 1
|
|
|
|
</DL>
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="25"><B>--disable </B><I>device</I>
|
|
|
|
<DD>
|
|
Disable the <I>device</I>. This call is equivalent to
|
|
<B>xinput --set-prop device </B><I>Device Enabled</I> 0
|
|
|
|
</DL>
|
|
<P>
|
|
|
|
<I>device</I> can be the device name as a string or the XID of the
|
|
device.
|
|
<P>
|
|
|
|
<I>slave</I> can be the device name as a string or the XID of a slave
|
|
device.
|
|
<P>
|
|
|
|
<I>master</I> can be the device name as a string or the XID of a master
|
|
device.
|
|
<P>
|
|
|
|
<I>property</I> can be the property as a string or the Atom value.
|
|
<P>
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>CHANGING PROPERTIES</H2>
|
|
|
|
When xinput should modify an existing driver property value, it is
|
|
sufficient to provide the device name and property name as string, followed
|
|
by the new value(s) of the property. For example:
|
|
<DL COMPACT>
|
|
<DT id="26"><DD>
|
|
<B>xinput set-prop "my device" "my prop" 1 2 3
|
|
<P>
|
|
</DL>
|
|
</B><A NAME="lbAG"> </A>
|
|
<H2>XWAYLAND</H2>
|
|
|
|
Xwayland is an X server that uses a Wayland Compositor as backend.
|
|
Xwayland acts as translation layer between the X protocol and the Wayland
|
|
protocol but does not have direct access to the hardware. The X Input
|
|
Extension devices created by Xwayland ("xwayland-pointer",
|
|
"xwayland-keyboard", etc.) map to the Wayland protocol devices,
|
|
not to physical devices.
|
|
<P>
|
|
|
|
These X Input Extension devices are only visible to other X clients
|
|
connected to the same Xwayland process. Changing properties on Xwayland
|
|
devices only affects the behavior of those clients. For example, disabling
|
|
an Xwayland device with xinput does not disable the device in Wayland-native
|
|
applications. Other changes may not have any effect at all.
|
|
<P>
|
|
|
|
In most instances, using xinput with an Xwayland device is indicative of a
|
|
bug in a shell script and xinput will print a warning. Use the Wayland
|
|
Compositor's native device configuration methods instead.
|
|
<P>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<A HREF="/cgi-bin/man/man2html?7+X">X</A>(7), <A HREF="/cgi-bin/man/man2html?1+xset">xset</A>(1), <A HREF="/cgi-bin/man/man2html?1+xrandr">xrandr</A>(1)
|
|
<A NAME="lbAI"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
Copyright 1996,1997, Frederic Lepied.
|
|
<P>
|
|
|
|
Copyright 2007, Peter Hutterer.
|
|
<P>
|
|
|
|
Copyright 2008, Philip Langdale.
|
|
<P>
|
|
|
|
Copyright 2009-2011, Red Hat, Inc.
|
|
<P>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
<P>
|
|
<PRE>
|
|
Peter Hutterer <<A HREF="mailto:peter.hutterer@who-t.net">peter.hutterer@who-t.net</A>>
|
|
Philip Langdale, <<A HREF="mailto:philipl@alumni.utexas.net">philipl@alumni.utexas.net</A>>
|
|
Frederic Lepied, France <<A HREF="mailto:Frederic.Lepied@sugix.frmug.org">Frederic.Lepied@sugix.frmug.org</A>>
|
|
Julien Cristau <<A HREF="mailto:jcristau@debian.org">jcristau@debian.org</A>>
|
|
Thomas Jaeger <<A HREF="mailto:ThJaeger@gmail.com">ThJaeger@gmail.com</A>>
|
|
and more.
|
|
</PRE>
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="27"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="28"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="29"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="30"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="31"><A HREF="#lbAF">CHANGING PROPERTIES</A><DD>
|
|
<DT id="32"><A HREF="#lbAG">XWAYLAND</A><DD>
|
|
<DT id="33"><A HREF="#lbAH">SEE ALSO</A><DD>
|
|
<DT id="34"><A HREF="#lbAI">COPYRIGHT</A><DD>
|
|
<DT id="35"><A HREF="#lbAJ">AUTHORS</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:31 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|