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 op‐
63 tions:
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 de‐
89 fined in the device's native orientation, regardless of the ac‐
90 tual rotation currently applied. Input outside of these coordi‐
91 nates will be clipped to the edges of the area defined. De‐
92 fault: 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 re‐
98 stored. If button-number is mapped to 0, the Button event is ig‐
99 nored.
100 Numeric button mappings indicate what X11 button number the
102 given button-number should correspond to. For example, a mapping
103 of "3" means a press of the given button-number will produce a
104 press of X11 button 3 (i.e. right click).
105 Action mappings allow button presses to perform many events.
107 They take the form of a string of keywords and arguments.
108 The "key" keyword is followed by a list of key names. These can
110 optionally be preceded by "+" for press and "-" for release. If
111 +/- is not given, press-and-release is assumed, except for modi‐
112 fier keys which are left pressed. Key names can be X11 KeySyms
113 or some aliases such as 'shift' or 'f1' (the full list can be
114 seen with the list modifiers command).
115 To assign a key that is not in the modifiers list, use the
117 KeySym in /usr/include/X11/keysymdef.h with the XK_ prefix re‐
118 moved or its actual value as is. For example, XK_BackSpace
119 should be specified as "BackSpace". "0xff80" can also be used to
120 replace "BackSpace" since it's the unique KeySym value of
121 Backspace key.
122 Here is a combined example: "key +a shift b shift -a 0xff0d"
124 converts the button into a series of keystrokes. In this exam‐
125 ple, "press a, press shift, press and release b, release shift,
126 release a, then press and release enter". "key +a +shift b
127 -shift -a 0xff0d" does the same thing.
128 The "button" keyword is similar except that its arguments are
130 X11 button numbers.
131 The "modetoggle" keyword is also recognized; it takes no argu‐
133 ments, and toggles the device mode between relative and absolute
134 pointer tracking.
135 The "pan" keyword causes the driver to send scroll events while
137 the pen is dragged. This makes it easy to scroll through lists
138 and documents, pan around 2D canvases, and zoom in/out of 3D
139 scenes (exact behavior depends on application interpretation of
140 scrollwheel events). Dragging the pen up/down will send scroll‐
141 wheel down/up events; dragging it left/right will send scroll‐
142 wheel right/left events.
143 The events in the action mapping are sent when the physical but‐
145 ton is pressed. If the action mapping leaves any buttons or
146 keys pressed (such as a modifier key), they will be released
147 when the physical button is released.
148 Multiple keywords may be present in one action if desired: for
150 example "key +ctrl button 5 key -ctrl". Each keyword takes all
151 arguments until the next keyword.
152 A maximum of 256 presses and/or releases can be specified in an
154 action mapping.
155 The driver can only simulate physical key events but not keysyms
157 and xsetwacom translates the mapping sequence into such events.
158 Thus, symbols on the same physical key will generate the same
159 event. For example, '1' and '!' are on the same key on a US key‐
160 board and thus have the same keycode). For access to keys on a
161 higher shift level, the sequence should be entered as it would
162 be typed on a physical keyboard. For example, a exclamation mark
163 is entered by the sequence of "key +shift 1 -shift".
164 BindToSerial [serial|0]
166 Bind the device to the tool with the specified serial number.
167 Once bound, the device will ignore events from other tools. A
168 serial of 0 means the device is unbound and will react to any
169 tool of the matching type. Default: 0
170 MapToOutput [output]
172 Map the tablet's input area to a given output (e.g. "VGA1").
173 Output names may either be the name of a head available through
174 the XRandR extension, or an X11 geometry string of the form
175 WIDTHxHEIGHT+X+Y. To switch to the next available output, the
176 "next" keyword is also supported. This will cycle between the
177 individual monitors connected to the system, and then the entire
178 desktop. The mapping may be reset to the entire desktop at any
179 time with the output name "desktop". Users of the NVIDIA binary
180 driver should use the output names "HEAD-0" and "HEAD-1" until
181 the driver supports XRandR 1.2 or later.
182 The output mapping configuration is a onetime setting and does
184 not track output reconfigurations; the command needs to be re-
185 run whenever the output configuration changes. When used with
186 tablet rotation, the tablet must be rotated before it is mapped
187 to the new screen. This parameter is write-only and cannot be
188 queried.
189 Mode Absolute|Relative
191 Set the device mode as either Relative or Absolute. Relative
192 means pointer tracking for the device will function like a
193 mouse, whereas Absolute means the pointer corresponds to the de‐
194 vice's actual position on the tablet or tablet PC screen. De‐
195 fault: Absolute for stylus, eraser and tablet PC touch; Rela‐
196 tive for cursor and tablet touch.
197 PressureCurve x1 y1 x2 y2
199 A Bezier curve of third order, composed of two anchor points
200 (0,0 and 100,100) and two user modifiable control points that
201 define the curve's shape. Raise the curve (x1<y1 x2<y2) to
202 "soften" the feel and lower the curve (x1>y1 x2>y2) for a
203 "firmer" feel. Sigmoid shaped curves are permitted (x1>y1 x2<y2
204 or x1<y1 x2>y2). Default: 0 0 100 100, a linear curve; range
205 of 0 to 100 for all four values.
206 RawSample level
208 Set the sample window size (a sliding average sampling window)
209 for incoming input tool raw data points. Default: 4, range of
210 1 to 20.
211 Rotate none|half|cw|ccw
213 Set the tablet to the given rotation:
214 none: the tablet is not rotated and uses its natural rotation
215 half: the tablet is rotated by 180 degrees (upside-down)
216 cw: the tablet is rotated 90 degrees clockwise
217 ccw: the tablet is rotated 90 degrees counter-clockwise
218 Rotation is a tablet-wide option: rotation of one tool affects
220 all other tools associated with the same tablet. When the tablet
221 is physically rotated, rotate any tool to the corresponding ori‐
222 entation. Default: none
223 Suppress level
225 Set the delta (difference) cutoff level for further processing
226 of incoming input tool coordinate values. For example a X or Y
227 coordinate event will be sent only if the change between the
228 current X or Y coordinate and the previous one is greater than
229 the Suppress value. The same applies to pressure level (Z coor‐
230 dinate) and Tilt rotation values. With a current absolute wheel
231 (AbsWheel) or Tilt value the delta between it and the previous
232 value must be equal to or greater than the Suppress value in or‐
233 der to be sent on. Suppress is a tablet wide parameter. A
234 specified delta level for one input tool is applied to all input
235 tool coordinates. To disable suppression use a level of 0. De‐
236 fault: 2, range of 0 to 100.
237 TabletDebugLevel level
239 Set the debug level for this tablet to the given level. This
240 only affects code paths that are shared between several tools on
241 the same physical tablet. A higher level means more fine-grained
242 debug messages, a level of 0 turns debugging off for this tool.
243 Requires the driver to be built with debugging enabled. See also
244 ToolDebugLevel. Default: 0, range of 0 to 12.
245 TabletPCButton on|off
247 If on, the stylus must be in contact with the screen for a sty‐
248 lus side button to work. If off, stylus buttons will work once
249 the stylus is in proximity of the tablet (regardless of whether
250 it is touching the screen). Default: on for Tablet PCs; off
251 for all other models.
252 ToolSerialPrevious
254 Get the serial number of the tool that was last in proximity
255 last. This serial number is updated whenever the tool goes out
256 of proximity. If the current tool went out of proximity once,
257 this serial number is the one of the current tool. This is a
258 read-only parameter.
259 Touch on|off
261 If on, touch events are reported to userland, i.e., system cur‐
262 sor moves when user touches the tablet. If off, touch events are
263 ignored. Default: on for devices that support touch; off for all
264 other models.
265 HWTouchSwitchState on|off
267 If on, it means touch switch is turned off. That is, touch
268 events are reported to userland. If off, touch switch is turned
269 on, i.e., touch events are ignored. This is a read-only parame‐
270 ter. Initial touch switch state is retrieved from the kernel
271 when X driver starts.
272 CursorProximity distance
274 Set the distance at which a relative tool is treated as being
275 out of proximity. Beyond this distance the cursor will stop re‐
276 sponding to tool motion. The default value for pucks is 10 (In‐
277 tuos Pro) or 42 (Intuos/Bamboo). The default value for pens is
278 30.
279 Threshold level
281 Set the minimum pressure necessary to generate a Button event
282 for the stylus tip, eraser, or touch. The pressure levels of
283 all tablets are normalized to 2048 levels irregardless of the
284 actual hardware supported levels. This parameter is independent
285 of the PressureCurve parameter. Default: 27, range of 0 to
286 2047.
287 ToolDebugLevel level
289 Set the debug level for this tool to the given level. This only
290 affects code paths that are specific to a given tool. A higher
291 level means more fine-grained debug messages, a level of 0 turns
292 debugging off for this tool. Requires the driver to be built
293 with debugging enabled. See also TabletDebugLevel. Default: 0,
294 range of 0 to 12.
295 PressureRecalibration on|off
297 If the initial pressure of a device is != 0 the driver recali‐
298 brates the pressure range. This is to account for worn out de‐
299 vices. The downside is that when the user hits the tablet very
300 hard the initial pressure reading may be unequal to zero even
301 for a perfectly good pen. If the consecutive pressure readings
302 are not higher than the initial pressure by a threshold no but‐
303 ton event will be generated. This option allows to disable the
304 recalibration. Default: on
305 PanScrollThreshold distance
307 This specifies the distance the pen must move (in tablet units)
308 before a scroll event is generated when using the "pan" action.
309 Smaller values will require less distance and be more sensitive.
310 Larger values will require more distance and be less sensitive.
311 Default: 1300 or 2600 depending on tablet resolution (corre‐
312 sponds to 13 mm of distance).
313
316 This tool provides access to the device properties implemented in the
317 xf86-input-wacom X server input module. It does not work under a Way‐
318 land compositor as the input module is not active.
319 See https://github.com/linuxwacom/xf86-input-wacom/wiki/Wayland for de‐
321 tails.
322
326 Peter Hutterer <peter.hutterer@redhat.com>
327
330 Xorg(1), wacom(4), xorg.conf(5), X(7)
331 More information is available at https://github.com/linuxwacom/xf86-in‐
333 put-wacom
334 xf86-input-wacom 1.1.0 xsetwacom(1)