From d9a08b7a9df64ba434252d6adfa08aabb4c5c31e Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Fri, 11 May 2018 21:25:05 -0400 Subject: Add sway-input(5) --- meson.build | 1 + sway/sway-input.5.scd | 120 +++++++++++++++++++++++++++++++++++++++++++++ sway/sway-input.5.txt | 131 -------------------------------------------------- 3 files changed, 121 insertions(+), 131 deletions(-) create mode 100644 sway/sway-input.5.scd delete mode 100644 sway/sway-input.5.txt diff --git a/meson.build b/meson.build index 6b0f6a15..1e303e72 100644 --- a/meson.build +++ b/meson.build @@ -56,6 +56,7 @@ if scdoc.found() 'sway/sway.1.scd', 'sway/sway.5.scd', 'sway/sway-bar.5.scd', + 'sway/sway-input.5.scd', ] foreach filename : man_files topic = filename.split('.')[-3].split('/')[-1] diff --git a/sway/sway-input.5.scd b/sway/sway-input.5.scd new file mode 100644 index 00000000..c07460b1 --- /dev/null +++ b/sway/sway-input.5.scd @@ -0,0 +1,120 @@ +sway-input(5) + +# NAME + +sway-input - input configuration file and commands + +# DESCRIPTION + +Sway allows for configuration of devices within the sway configuration file. +sway-input commands must be used inside an _input { }_ block in the config. +To obtain a list of available device identifiers, run *swaymsg -t get\_inputs*. + +# INPUT COMMANDS + +## KEYBOARD CONFIGURATION + +For more information on these xkb configuration options, see +*xkeyboard-config*(7). + +*input* xkb\_layout + Sets the layout of the keyboard like _us_ or _de_. + +*input* xkb\_model + Sets the model of the keyboard. This has an influence for some extra keys + your keyboard might have. + +*input* xkb\_options + Sets extra xkb configuration options for the keyboard. + +*input* xkb\_rules + Sets files of rules to be used for keyboard mapping composition. + +*input* xkb\_variant + Sets the variant of the keyboard like _dvorak_ or _colemak_. + +## MAPPING CONFIGURATION + +*input* map\_to\_output + Maps inputs from this device to the specified output. Only meaningful if the + device is a pointer, touch, or drawing tablet device. + +*input* map\_to\_region + Maps inputs from this device to the specified region of the global output + layout. Only meaningful if the device is a pointer, touch, or drawing tablet + device. + +*input* map\_from\_region + Ignores inputs from this device that do not occur within the specified + region. Can be in millimeters (e.g. 10x20mm 20x40mm) or in terms of 0..1 + (e.g. 0.5x0.5 0.7x0.7). Not all devices support millimeters. Only meaningful + if the device is not a keyboard an provides events in absolute terms (such + as a drawing tablet or touch screen - most pointers provide events relative + to the previous frame). + +## LIBINPUT CONFIGURATION + +*input* accel\_profile adaptive|flat + Sets the pointer acceleration profile for the specified input device. + +*input* click\_method none|button\_areas|clickfinger + Changes the click method for the specified device. + +*input* drag\_lock enabled|disabled + Enables or disables drag lock for specified input device. + +*input* dwt enabled|disabled + Enables or disables disable-while-typing for the specified input device. + +*input* events enabled|disabled|disabled\_on\_external\_mouse + Enables or disables send_events for specified input device. (Disabling + send_events disables the input device) + +*input* left\_handed enabled|disabled + Enables or disables left handed mode for specified input device. + +*input* middle\_emulation enabled|disabled + Enables or disables middle click emulation. + +*input* natural\_scroll enabled|disabled + Enables or disables natural (inverted) scrolling for the specified input + device. + +*input* pointer\_accel [<-1|1>] + Changes the pointer acceleration for the specified input device. + +*input* repeat\_delay + Sets the amount of time a key must be held before it starts repeating. + +*input* repeat\_rate + Sets the frequency of key repeats once the repeat\_delay has passed. + +*input* scroll\_method none|two\_finger|edge|on\_button\_down + Changes the scroll method for the specified input device. + +*input* tap enabled|disabled + Enables or disables tap for specified input device. + +## SEAT CONFIGURATION + +Configure options for multiseat mode. sway-seat commands must be used inside a +_seat { }_ block in the config. + +A *seat* is a collection of input devices that act independently of each other. +Seats are identified by name and the default seat is _seat0_ if no seats are +configured. Each seat has an independent keyboard focus and a separate cursor that +is controlled by the pointer devices of the seat. This is useful for multiple +people using the desktop at the same time with their own devices (each sitting +in their own "seat"). + +*seat* attach + Attach an input device to this seat by its input identifier. A special + value of "\*" will attach all devices to the seat. + +*seat* fallback true|false + Set this seat as the fallback seat. A fallback seat will attach any device + not explicitly attached to another seat (similar to a "default" seat). + +# SEE ALSO + +*sway*(5) diff --git a/sway/sway-input.5.txt b/sway/sway-input.5.txt deleted file mode 100644 index c7305503..00000000 --- a/sway/sway-input.5.txt +++ /dev/null @@ -1,131 +0,0 @@ -///// -vim:set ft=asciidoc ts=4 sw=4 tw=82 noet: -///// -sway-input (5) -============== - -Name ----- -sway-input - input configuration file and commands - -Description ------------ - -Sway allows for configuration of devices within the sway configuration file. -sway-input commands must be used inside an _input { }_ block in the config. -To obtain a list of available device identifiers, run **swaymsg -t get_inputs**. - -Input Commands --------------- - -Keyboard Configuration -~~~~~~~~~~~~~~~~~~~~~~ - -For more information on these xkb configuration options, see -**xkeyboard-config**(7). - -**input** xkb_layout :: - Sets the layout of the keyboard like _us_ or _de_. - -**input** xkb_model :: - Sets the model of the keyboard. This has an influence for some extra keys your - keyboard might have. - -**input** xkb_options :: - Sets extra xkb configuration options for the keyboard. - -**input** xkb_rules :: - Sets files of rules to be used for keyboard mapping composition. - -**input** xkb_variant :: - Sets the variant of the keyboard like _dvorak_ or _colemak_. - -Mapping Configuration ---------------------- - -**input** map_to_output :: - Maps inputs from this device to the specified output. Only meaningful if the - device is a pointer, touch, or drawing tablet device. - -**input** map_to_region :: - Maps inputs from this device to the specified region of the global output - layout. Only meaningful if the device is a pointer, touch, or drawing tablet - device. - -**input** map_from_region :: - Ignores inputs from this device that do not occur within the specified - region. Can be in millimeters (e.g. 10x20mm 20x40mm) or in terms of 0..1 - (e.g. 0.5x0.5 0.7x0.7). Not all devices support millimeters. Only meaningful - if the device is not a keyboard an provides events in absolute terms (such - as a drawing tablet or touch screen - most pointers provide events relative - to the previous frame). - -Libinput Configuration -~~~~~~~~~~~~~~~~~~~~~~ - -**input** accel_profile :: - Sets the pointer acceleration profile for the specified input device. - -**input** click_method :: - Changes the click method for the specified device. - -**input** drag_lock :: - Enables or disables drag lock for specified input device. - -**input** dwt :: - Enables or disables disable-while-typing for the specified input device. - -**input** events :: - Enables or disables send_events for specified input device. - (Disabling send_events disables the input device) - -**input** left_handed :: - Enables or disables left handed mode for specified input device. - -**input** middle_emulation :: - Enables or disables middle click emulation. - -**input** natural_scroll :: - Enables or disables natural (inverted) scrolling for the specified input - device. - -**input** pointer_accel <[-1,1]>:: - Changes the pointer acceleration for the specified input device. - -**input** repeat_delay :: - Sets the amount of time a key must be held before it starts repeating. - -**input** repeat_rate :: - Sets the frequency of key repeats once the repeat_delay has passed. - -**input** scroll_method :: - Changes the scroll method for the specified input device. - -**input** tap :: - Enables or disables tap for specified input device. - -Seat Configuration ------------------- - -Configure options for multiseat mode. sway-seat commands must be used inside a -_seat { }_ block in the config. - -A _seat_ is a collection of input devices that act independently of each other. -Seats are identified by name and the default seat is _seat0_ if no seats are -configured. Each seat has an independent keyboard focus and a separate cursor that -is controlled by the pointer devices of the seat. This is useful for multiple -people using the desktop at the same time with their own devices (each sitting in -their own "seat"). - -**seat** attach :: - Attach an input device to this seat by its input identifier. A special value - of _*_ will attach all devices to the seat. - -**seat** fallback :: - Set this seat as the fallback seat. A fallback seat will attach any device not - explicitly attached to another seat (similar to a "default" seat). - -See Also --------- - -**sway**(5) -- cgit v1.2.3-54-g00ecf