476 lines
19 KiB
HTML
476 lines
19 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of WACOM</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>WACOM</H1>
|
|
Section: Devices and Network Interfaces (4)<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>
|
|
|
|
wacom - Wacom input driver
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>Section "InputDevice"</B>
|
|
<B> Identifier "</B><I>idevname</I><B>"</B>
|
|
<B> Driver "wacom"</B>
|
|
<B> Option "Device" "</B><I>devpath</I><B>"</B>
|
|
...
|
|
<B>EndSection</B>
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>wacom </B>
|
|
|
|
is an X input driver for Wacom devices.
|
|
<P>
|
|
|
|
The
|
|
<B>wacom</B>
|
|
|
|
driver functions as a pointer input device.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>SUPPORTED HARDWARE</H2>
|
|
|
|
This driver supports the Wacom IV and Wacom V protocols. Serial tablets only
|
|
need this driver. USB tablet support is available on some Linux platforms
|
|
and requires the wacom kernel driver being loaded before this driver starts.
|
|
<P>
|
|
|
|
Please check <A HREF="https://github.com/linuxwacom">https://github.com/linuxwacom</A> for latest updates of Wacom X
|
|
and kernel drivers.
|
|
<A NAME="lbAF"> </A>
|
|
<H2>DRIVER-INTERNAL DEVICE HOTPLUGGING</H2>
|
|
|
|
When input device hotplugging in the X server is enabled and no
|
|
<B>InputDevice</B>
|
|
|
|
section exists for a compatible tablet device and an
|
|
<B>InputClass</B>
|
|
|
|
section (see <A HREF="/cgi-bin/man/man2html?5x+xorg.conf.d">xorg.conf.d</A>(5x)) assigns this driver for the device, the
|
|
<B>wacom</B>
|
|
|
|
driver creates multiple X devices for each a physical device, one X device
|
|
for each available tool. The list of tools is hardware-dependent. See
|
|
<B>Option Type</B>
|
|
|
|
as outlined in the
|
|
<B>CONFIGURATION DETAILS</B>
|
|
|
|
section.
|
|
<P>
|
|
|
|
These tool-specific devices are referred to as parent device and dependent
|
|
device. The parent device is the one presented by the system and the one
|
|
that causes the X server to load the
|
|
<B>wacom</B>
|
|
|
|
driver. This parent device then causes the automatic addition of several
|
|
dependent devices. If the parent device is unplugged or otherwise removed,
|
|
the dependent devices will be automatically removed as well.
|
|
<P>
|
|
|
|
Dependent devices may be assigned tool-specific options through additional
|
|
<B>InputClass</B>
|
|
|
|
sections. We recommend that a
|
|
<B>MatchDriver wacom</B>
|
|
|
|
line is used in these sections in addition to the user-specific pattern.
|
|
<P>
|
|
|
|
Match directives are applied by the X server before the driver is selected.
|
|
The type name of the parent device is appended by the driver. It is not
|
|
possible to use a
|
|
<B>MatchProduct</B>
|
|
|
|
directive to match against this appended type name.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CONFIGURATION DETAILS</H2>
|
|
|
|
Please refer to <A HREF="/cgi-bin/man/man2html?5x+xorg.conf">xorg.conf</A>(5x) or <A HREF="/cgi-bin/man/man2html?5x+xorg.conf.d">xorg.conf.d</A>(5x) for general configuration
|
|
details and for options that can be used with all input drivers. This
|
|
section only covers configuration details specific to this driver.
|
|
<P>
|
|
|
|
Multiple instances of the Wacom devices can cohabit. Each device
|
|
supports the following entries:
|
|
<DL COMPACT><DT id="1"><DD>
|
|
<DL COMPACT>
|
|
<DT id="2"><B>Option </B><I>Type</I> <I>stylus|eraser|cursor|pad|touch</I>
|
|
|
|
<DD>
|
|
sets the type of tool the device represents. This option is mandatory.
|
|
The core options, such as "SendCoreEvents" or "AlwaysCore", are
|
|
unnecessary in Gimp if you don't need to move system cursor outside
|
|
of Gimp drawing area. "pad" is for Intuos 3 or Cintiq 21UX tablet
|
|
ExpressKeys/menu strips, and Graphire 4 or Bamboo tablet buttons, wheel,
|
|
and/or ring. It is required for Intuos3, CintiqV5, Graphire 4, and
|
|
Bamboo if you want to use keystroke features. "pad" is reported as a
|
|
second tool in the driver. "touch" is for the tablet with touch support.
|
|
Right now only a few Tablet PCs have this feature.
|
|
<DT id="3"><B>Option </B><I>Device</I> <I>path</I>
|
|
|
|
<DD>
|
|
sets the path to the special file which represents serial line where
|
|
the tablet is plugged. You have to specify it for each subsection with
|
|
the same value if you want to have multiple devices with the same tablet.
|
|
This option is mandatory.
|
|
<DT id="4"><B>Option </B><I>Suppress</I> <I>number</I>
|
|
|
|
<DD>
|
|
sets the position increment under which not to transmit coordinates.
|
|
This entry must be specified only in the first Wacom subsection if you have
|
|
multiple devices for one tablet. If you don't specify this entry, the default
|
|
value, which is 2, will be used. To disable suppression, the entry should be
|
|
specified as 0. When suppress is defined, an event will be sent only when at
|
|
least one of the following conditions is met:
|
|
<P>
|
|
<BR> the change between the current X coordinate and the previous one is
|
|
greater than suppress;
|
|
<P>
|
|
<BR> the change between the current Y coordinate and the previous one is
|
|
greater than suppress;
|
|
<P>
|
|
<BR> the change between the current pressure and the previous one is
|
|
greater than suppress;
|
|
<P>
|
|
<BR> the change between the current degree of rotation and the previous
|
|
one of the transducer is greater than suppress;
|
|
<P>
|
|
<BR> the change between the current absolute wheel value and the previous
|
|
one is equal to or greater than suppress;
|
|
<P>
|
|
<BR> the change between the current tilt value and the previous one is equal
|
|
to or greater than suppress (if tilt is supported);
|
|
<P>
|
|
<BR> relative wheel value has changed;
|
|
<P>
|
|
<BR> button value has changed;
|
|
<P>
|
|
<BR> proximity has changed.
|
|
<DT id="5"><B>Option </B><I>Mode</I> <I>Relative|Absolute</I>
|
|
|
|
<DD>
|
|
sets the mode of the device. The default value for stylus, pad and
|
|
eraser is Absolute; cursor is Relative;
|
|
touch defaults to Relative for tablets with touch pads and Absolute for
|
|
touch screens.
|
|
<DT id="6"><B>Option </B><I>TopX</I> <I>number</I>
|
|
|
|
<DD>
|
|
X coordinate of the top corner of the active zone. Default to 0.
|
|
<DT id="7"><B>Option </B><I>TopY</I> <I>number</I>
|
|
|
|
<DD>
|
|
Y coordinate of the top corner of the active zone. Default to 0.
|
|
<DT id="8"><B>Option </B><I>BottomX</I> <I>number</I>
|
|
|
|
<DD>
|
|
X coordinate of the bottom corner of the active zone. Default to width of the tablet.
|
|
<DT id="9"><B>Option </B><I>BottomY</I> <I>number</I>
|
|
|
|
<DD>
|
|
Y coordinate of the bottom corner of the active zone. Default to height of the tablet.
|
|
<DT id="10"><B>Option </B><I>ButtonsOnly</I> <I>on|off</I>
|
|
|
|
<DD>
|
|
disables the device's motion events. Default to off.
|
|
<DT id="11"><B>Option </B><I>ButtonM</I> <I>AC</I>
|
|
|
|
<DD>
|
|
reports an action AC when button M is pressed, where M
|
|
is one of the device supported button numbers, it can be 1
|
|
to 32. Wacom uses a driver-internal button mapping, where any physical
|
|
button appears to the X server as the button specified by the ButtonM
|
|
mapping. Hence, if two physical buttons have the same ButtonM mapping, the
|
|
server will think they are the same physical button.
|
|
The default action reported to the X server is mouse button M click. Because
|
|
X uses buttons 4, 5, 6, and 7 as the four scrolling directions, physical
|
|
buttons 4 and higher are mapped to 8 and higher by default.
|
|
Only simple button presses can be configured here; for more complex
|
|
actions, use <A HREF="/cgi-bin/man/man2html?1+xsetwacom">xsetwacom</A>(1).
|
|
To ignore the button click, i.e., to not report any button click event
|
|
to the X server, use "0" or "button 0".
|
|
<DT id="12"><B>Option </B><I>TPCButton</I> <I>on|off</I>
|
|
|
|
<DD>
|
|
enables the stylus buttons as Tablet PC buttons. If enabled, the stylus
|
|
reports button events only when its tip is pressed. If any button is down,
|
|
pressing the tip reports a button event for the button. Otherwise if no
|
|
button is down, the tip reports as usual.
|
|
Default to "on" for Tablet PCs; "off" for all other models. Only available
|
|
on the stylus tool.
|
|
<DT id="13"><B>Option </B><I>Touch</I> <I>on|off</I>
|
|
|
|
<DD>
|
|
enables touch events for touch devices, i.e., system cursor moves when
|
|
user touches the tablet. Default to "on" for devices that support touch;
|
|
"off" for all other models.
|
|
<DT id="14"><B>Option </B><I>Rotate</I> <I>CW|CCW|HALF|NONE</I>
|
|
|
|
<DD>
|
|
rotates the tablet orientation counterclockwise (CCW) or clockwise (CW) or 180 degrees (HALF).
|
|
If you have specific tablet mappings, i.e. TopX/Y or BottomX/Y were set, the mapping will be
|
|
applied before rotation. Rotation must be applied to the parent device
|
|
(usually the stylus), rotation settings on in-driver hotplugged devices (see
|
|
<B>DRIVER-INTERNAL DEVICE HOTPLUGGING</B>
|
|
|
|
) will be ignored. The default is "NONE".
|
|
<DT id="15"><B>Option </B><I>PressCurve</I> <I>x1,y1,x2,y2</I>
|
|
|
|
<DD>
|
|
sets pressure curve by control points x1, y1, x2, and y2. Their values are in range
|
|
from 0..100. The pressure curve is interpreted as Bezier curve with 4
|
|
control points, the first and the last control point being fixed on the
|
|
coordinates 0/0 and 100/100, respectively. The middle control points are
|
|
adjustible by this setting and thus define the shape of the curve.
|
|
The input for linear curve (default) is "0,0,100,100";
|
|
slightly depressed curve (firmer) might be "5,0,100,95";
|
|
slightly raised curve (softer) might be "0,5,95,100".
|
|
The pressure curve is only applicable to devices of type stylus or eraser,
|
|
other devices do not honor this setting.
|
|
<DT id="16"><B>Option </B><I>Pressure2K</I> <I>bool</I>
|
|
|
|
<DD>
|
|
reduces the pressure range to the range of 0 to 2048 for backwards
|
|
compatibility with applications that have this range hardcoded.
|
|
See section
|
|
<B>BUGS.</B>
|
|
|
|
This option should not be used unless the user runs one or more
|
|
applications that rely on a hardcoded pressure range.
|
|
<DT id="17"><B>Option </B><I>DebugLevel</I> <I>number</I>
|
|
|
|
<DD>
|
|
sets the level of debugging info for tool-specific messages. There are 12
|
|
levels, specified by the integers between 1 and 12. All debug messages with
|
|
a level less than or equal to the "number" will be logged into the Xorg log
|
|
file. This option is only available if the driver was built with debugging
|
|
support.
|
|
<DT id="18"><B>Option </B><I>CommonDBG</I> <I>number</I>
|
|
|
|
<DD>
|
|
sets the level of debugging info for common (i.e. not tool-specific) code
|
|
paths on the tablet. There are 12 levels, specified by the integers between
|
|
1 and 12. All debug messages with a level less than or equal to the
|
|
"number" will be logged into the Xorg log file. This option is only
|
|
available if the driver was built with debugging support.
|
|
<DT id="19"><B>Option </B><I>GrabDevice</I> <I>bool</I>
|
|
|
|
<DD>
|
|
sets whether the underlying event device will be grabbed by the driver to
|
|
prevent the data from leaking to /dev/input/mice. When enabled, while the
|
|
X server is running, no other programs will be able to read the event
|
|
stream. Default: "false".
|
|
<DT id="20"><B>Option </B><I>CursorProx</I> <I>number</I>
|
|
|
|
<DD>
|
|
sets 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="21"><B>Option </B><I>RawSample</I> <I>number</I>
|
|
|
|
<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="22"><B>Option </B><I>Serial</I> <I>number</I>
|
|
|
|
<DD>
|
|
sets the serial number associated with the physical device. This allows
|
|
to have multiple devices of the same type (i.e. multiple pens). This
|
|
option is only available on wacom V devices (Intuos series and Cintiq 21U).
|
|
To see which serial number belongs to a device, you need to run the utility program,
|
|
xsetwacom, which comes with linuxwacom package.
|
|
<DT id="23"><B>Option </B><I>ToolSerials</I> <I>number[,type[,label]][;...]</I>
|
|
|
|
<DD>
|
|
sets the list of serial numbered devices that need to be hotplugged for a physical
|
|
device. The 'type' option may be any of "pen", "airbrush", "artpen", or "cursor".
|
|
This option is only available on wacom V devices (Intuos series and Cintiq 21U).
|
|
To see which serial number belongs to a device, you need to run the utility program,
|
|
xsetwacom, that comes with this driver.
|
|
<DT id="24"><B>Option </B><I>Threshold</I> <I>number</I>
|
|
|
|
<DD>
|
|
sets the pressure threshold used to generate a button 1 events of stylus.
|
|
The threshold applies to the normalised pressure range of [0..2048].
|
|
The default is 27.
|
|
<DT id="25"><B>Option </B><I>Gesture</I> <I>bool</I>
|
|
|
|
<DD>
|
|
Enable or disable multi-finger in-driver gesture support on the device. Default: off
|
|
unless the tablet supports multi-touch. Note that disabling this option may allow
|
|
the desktop environment to detect multi-finger gestures instead.
|
|
<DT id="26"><B>Option </B><I>ZoomDistance</I> <I>number</I>
|
|
|
|
<DD>
|
|
If
|
|
<B>Option </B><I>Gesture</I>
|
|
|
|
is enabled, this option specifies the minimum movement distance before a
|
|
zoom gesture is recognized.
|
|
<DT id="27"><B>Option </B><I>ScrollDistance</I> <I>number</I>
|
|
|
|
<DD>
|
|
If
|
|
<B>Option </B><I>Gesture</I>
|
|
|
|
is enabled, this option specifies the minimum movement distance before a
|
|
scroll gesture is recognized.
|
|
<DT id="28"><B>Option </B><I>TapTime</I> <I>number</I>
|
|
|
|
<DD>
|
|
If
|
|
<B>Option </B><I>Gesture</I>
|
|
|
|
is enabled, this option determines the maximum time of a touch event to be
|
|
recognized as tap. A press and release event shorter than
|
|
<B>TapTime</B>
|
|
|
|
generates button press and release events. Presses longer than
|
|
<B>TapTime</B>
|
|
|
|
do not generate button events, only motion events.
|
|
<DT id="29"><B>Option </B><I>PressureRecalibration</I> <I>bool</I>
|
|
|
|
<DD>
|
|
Allows to disable pressure recalibration. Default: true.
|
|
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.
|
|
<DT id="30"><B>Option </B><I>PanScrollThreshold</I> <I>number</I>
|
|
|
|
<DD>
|
|
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).
|
|
</DL>
|
|
</DL>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>TOUCH GESTURES</H2>
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H3>Single finger (1FG)</H3>
|
|
|
|
<P>
|
|
|
|
<B>Left click:</B>
|
|
tap, actual click happens after TapTime period elapses.
|
|
<P>
|
|
|
|
<B>Left click drag:</B>
|
|
tap to select, quickly (within TapTime period) touch selection again. Then drag.
|
|
Available on touchpads, e.g. BambooPT, not touchscreens.
|
|
<P>
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H3>Two finger (2FG)</H3>
|
|
|
|
<P>
|
|
|
|
<B>Right click:</B>
|
|
one finger down + tap second finger
|
|
<P>
|
|
|
|
<B>Vertical scroll:</B>
|
|
two fingers side by side (in any orientation) moving vertically with constant
|
|
separation initiates a vertical scroll. By driver default a gesture up results
|
|
in a scroll down event (the document moves up) and a gesture down results in a
|
|
scroll up event (moving the document down).
|
|
<P>
|
|
|
|
<B>Horizontal scroll:</B>
|
|
two fingers side by side held at a constant distance moving horizontally initiates
|
|
a horizontal scroll. A gesture to the left results in a scroll right event (the
|
|
document moves left) and a gesture right results in a scroll left event (moving
|
|
the document right).
|
|
<P>
|
|
|
|
<B>Zoom in:</B>
|
|
two separated fingers side by side, bring together i.e. pinch.
|
|
<P>
|
|
|
|
<B>Zoom out:</B>
|
|
two fingers side by side, spread. Not all applications support zoom.
|
|
<P>
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
<A NAME="lbAL"> </A>
|
|
<H3>Pressure range increase leads to unexpected behavior</H3>
|
|
|
|
In version 0.34, the driver's pressure range increased from
|
|
2048 steps to 65536 steps. The pressure axis range is advertised through the
|
|
X Input Protocol but some applications have the previous pressure range
|
|
hardcoded and cannot handle pressure values above 2048. This is an
|
|
application bug but for backwards-compatibility with such applications, this
|
|
driver provides the
|
|
<B>Pressure2K</B>
|
|
|
|
option to reduce the range to 2048 steps. Note that this setting applies to
|
|
the device. Once applied, all applications will see the reduced pressure
|
|
range. It is not possible to provide this setting on a per-application
|
|
basis.
|
|
<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?5+xorg.conf">xorg.conf</A>(5),
|
|
<A HREF="/cgi-bin/man/man2html?5+xorg.conf.d">xorg.conf.d</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>
|
|
<A NAME="lbAN"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
Peter Hutterer <<A HREF="mailto:peter.hutterer@who-t.net">peter.hutterer@who-t.net</A>>,
|
|
Ping Cheng <<A HREF="mailto:pingc@wacom.com">pingc@wacom.com</A>>,
|
|
Frederic Lepied <<A HREF="mailto:lepied@xfree86.org">lepied@xfree86.org</A>>,
|
|
John E. Joganic <<A HREF="mailto:jej@j-arkadia.com">jej@j-arkadia.com</A>>,
|
|
Magnus Vigerlöf <<A HREF="mailto:Magnus.Vigerlof@ipbo.se">Magnus.Vigerlof@ipbo.se</A>>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="31"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="32"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="33"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="34"><A HREF="#lbAE">SUPPORTED HARDWARE</A><DD>
|
|
<DT id="35"><A HREF="#lbAF">DRIVER-INTERNAL DEVICE HOTPLUGGING</A><DD>
|
|
<DT id="36"><A HREF="#lbAG">CONFIGURATION DETAILS</A><DD>
|
|
<DT id="37"><A HREF="#lbAH">TOUCH GESTURES</A><DD>
|
|
<DL>
|
|
<DT id="38"><A HREF="#lbAI">Single finger (1FG)</A><DD>
|
|
<DT id="39"><A HREF="#lbAJ">Two finger (2FG)</A><DD>
|
|
</DL>
|
|
<DT id="40"><A HREF="#lbAK">BUGS</A><DD>
|
|
<DL>
|
|
<DT id="41"><A HREF="#lbAL">Pressure range increase leads to unexpected behavior</A><DD>
|
|
</DL>
|
|
<DT id="42"><A HREF="#lbAM">SEE ALSO</A><DD>
|
|
<DT id="43"><A HREF="#lbAN">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:06:02 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|