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 following 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 For example, "key +a +shift b -shift -a" converts the button
116 into a series of keystrokes, in this example "press a, press
117 shift, press and release b, release shift, release a".
118 The "button" keyword is similar except that its arguments are
120 X11 button numbers.
121 The "modetoggle" keyword is also recognized; it takes no argu‐
123 ments, and toggles the device mode between relative and absolute
124 pointer tracking.
125 The events in the action mapping are sent when the physical but‐
127 ton is pressed. If the action mapping leaves any buttons or
128 keys pressed (such as a modifier key), they will be released
129 when the physical button is released.
130 Multiple keywords may be present in one action if desired: for
132 example "key +ctrl button 5 key -ctrl". Each keyword takes all
133 arguments until the next keyword.
134 A maximum of 256 presses and/or releases can be specified in an
136 action mapping.
137 The driver can only simulate physical key events but not keysyms
139 and xsetwacom translates the mapping sequence into such events.
140 Thus, symbols on the same physical key will generate the same
141 event. For example, '1' and '!' are on the same key on a US key‐
142 board and thus have the same keycode). For access to keys on a
143 higher shift level, the sequence should be entered as it would
144 be typed on a physical keyboard. For example, a exclamation mark
145 is entered by the sequence of "key +shift 1 -shift".
146 BindToSerial [serial|0]
148 Bind the device to the tool with the specified serial number.
149 Once bound, the device will ignore events from other tools. A
150 serial of 0 means the device is unbound and will react to any
151 tool of the matching type. Default: 0
152 MapToOutput [output]
154 Map the tablet's input area to a given output (e.g. "VGA1").
155 Output names may either be the name of a head available through
156 the XRandR extension, or an X11 geometry string of the form
157 WIDTHxHEIGHT+X+Y. To switch to the next available output, the
158 "next" keyword is also supported. This will cycle between the
159 individual monitors connected to the system, and then the entire
160 desktop. The mapping may be reset to the entire desktop at any
161 time with the output name "desktop". Users of the NVIDIA binary
162 driver should use the output names "HEAD-0" and "HEAD-1" until
163 the driver supports XRandR 1.2 or later.
164 The output mapping configuration is a onetime setting and does
166 not track output reconfigurations; the command needs to be re-
167 run whenever the output configuration changes. When used with
168 tablet rotation, the tablet must be rotated before it is mapped
169 to the new screen. This parameter is write-only and cannot be
170 queried.
171 Mode Absolute|Relative
173 Set the device mode as either Relative or Absolute. Relative
174 means pointer tracking for the device will function like a
175 mouse, whereas Absolute means the pointer corresponds to the
176 device's actual position on the tablet or tablet PC screen.
177 Default: Absolute for stylus, eraser and tablet PC touch; Rela‐
178 tive for cursor and tablet touch.
179 PressureCurve x1 y1 x2 y2
181 A Bezier curve of third order, composed of two anchor points
182 (0,0 and 100,100) and two user modifiable control points that
183 define the curve's shape. Raise the curve (x1<y1 x2<y2) to
184 "soften" the feel and lower the curve (x1>y1 x2>y2) for a
185 "firmer" feel. Sigmoid shaped curves are permitted (x1>y1 x2<y2
186 or x1<y1 x2>y2). Default: 0 0 100 100, a linear curve; range
187 of 0 to 100 for all four values.
188 RawSample level
190 Set the sample window size (a sliding average sampling window)
191 for incoming input tool raw data points. Default: 4, range of
192 1 to 20.
193 Rotate none|half|cw|ccw
195 Set the tablet to the given rotation:
196 none: the tablet is not rotated and uses its natural rotation
197 half: the tablet is rotated by 180 degrees (upside-down)
198 cw: the tablet is rotated 90 degrees clockwise
199 ccw: the tablet is rotated 90 degrees counter-clockwise
200 Rotation is a tablet-wide option: rotation of one tool affects
202 all other tools associated with the same tablet. When the tablet
203 is physically rotated, rotate any tool to the corresponding ori‐
204 entation. Default: none
205 Suppress level
207 Set the delta (difference) cutoff level for further processing
208 of incoming input tool coordinate values. For example a X or Y
209 coordinate event will be sent only if the change between the
210 current X or Y coordinate and the previous one is greater than
211 the Suppress value. The same applies to pressure level (Z coor‐
212 dinate) and Tilt rotation values. With a current absolute wheel
213 (AbsWheel) or Tilt value the delta between it and the previous
214 value must be equal to or greater than the Suppress value in
215 order to be sent on. Suppress is a tablet wide parameter. A
216 specified delta level for one input tool is applied to all input
217 tool coordinates. To disable suppression use a level of 0.
218 Default: 2, range of 0 to 100.
219 TabletDebugLevel level
221 Set the debug level for this tablet to the given level. This
222 only affects code paths that are shared between several tools on
223 the same physical tablet. A higher level means more fine-grained
224 debug messages, a level of 0 turns debugging off for this tool.
225 Requires the driver to be built with debugging enabled. See also
226 ToolDebugLevel. Default: 0, range of 0 to 12.
227 TabletPCButton on|off
229 If on, the stylus must be in contact with the screen for a sty‐
230 lus side button to work. If off, stylus buttons will work once
231 the stylus is in proximity of the tablet (regardless of whether
232 it is touching the screen). Default: on for Tablet PCs; off
233 for all other models.
234 ToolSerialPrevious
236 Get the serial number of the tool that was last in proximity
237 last. This serial number is updated whenever the tool goes out
238 of proximity. If the current tool went out of proximity once,
239 this serial number is the one of the current tool. This is a
240 read-only parameter.
241 Touch on|off
243 If on, touch events are reported to userland, i.e., system cur‐
244 sor moves when user touches the tablet. If off, touch events are
245 ignored. Default: on for devices that support touch; off for all
246 other models.
247 HWTouchSwitchState on|off
249 If on, it means touch switch is turned off. That is, touch
250 events are reported to userland. If off, touch switch is turned
251 on, i.e., touch events are ignored. This is a read-only parame‐
252 ter. Initial touch switch state is retrieved from the kernel
253 when X driver starts.
254 CursorProximity distance
256 sets the max distance from tablet to stop reporting movement for
257 cursor in relative mode. Default for Intuos series is 10, for
258 Graphire series (including Volitos) is 42. Only available for
259 the cursor/puck device.
260 Threshold level
262 Set the minimum pressure necessary to generate a Button event
263 for the stylus tip, eraser, or touch. The pressure levels of
264 all tablets are normalized to 2048 levels irregardless of the
265 actual hardware supported levels. This parameter is independent
266 of the PressureCurve parameter. Default: 27, range of 0 to
267 2047.
268 ToolDebugLevel level
270 Set the debug level for this tool to the given level. This only
271 affects code paths that are specific to a given tool. A higher
272 level means more fine-grained debug messages, a level of 0 turns
273 debugging off for this tool. Requires the driver to be built
274 with debugging enabled. See also TabletDebugLevel. Default: 0,
275 range of 0 to 12.
276 PressureRecalibration on|off
278 If the initial pressure of a device is != 0 the driver recali‐
279 brates the pressure range. This is to account for worn out
280 devices. The downside is that when the user hits the tablet
281 very hard the initial pressure reading may be unequal to zero
282 even for a perfectly good pen. If the consecutive pressure read‐
283 ings are not higher than the initial pressure by a threshold no
284 button event will be generated. This option allows to disable
285 the recalibration. Default: on
286
290 Peter Hutterer <peter.hutterer@redhat.com>
291
294 Xorg(1), wacom(4), xorg.conf(5), X(7)
295 More information is available at http://linuxwacom.sourceforge.net
297X Version 11 xf86-input-wacom 0.32.0 xsetwacom(1)