1xsetwacom(1) General Commands Manual xsetwacom(1)
2
6 xsetwacom - commandline utility to query and modify wacom driver set‐
7 tings.
8
10 xsetwacom [options] [command [arguments]]
11
14 This program queries or changes properties on the devices loaded by the
15 wacom driver. The modification of properties happens at runtime and is
16 not persistent through X server restarts.
17
19 -d, --display display_name
20 Connect to the X server specified in display_name; see X(7).
21 -h, --help
23 Prints a short help.
24 -v, --verbose
26 Enable verbose output, useful for debugging.
27 -V, --version
29 Display version number and exit.
30
33 Allowed commands are list, get, and set. The command may be specified
34 with or without one or two preceding dashes, i.e. --list is equivalent
35 to -list and list.
36 LIST COMMANDS
39 list devices
40 List known devices. Only input devices managed by the wacom
41 driver are listed.
42 list parameters
44 List known parameters. List all parameters suitable for the get
45 or the set command. Note that not all parameters are available
46 on all device types.
47 list modifiers
49 List the aliases for modifiers and other keys that can be used
50 when setting button action mappings.
51 GET COMMANDS
54 get device_name parameter
55 Get the current settings for the parameter on the given device.
56 Note that not all parameters are available on all device types.
57 The special parameter name "all" may be provided to display all
58 current settings on the device.
59 By default, options are printed on the commandline in the respective
61 format.
62 The output format may be altered with one of the following
63 options:
64 -s, --shell
66 Display the output in shell format, i.e. as shell commands to
67 xsetwacom to reproduce the same parameter.
68 -x, --xconf
70 Display the output in xorg.conf format, i.e. as option lines
71 that may be added to the InputDevice section in the xorg.conf.
72 SET COMMANDS
75 set device_name parameter [value]
76 Set the parameter value on the given device to the value pro‐
77 vided. Note that not all parameters are writable, some are read-
78 only and result in an error when trying to be modified.
79
82 Not all parameters are available on all tools. Use the get command
83 with the parameter or "all" parameter for specific input tool applica‐
84 ble parameters and current settings.
85 Area x1 y1 x2 y2
87 Set the tablet input area in device coordinates in the form top
88 left x/y and bottom right x/y. Top left and bottom right are
89 defined in the device's native orientation, regardless of the
90 actual rotation currently applied. Input outside of these coor‐
91 dinates will be clipped to the edges of the area defined.
92 Default: 0 0 x2 y2; with x2 and y2 tablet specific.
93 Button button-number [mapping]
95 Set a mapping for the specified button-number. Mappings take the
96 form of either a single numeric button or an 'action' to be per‐
97 formed. If no mapping is provided, the default mapping is
98 restored.
99 Numeric button mappings indicate what X11 button number the
101 given button-number should correspond to. For example, a mapping
102 of "3" means a press of the given button-number will produce a
103 press of X11 button 3 (i.e. right click).
104 Action mappings allow button presses to perform many events.
106 They take the form of a string of keywords and arguments.
107 The "key" keyword is followed by a list of key names. These can
109 optionally be preceded by "+" for press and "-" for release. If
110 +/- is not given, press-and-release is assumed, except for modi‐
111 fier keys which are left pressed. Key names can be X11 KeySyms
112 or some aliases such as 'shift' or 'f1' (the full list can be
113 seen with the list modifiers command).
114 To assign a key that is not in the modifiers list, use the
116 KeySym in /usr/include/X11/keysymdef.h with the XK_ prefix
117 removed or its actual value as is. For example, XK_BackSpace
118 should be specified as "BackSpace". "0xff80" can also be used to
119 replace "BackSpace" since it's the unique KeySym value of
120 Backspace key.
121 Here is a combined example: "key +a shift b shift -a 0xff0d"
123 converts the button into a series of keystrokes. In this exam‐
124 ple, "press a, press shift, press and release b, release shift,
125 release a, then press and release enter". "key +a +shift b
126 -shift -a 0xff0d" does the same thing.
127 The "button" keyword is similar except that its arguments are
129 X11 button numbers.
130 The "modetoggle" keyword is also recognized; it takes no argu‐
132 ments, and toggles the device mode between relative and absolute
133 pointer tracking.
134 The "pan" keyword causes the driver to send scroll events while
136 the pen is dragged. This makes it easy to scroll through lists
137 and documents, pan around 2D canvases, and zoom in/out of 3D
138 scenes (exact behavior depends on application interpretation of
139 scrollwheel events). Dragging the pen up/down will send scroll‐
140 wheel down/up events; dragging it left/right will send scroll‐
141 wheel right/left events.
142 The events in the action mapping are sent when the physical but‐
144 ton is pressed. If the action mapping leaves any buttons or
145 keys pressed (such as a modifier key), they will be released
146 when the physical button is released.
147 Multiple keywords may be present in one action if desired: for
149 example "key +ctrl button 5 key -ctrl". Each keyword takes all
150 arguments until the next keyword.
151 A maximum of 256 presses and/or releases can be specified in an
153 action mapping.
154 The driver can only simulate physical key events but not keysyms
156 and xsetwacom translates the mapping sequence into such events.
157 Thus, symbols on the same physical key will generate the same
158 event. For example, '1' and '!' are on the same key on a US key‐
159 board and thus have the same keycode). For access to keys on a
160 higher shift level, the sequence should be entered as it would
161 be typed on a physical keyboard. For example, a exclamation mark
162 is entered by the sequence of "key +shift 1 -shift".
163 BindToSerial [serial|0]
165 Bind the device to the tool with the specified serial number.
166 Once bound, the device will ignore events from other tools. A
167 serial of 0 means the device is unbound and will react to any
168 tool of the matching type. Default: 0
169 MapToOutput [output]
171 Map the tablet's input area to a given output (e.g. "VGA1").
172 Output names may either be the name of a head available through
173 the XRandR extension, or an X11 geometry string of the form
174 WIDTHxHEIGHT+X+Y. To switch to the next available output, the
175 "next" keyword is also supported. This will cycle between the
176 individual monitors connected to the system, and then the entire
177 desktop. The mapping may be reset to the entire desktop at any
178 time with the output name "desktop". Users of the NVIDIA binary
179 driver should use the output names "HEAD-0" and "HEAD-1" until
180 the driver supports XRandR 1.2 or later.
181 The output mapping configuration is a onetime setting and does
183 not track output reconfigurations; the command needs to be re-
184 run whenever the output configuration changes. When used with
185 tablet rotation, the tablet must be rotated before it is mapped
186 to the new screen. This parameter is write-only and cannot be
187 queried.
188 Mode Absolute|Relative
190 Set the device mode as either Relative or Absolute. Relative
191 means pointer tracking for the device will function like a
192 mouse, whereas Absolute means the pointer corresponds to the
193 device's actual position on the tablet or tablet PC screen.
194 Default: Absolute for stylus, eraser and tablet PC touch; Rela‐
195 tive for cursor and tablet touch.
196 PressureCurve x1 y1 x2 y2
198 A Bezier curve of third order, composed of two anchor points
199 (0,0 and 100,100) and two user modifiable control points that
200 define the curve's shape. Raise the curve (x1<y1 x2<y2) to
201 "soften" the feel and lower the curve (x1>y1 x2>y2) for a
202 "firmer" feel. Sigmoid shaped curves are permitted (x1>y1 x2<y2
203 or x1<y1 x2>y2). Default: 0 0 100 100, a linear curve; range
204 of 0 to 100 for all four values.
205 RawSample level
207 Set the sample window size (a sliding average sampling window)
208 for incoming input tool raw data points. Default: 4, range of
209 1 to 20.
210 Rotate none|half|cw|ccw
212 Set the tablet to the given rotation:
213 none: the tablet is not rotated and uses its natural rotation
214 half: the tablet is rotated by 180 degrees (upside-down)
215 cw: the tablet is rotated 90 degrees clockwise
216 ccw: the tablet is rotated 90 degrees counter-clockwise
217 Rotation is a tablet-wide option: rotation of one tool affects
219 all other tools associated with the same tablet. When the tablet
220 is physically rotated, rotate any tool to the corresponding ori‐
221 entation. Default: none
222 Suppress level
224 Set the delta (difference) cutoff level for further processing
225 of incoming input tool coordinate values. For example a X or Y
226 coordinate event will be sent only if the change between the
227 current X or Y coordinate and the previous one is greater than
228 the Suppress value. The same applies to pressure level (Z coor‐
229 dinate) and Tilt rotation values. With a current absolute wheel
230 (AbsWheel) or Tilt value the delta between it and the previous
231 value must be equal to or greater than the Suppress value in
232 order to be sent on. Suppress is a tablet wide parameter. A
233 specified delta level for one input tool is applied to all input
234 tool coordinates. To disable suppression use a level of 0.
235 Default: 2, range of 0 to 100.
236 TabletDebugLevel level
238 Set the debug level for this tablet to the given level. This
239 only affects code paths that are shared between several tools on
240 the same physical tablet. A higher level means more fine-grained
241 debug messages, a level of 0 turns debugging off for this tool.
242 Requires the driver to be built with debugging enabled. See also
243 ToolDebugLevel. Default: 0, range of 0 to 12.
244 TabletPCButton on|off
246 If on, the stylus must be in contact with the screen for a sty‐
247 lus side button to work. If off, stylus buttons will work once
248 the stylus is in proximity of the tablet (regardless of whether
249 it is touching the screen). Default: on for Tablet PCs; off
250 for all other models.
251 ToolSerialPrevious
253 Get the serial number of the tool that was last in proximity
254 last. This serial number is updated whenever the tool goes out
255 of proximity. If the current tool went out of proximity once,
256 this serial number is the one of the current tool. This is a
257 read-only parameter.
258 Touch on|off
260 If on, touch events are reported to userland, i.e., system cur‐
261 sor moves when user touches the tablet. If off, touch events are
262 ignored. Default: on for devices that support touch; off for all
263 other models.
264 HWTouchSwitchState on|off
266 If on, it means touch switch is turned off. That is, touch
267 events are reported to userland. If off, touch switch is turned
268 on, i.e., touch events are ignored. This is a read-only parame‐
269 ter. Initial touch switch state is retrieved from the kernel
270 when X driver starts.
271 CursorProximity distance
273 sets the max distance from tablet to stop reporting movement for
274 cursor in relative mode. Default for Intuos series is 10, for
275 Graphire series (including Volitos) is 42. Only available for
276 the cursor/puck device.
277 Threshold level
279 Set the minimum pressure necessary to generate a Button event
280 for the stylus tip, eraser, or touch. The pressure levels of
281 all tablets are normalized to 2048 levels irregardless of the
282 actual hardware supported levels. This parameter is independent
283 of the PressureCurve parameter. Default: 27, range of 0 to
284 2047.
285 ToolDebugLevel level
287 Set the debug level for this tool to the given level. This only
288 affects code paths that are specific to a given tool. A higher
289 level means more fine-grained debug messages, a level of 0 turns
290 debugging off for this tool. Requires the driver to be built
291 with debugging enabled. See also TabletDebugLevel. Default: 0,
292 range of 0 to 12.
293 PressureRecalibration on|off
295 If the initial pressure of a device is != 0 the driver recali‐
296 brates the pressure range. This is to account for worn out
297 devices. The downside is that when the user hits the tablet
298 very hard the initial pressure reading may be unequal to zero
299 even for a perfectly good pen. If the consecutive pressure read‐
300 ings are not higher than the initial pressure by a threshold no
301 button event will be generated. This option allows to disable
302 the recalibration. Default: on
303 PanScrollThreshold distance
305 This specifies the distance the pen must move (in tablet units)
306 before a scroll event is generated when using the "pan" action.
307 Smaller values will require less distance and be more sensitive.
308 Larger values will require more distance and be less sensitive.
309 Default: 1300 or 2600 depending on tablet resolution (corre‐
310 sponds to 13 mm of distance).
311
314 This tool provides access to the device properties implemented in the
315 xf86-input-wacom X server input module. It does not work under a Way‐
316 land compositor as the input module is not active.
317 See https://github.com/linuxwacom/xf86-input-wacom/wiki/Wayland for
319 details.
320
324 Peter Hutterer <peter.hutterer@redhat.com>
325
328 Xorg(1), wacom(4), xorg.conf(5), X(7)
329 More information is available at http://linuxwacom.sourceforge.net
331X Version 11 xf86-input-wacom 0.36.1 xsetwacom(1)