362 lines
16 KiB
HTML
362 lines
16 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of xsetwacom</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>xsetwacom</H1>
|
|
Section: User Commands (1)<BR>Updated: xf86-input-wacom 0.39.0<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
<P>
|
|
|
|
xsetwacom - commandline utility to query and modify wacom driver settings.
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<P>
|
|
|
|
xsetwacom [options] [command [arguments]]
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
This program queries or changes properties on the devices loaded by the
|
|
wacom driver. The modification of properties happens at runtime
|
|
and is not persistent through X server restarts.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>GENERAL OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d, --display</B> display_name<DD>
|
|
Connect to the X server specified in display_name; see <A HREF="/cgi-bin/man/man2html?7+X">X</A>(7).
|
|
<DT id="2"><B>-h, --help</B><DD>
|
|
Prints a short help.
|
|
<DT id="3"><B>-v, --verbose</B><DD>
|
|
Enable verbose output, useful for debugging.
|
|
<DT id="4"><B>-V, --version</B><DD>
|
|
Display version number and exit.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>COMMANDS</H2>
|
|
|
|
<P>
|
|
|
|
Allowed commands are
|
|
<B>list,</B>
|
|
|
|
<B>get,</B>
|
|
|
|
and
|
|
<B>set.</B>
|
|
|
|
The command may be specified with or without one or two preceding
|
|
dashes, i.e.
|
|
<B>--list</B>
|
|
|
|
is equivalent to
|
|
<B>-list</B>
|
|
|
|
and
|
|
<B>list.</B>
|
|
|
|
<P>
|
|
<A NAME="lbAG"> </A>
|
|
<H3>LIST COMMANDS</H3>
|
|
|
|
<DL COMPACT>
|
|
<DT id="5"><B>list</B> devices<DD>
|
|
List known devices. Only input devices managed by the wacom
|
|
driver are listed.
|
|
<DT id="6"><B>list</B> parameters<DD>
|
|
List known parameters. List all parameters suitable for the
|
|
<B>get</B>
|
|
|
|
or the
|
|
<B>set</B>
|
|
|
|
command. Note that not all parameters are available on all device types.
|
|
<DT id="7"><B>list</B> modifiers<DD>
|
|
List the aliases for modifiers and other keys that can be used when setting
|
|
button action mappings.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H3>GET COMMANDS</H3>
|
|
|
|
<DL COMPACT>
|
|
<DT id="8"><B>get</B> device_name parameter<DD>
|
|
Get the current settings for the parameter on the given device. Note that
|
|
not all parameters are available on all device types. The special parameter
|
|
name "all" may be provided to display all current settings on the device.
|
|
<DT id="9">By default, options are printed on the commandline in the respective format.<DD>
|
|
The output format may be altered with one of the following options:
|
|
<DT id="10"><B>-s, --shell</B><DD>
|
|
Display the output in shell format, i.e. as shell commands to xsetwacom to
|
|
reproduce the same parameter.
|
|
<DT id="11"><B>-x, --xconf</B><DD>
|
|
Display the output in xorg.conf format, i.e. as option lines that may be
|
|
added to the InputDevice section in the xorg.conf.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H3>SET COMMANDS</H3>
|
|
|
|
<DL COMPACT>
|
|
<DT id="12"><B>set</B> device_name parameter [value]<DD>
|
|
Set the parameter value on the given device to the value provided. Note that
|
|
not all parameters are writable, some are read-only and result in an error
|
|
when trying to be modified.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>PARAMETERS</H2>
|
|
|
|
<P>
|
|
|
|
Not all parameters are available on all tools. Use the get command with the
|
|
parameter or "all" parameter for specific input tool applicable parameters
|
|
and current settings.
|
|
<DL COMPACT>
|
|
<DT id="13"><B>Area</B> x1 y1 x2 y2<DD>
|
|
Set the tablet input area in device coordinates in the form top left
|
|
x/y and bottom right x/y. Top left and bottom right are defined in the
|
|
device's native orientation, regardless of the actual rotation currently
|
|
applied. Input outside of these coordinates will be clipped to the edges
|
|
of the area defined. Default: 0 0 x2 y2; with x2 and y2 tablet specific.
|
|
<DT id="14"><B>Button</B> button-number [mapping]<DD>
|
|
Set a mapping for the specified button-number. Mappings take the form of
|
|
either a single numeric button or an 'action' to be performed. If no mapping
|
|
is provided, the default mapping is restored. If button-number is mapped
|
|
to 0, the Button event is ignored.
|
|
<P>
|
|
Numeric button mappings indicate what X11 button number the given button-number
|
|
should correspond to. For example, a mapping of "3" means a press of the given
|
|
button-number will produce a press of X11 button 3 (i.e. right click).
|
|
<P>
|
|
Action mappings allow button presses to perform many events. They take the form
|
|
of a string of keywords and arguments.
|
|
<P>
|
|
The "key" keyword is followed by a list of key names. These can optionally
|
|
be preceded by "+" for press and "-" for release. If +/- is not given,
|
|
press-and-release is assumed, except for modifier keys which are left pressed.
|
|
Key names can be X11 KeySyms or some aliases such as 'shift' or 'f1' (the
|
|
full list can be seen with the
|
|
<B>list modifiers</B>
|
|
|
|
command).
|
|
<P>
|
|
To assign a key that is not in the modifiers list, use the KeySym in
|
|
/usr/include/X11/keysymdef.h with the XK_ prefix removed or its actual value
|
|
as is. For example, XK_BackSpace should be specified as "BackSpace". "0xff80"
|
|
can also be used to replace "BackSpace" since it's the unique KeySym value of
|
|
Backspace key.
|
|
<P>
|
|
Here is a combined example: "key +a shift b shift -a 0xff0d" converts the
|
|
button into a series of keystrokes. In this example, "press a, press shift,
|
|
press and release b, release shift, release a, then press and release enter".
|
|
"key +a +shift b -shift -a 0xff0d" does the same thing.
|
|
<P>
|
|
The "button" keyword is similar except that its arguments are X11 button
|
|
numbers.
|
|
<P>
|
|
The "modetoggle" keyword is also recognized; it takes no arguments,
|
|
and toggles the device mode between relative and absolute pointer tracking.
|
|
<P>
|
|
The "pan" keyword causes the driver to send scroll events while the pen
|
|
is dragged. This makes it easy to scroll through lists and documents,
|
|
pan around 2D canvases, and zoom in/out of 3D scenes (exact behavior
|
|
depends on application interpretation of scrollwheel events). Dragging
|
|
the pen up/down will send scrollwheel down/up events; dragging it left/right
|
|
will send scrollwheel right/left events.
|
|
<P>
|
|
The events in the action mapping are sent when the physical button is pressed.
|
|
If the action mapping leaves any buttons or keys pressed (such as a modifier
|
|
key), they will be released when the physical button is released.
|
|
<P>
|
|
Multiple keywords may be present in one action if desired: for example
|
|
"key +ctrl button 5 key -ctrl". Each keyword takes all arguments until the
|
|
next keyword.
|
|
<P>
|
|
A maximum of 256 presses and/or releases can be specified in an action mapping.
|
|
<P>
|
|
The driver can only simulate physical key events but not keysyms and
|
|
xsetwacom translates the mapping sequence into such events. Thus,
|
|
symbols on the same physical key will generate the same event. For
|
|
example, '1' and '!' are on the same key on a US keyboard and thus have the
|
|
same keycode). For access to keys on a higher shift level, the sequence
|
|
should be entered as it would be typed on a physical keyboard. For example,
|
|
a exclamation mark is entered by the sequence of "key +shift 1 -shift".
|
|
<DT id="15"><B>BindToSerial</B> [serial|0]<DD>
|
|
Bind the device to the tool with the specified serial number. Once bound,
|
|
the device will ignore events from other tools. A serial of 0 means the
|
|
device is unbound and will react to any tool of the matching type.
|
|
Default: 0
|
|
<DT id="16"><B>MapToOutput</B> [output]<DD>
|
|
Map the tablet's input area to a given output (e.g. "VGA1"). Output names may
|
|
either be the name of a head available through the XRandR extension, or an
|
|
X11 geometry string of the form WIDTHxHEIGHT+X+Y. To switch to the next
|
|
available output, the "next" keyword is also supported. This will cycle
|
|
between the individual monitors connected to the system, and then the entire
|
|
desktop. The mapping may be reset to the entire desktop at any time with the
|
|
output name "desktop". Users of the NVIDIA binary driver should use the output
|
|
names "HEAD-0" and "HEAD-1" until the driver supports XRandR 1.2 or later.
|
|
<P>
|
|
The output mapping configuration is a onetime setting and does not track output
|
|
reconfigurations; the command needs to be re-run whenever the output
|
|
configuration changes. When used with tablet rotation, the tablet must be
|
|
rotated before it is mapped to the new screen. This parameter is write-only
|
|
and cannot be queried.
|
|
<DT id="17"><B>Mode</B> Absolute|Relative<DD>
|
|
Set the device mode as either Relative or Absolute. Relative means pointer
|
|
tracking for the device will function like a mouse, whereas Absolute means
|
|
the pointer corresponds to the device's actual position on the tablet or
|
|
tablet PC screen. Default: Absolute for stylus, eraser and tablet PC touch;
|
|
Relative for cursor and tablet touch.
|
|
<DT id="18"><B>PressureCurve</B> x1 y1 x2 y2<DD>
|
|
A Bezier curve of third order, composed of two anchor points (0,0 and 100,100)
|
|
and two user modifiable control points that define the curve's shape. Raise
|
|
the curve (x1<y1 x2<y2) to "soften" the feel and lower the curve (x1>y1 x2>y2)
|
|
for a "firmer" feel. Sigmoid shaped curves are permitted (x1>y1 x2<y2 or
|
|
x1<y1 x2>y2). Default: 0 0 100 100, a linear curve; range of 0 to 100 for
|
|
all four values.
|
|
<DT id="19"><B>RawSample</B> level<DD>
|
|
Set the sample window size (a sliding average sampling window) for incoming
|
|
input tool raw data points. Default: 4, range of 1 to 20.
|
|
<DT id="20"><B>Rotate</B> none|half|cw|ccw<DD>
|
|
Set the tablet to the given rotation:
|
|
<BR> none: the tablet is not rotated and uses its natural rotation
|
|
<BR> half: the tablet is rotated by 180 degrees (upside-down)
|
|
<BR> cw: the tablet is rotated 90 degrees clockwise
|
|
<BR> ccw: the tablet is rotated 90 degrees counter-clockwise
|
|
<P>
|
|
Rotation is a tablet-wide option: rotation of one tool affects all other tools
|
|
associated with the same tablet. When the tablet is physically rotated, rotate
|
|
any tool to the corresponding orientation. Default: none
|
|
<DT id="21"><B>Suppress</B> level<DD>
|
|
Set the delta (difference) cutoff level for further processing of incoming
|
|
input tool coordinate values. For example a X or Y coordinate event will be
|
|
sent only if the change between the current X or Y coordinate and the
|
|
previous one is greater than the Suppress value. The same applies to
|
|
pressure level (Z coordinate) and Tilt rotation values. With a current
|
|
absolute wheel (AbsWheel) or Tilt value the delta between it and the
|
|
previous value must be equal to or greater than the Suppress value in order
|
|
to be sent on. Suppress is a tablet wide parameter. A specified delta
|
|
level for one input tool is applied to all input tool coordinates. To
|
|
disable suppression use a level of 0. Default: 2, range of 0 to 100.
|
|
<DT id="22"><B>TabletDebugLevel</B> level<DD>
|
|
Set the debug level for this tablet to the given level. This only affects
|
|
code paths that are shared between several tools on the same physical
|
|
tablet. A higher level means more fine-grained debug messages, a level of 0
|
|
turns debugging off for this tool. Requires the driver to be built with
|
|
debugging enabled. See also ToolDebugLevel. Default: 0, range of 0 to 12.
|
|
<DT id="23"><B>TabletPCButton</B> on|off<DD>
|
|
If on, the stylus must be in contact with the screen for a stylus side button
|
|
to work. If off, stylus buttons will work once the stylus is in proximity
|
|
of the tablet (regardless of whether it is touching the screen). Default: on
|
|
for Tablet PCs; off for all other models.
|
|
<DT id="24"><B>ToolSerialPrevious</B><DD>
|
|
Get the serial number of the tool that was last in proximity last. This
|
|
serial number is updated whenever the tool goes out of proximity. If the
|
|
current tool went out of proximity once, this serial number is the one of
|
|
the current tool. This is a read-only parameter.
|
|
<DT id="25"><B>Touch</B> on|off<DD>
|
|
If on, touch events are reported to userland, i.e., system cursor moves when
|
|
user touches the tablet. If off, touch events are ignored. Default: on for
|
|
devices that support touch; off for all other models.
|
|
<DT id="26"><B>HWTouchSwitchState</B> on|off<DD>
|
|
If on, it means touch switch is turned off. That is, touch events are reported
|
|
to userland. If off, touch switch is turned on, i.e., touch events are ignored.
|
|
This is a read-only parameter. Initial touch switch state is retrieved from the
|
|
kernel when X driver starts.
|
|
<DT id="27"><B>CursorProximity</B> distance<DD>
|
|
Set the distance at which a relative tool is treated as being out of proximity.
|
|
Beyond this distance the cursor will stop responding to tool motion. The
|
|
default value for pucks is 10 (Intuos Pro) or 42 (Intuos/Bamboo). The default
|
|
value for pens is 30.
|
|
<DT id="28"><B>Threshold</B> level<DD>
|
|
Set the minimum pressure necessary to generate a Button event for the stylus
|
|
tip, eraser, or touch. The pressure levels of all tablets are normalized to
|
|
2048 levels irregardless of the actual hardware supported levels. This
|
|
parameter is independent of the PressureCurve parameter. Default: 27,
|
|
range of 0 to 2047.
|
|
<DT id="29"><B>ToolDebugLevel</B> level<DD>
|
|
Set the debug level for this tool to the given level. This only affects
|
|
code paths that are specific to a given tool. A higher level means more
|
|
fine-grained debug messages, a level of 0 turns debugging off for this
|
|
tool. Requires the driver to be built with debugging enabled. See also
|
|
TabletDebugLevel. Default: 0, range of 0 to 12.
|
|
<DT id="30"><B>PressureRecalibration</B> on|off<DD>
|
|
If the initial pressure of a device is != 0 the driver recalibrates
|
|
the pressure range. This is to account for worn out devices.
|
|
The downside is that when the user hits the tablet very hard the
|
|
initial pressure reading may be unequal to zero even for a perfectly
|
|
good pen. If the consecutive pressure readings are not higher than
|
|
the initial pressure by a threshold no button event will be generated.
|
|
This option allows to disable the recalibration. Default: on
|
|
<DT id="31"><B>PanScrollThreshold</B> distance<DD>
|
|
This specifies the distance the pen must move (in tablet units) before
|
|
a scroll event is generated when using the "pan" action. Smaller values
|
|
will require less distance and be more sensitive. Larger values will
|
|
require more distance and be less sensitive. Default: 1300 or 2600
|
|
depending on tablet resolution (corresponds to 13 mm of distance).
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>WAYLAND SUPPORT</H2>
|
|
|
|
<P>
|
|
This tool provides access to the device properties implemented in the
|
|
<B>xf86-input-wacom</B> X server input module. It does not work under a
|
|
Wayland compositor as the input module is not active.
|
|
<DL COMPACT>
|
|
<DT id="32">See <A HREF="https://github.com/linuxwacom/xf86-input-wacom/wiki/Wayland">https://github.com/linuxwacom/xf86-input-wacom/wiki/Wayland</A> for details.<DD>
|
|
<P>
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAL"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
Peter Hutterer <<A HREF="mailto:peter.hutterer@redhat.com">peter.hutterer@redhat.com</A>>
|
|
<P>
|
|
<A NAME="lbAM"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<A HREF="/cgi-bin/man/man2html?1+Xorg">Xorg</A>(1), <A HREF="/cgi-bin/man/man2html?4+wacom">wacom</A>(4),
|
|
<A HREF="/cgi-bin/man/man2html?5+xorg.conf">xorg.conf</A>(5),
|
|
<A HREF="/cgi-bin/man/man2html?7+X">X</A>(7)
|
|
<P>
|
|
|
|
More information is available at <A HREF="https://github.com/linuxwacom/xf86-input-wacom">https://github.com/linuxwacom/xf86-input-wacom</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="33"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="34"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="35"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="36"><A HREF="#lbAE">GENERAL OPTIONS</A><DD>
|
|
<DT id="37"><A HREF="#lbAF">COMMANDS</A><DD>
|
|
<DL>
|
|
<DT id="38"><A HREF="#lbAG">LIST COMMANDS</A><DD>
|
|
<DT id="39"><A HREF="#lbAH">GET COMMANDS</A><DD>
|
|
<DT id="40"><A HREF="#lbAI">SET COMMANDS</A><DD>
|
|
</DL>
|
|
<DT id="41"><A HREF="#lbAJ">PARAMETERS</A><DD>
|
|
<DT id="42"><A HREF="#lbAK">WAYLAND SUPPORT</A><DD>
|
|
<DT id="43"><A HREF="#lbAL">AUTHORS</A><DD>
|
|
<DT id="44"><A HREF="#lbAM">SEE ALSO</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>
|