aboutsummaryrefslogtreecommitdiffstats
path: root/sway/sway-input.5.scd
diff options
context:
space:
mode:
Diffstat (limited to 'sway/sway-input.5.scd')
-rw-r--r--sway/sway-input.5.scd47
1 files changed, 34 insertions, 13 deletions
diff --git a/sway/sway-input.5.scd b/sway/sway-input.5.scd
index dbf21d93..442311bb 100644
--- a/sway/sway-input.5.scd
+++ b/sway/sway-input.5.scd
@@ -111,6 +111,9 @@ The following commands may only be used in the configuration file.
111 Maps inputs from this device to the specified output. Only meaningful if the 111 Maps inputs from this device to the specified output. Only meaningful if the
112 device is a pointer, touch, or drawing tablet device. 112 device is a pointer, touch, or drawing tablet device.
113 113
114 The wildcard _\*_ can be used to map the input device to the whole desktop
115 layout.
116
114*input* <identifier> map_to_region <X> <Y> <width> <height> 117*input* <identifier> map_to_region <X> <Y> <width> <height>
115 Maps inputs from this device to the specified region of the global output 118 Maps inputs from this device to the specified region of the global output
116 layout. Only meaningful if the device is a pointer, touch, or drawing tablet 119 layout. Only meaningful if the device is a pointer, touch, or drawing tablet
@@ -118,11 +121,16 @@ The following commands may only be used in the configuration file.
118 121
119*input* <identifier> map_from_region <X1xY1> <X2xY2> 122*input* <identifier> map_from_region <X1xY1> <X2xY2>
120 Ignores inputs from this device that do not occur within the specified 123 Ignores inputs from this device that do not occur within the specified
121 region. Can be in millimeters (e.g. 10x20mm 20x40mm) or in terms of 0..1 124 region. Can be in millimeters (e.g. 10x20mm 20x40mm) or the fraction of the
122 (e.g. 0.5x0.5 0.7x0.7). Not all devices support millimeters. Only meaningful 125 full available space in terms of 0..1 (e.g. 0.5x0.5 0.7x0.7). Not all
123 if the device is not a keyboard and provides events in absolute terms (such 126 devices support millimeters. Only meaningful if the device is not a
124 as a drawing tablet or touch screen - most pointers provide events relative 127 keyboard and provides events in absolute terms (such as a drawing tablet
125 to the previous frame). 128 or touch screen - most pointers provide events relative to the previous
129 frame).
130
131 Commonly used to maintain the aspect ratio of the input device and screen.
132 Cropping a 16:10 input region to match a 16:9 display can use 0x0 1x0.9 as
133 the argument.
126 134
127## LIBINPUT CONFIGURATION 135## LIBINPUT CONFIGURATION
128 136
@@ -144,6 +152,10 @@ The following commands may only be used in the configuration file.
144*input* <identifier> dwt enabled|disabled 152*input* <identifier> dwt enabled|disabled
145 Enables or disables disable-while-typing for the specified input device. 153 Enables or disables disable-while-typing for the specified input device.
146 154
155*input* <identifier> dwtp enabled|disabled
156 Enables or disables disable-while-trackpointing for the specified input
157 device.
158
147*input* <identifier> events enabled|disabled|disabled_on_external_mouse|toggle [<toggle-modes>] 159*input* <identifier> events enabled|disabled|disabled_on_external_mouse|toggle [<toggle-modes>]
148 Enables or disables send_events for specified input device. Disabling 160 Enables or disables send_events for specified input device. Disabling
149 send_events disables the input device. 161 send_events disables the input device.
@@ -168,12 +180,19 @@ The following commands may only be used in the configuration file.
168*input* <identifier> pointer_accel [<-1|1>] 180*input* <identifier> pointer_accel [<-1|1>]
169 Changes the pointer acceleration for the specified input device. 181 Changes the pointer acceleration for the specified input device.
170 182
183*input* <identifier> rotation_angle <angle>
184 Sets the rotation angle of the device to the given clockwise angle in
185 degrees. The angle must be between 0.0 (inclusive) and 360.0 (exclusive).
186
171*input* <identifier> scroll_button disable|button[1-3,8,9]|<event-code-or-name> 187*input* <identifier> scroll_button disable|button[1-3,8,9]|<event-code-or-name>
172 Sets the button used for scroll_method on_button_down. The button can 188 Sets the button used for scroll_method on_button_down. The button can
173 be given as an event name or code, which can be obtained from *libinput 189 be given as an event name or code, which can be obtained from *libinput
174 debug-events*, or as a x11 mouse button (button[1-3,8,9]). If set to 190 debug-events*, or as a x11 mouse button (button[1-3,8,9]). If set to
175 _disable_, it disables the scroll_method on_button_down. 191 _disable_, it disables the scroll_method on_button_down.
176 192
193*input* <identifier> scroll_button_lock enabled|disabled
194 Enables or disables scroll button lock for specified input device.
195
177*input* <identifier> scroll_factor <floating point value> 196*input* <identifier> scroll_factor <floating point value>
178 Changes the scroll factor for the specified input device. Scroll speed will 197 Changes the scroll factor for the specified input device. Scroll speed will
179 be scaled by the given value, which must be non-negative. 198 be scaled by the given value, which must be non-negative.
@@ -217,6 +236,8 @@ correct seat.
217 absolute coordinates (with respect to the global coordinate space). 236 absolute coordinates (with respect to the global coordinate space).
218 Specifying either value as 0 will not update that coordinate. 237 Specifying either value as 0 will not update that coordinate.
219 238
239 Deprecated: use the virtual-pointer Wayland protocol instead.
240
220*seat* <seat> cursor press|release button[1-9]|<event-name-or-code> 241*seat* <seat> cursor press|release button[1-9]|<event-name-or-code>
221 Simulate pressing (or releasing) the specified mouse button on the 242 Simulate pressing (or releasing) the specified mouse button on the
222 specified seat. The button can either be provided as a button event name or 243 specified seat. The button can either be provided as a button event name or
@@ -225,12 +246,14 @@ correct seat.
225 event will be simulated, however _press_ and _release_ will be ignored and 246 event will be simulated, however _press_ and _release_ will be ignored and
226 both will occur. 247 both will occur.
227 248
249 Deprecated: use the virtual-pointer Wayland protocol instead.
250
228*seat* <name> fallback true|false 251*seat* <name> fallback true|false
229 Set this seat as the fallback seat. A fallback seat will attach any device 252 Set this seat as the fallback seat. A fallback seat will attach any device
230 not explicitly attached to another seat (similar to a "default" seat). 253 not explicitly attached to another seat (similar to a "default" seat).
231 254
232*seat* <name> hide_cursor <timeout>|when-typing [enable|disable] 255*seat* <name> hide_cursor <timeout>|when-typing [enable|disable]
233 Hides the cursor image after the specified event occured. 256 Hides the cursor image after the specified event occurred.
234 257
235 If _timeout_ is specified, then the cursor will be hidden after _timeout_ 258 If _timeout_ is specified, then the cursor will be hidden after _timeout_
236 (in milliseconds) has elapsed with no activity on the cursor. A timeout of 0 259 (in milliseconds) has elapsed with no activity on the cursor. A timeout of 0
@@ -240,18 +263,16 @@ correct seat.
240 If _when-typing_ is enabled, then the cursor will be hidden whenever a key 263 If _when-typing_ is enabled, then the cursor will be hidden whenever a key
241 is pressed. 264 is pressed.
242 265
266 Be aware that this setting can interfere with input handling in games and
267 certain types of software (Gimp, Blender etc) that rely on simultaneous
268 input from mouse and keyboard.
269
243*seat* <name> idle_inhibit <sources...> 270*seat* <name> idle_inhibit <sources...>
244 Sets the set of input event sources which can prevent the seat from 271 Sets the set of input event sources which can prevent the seat from
245 becoming idle, as a space separated list of source names. Valid names are 272 becoming idle, as a space separated list of source names. Valid names are
246 "keyboard", "pointer", "touchpad", "touch", "tablet_pad", "tablet_tool", 273 "keyboard", "pointer", "touchpad", "touch", "tablet_pad", "tablet_tool",
247 and "switch". The default behavior is to prevent idle on any event. 274 and "switch". The default behavior is to prevent idle on any event.
248 275
249*seat* <name> idle_wake <sources...>
250 Sets the set of input event sources which can wake the seat from
251 its idle state, as a space separated list of source names. Valid names are
252 "keyboard", "pointer", "touchpad", "touch", "tablet_pad", "tablet_tool",
253 and "switch". The default behavior is to wake from idle on any event.
254
255*seat* <name> keyboard_grouping none|smart 276*seat* <name> keyboard_grouping none|smart
256 Set how the keyboards in the seat are grouped together. Currently, there 277 Set how the keyboards in the seat are grouped together. Currently, there
257 are two options. _none_ will disable all keyboard grouping. This will make 278 are two options. _none_ will disable all keyboard grouping. This will make
@@ -274,7 +295,7 @@ correct seat.
274 whether future inhibitors are honoured by default, i.e. activated 295 whether future inhibitors are honoured by default, i.e. activated
275 automatically, the default being _enable_. When used at runtime, 296 automatically, the default being _enable_. When used at runtime,
276 _disable_ also disables any currently active inhibitors. _activate_, 297 _disable_ also disables any currently active inhibitors. _activate_,
277 _deactivate_ and _toggle_ are only useable at runtime and change the 298 _deactivate_ and _toggle_ are only usable at runtime and change the
278 state of a potentially existing inhibitor on the currently focused 299 state of a potentially existing inhibitor on the currently focused
279 window. This can be used with the current seat alias (_-_) to affect 300 window. This can be used with the current seat alias (_-_) to affect
280 only the currently focused window of the current seat. Subcommand 301 only the currently focused window of the current seat. Subcommand