diff options
author | Drew DeVault <sir@cmpwn.com> | 2018-05-11 21:25:05 -0400 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2018-05-11 21:25:05 -0400 |
commit | d9a08b7a9df64ba434252d6adfa08aabb4c5c31e (patch) | |
tree | 1b3023438438076d9c3ae813b25e0394df75a4a9 /sway/sway-input.5.scd | |
parent | Add sway-bar(5) (diff) | |
download | sway-d9a08b7a9df64ba434252d6adfa08aabb4c5c31e.tar.gz sway-d9a08b7a9df64ba434252d6adfa08aabb4c5c31e.tar.zst sway-d9a08b7a9df64ba434252d6adfa08aabb4c5c31e.zip |
Add sway-input(5)
Diffstat (limited to 'sway/sway-input.5.scd')
-rw-r--r-- | sway/sway-input.5.scd | 120 |
1 files changed, 120 insertions, 0 deletions
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 @@ | |||
1 | sway-input(5) | ||
2 | |||
3 | # NAME | ||
4 | |||
5 | sway-input - input configuration file and commands | ||
6 | |||
7 | # DESCRIPTION | ||
8 | |||
9 | Sway allows for configuration of devices within the sway configuration file. | ||
10 | sway-input commands must be used inside an _input { }_ block in the config. | ||
11 | To obtain a list of available device identifiers, run *swaymsg -t get\_inputs*. | ||
12 | |||
13 | # INPUT COMMANDS | ||
14 | |||
15 | ## KEYBOARD CONFIGURATION | ||
16 | |||
17 | For more information on these xkb configuration options, see | ||
18 | *xkeyboard-config*(7). | ||
19 | |||
20 | *input* <identifier> xkb\_layout <layout\_name> | ||
21 | Sets the layout of the keyboard like _us_ or _de_. | ||
22 | |||
23 | *input* <identifier> xkb\_model <model\_name> | ||
24 | Sets the model of the keyboard. This has an influence for some extra keys | ||
25 | your keyboard might have. | ||
26 | |||
27 | *input* <identifier> xkb\_options <options> | ||
28 | Sets extra xkb configuration options for the keyboard. | ||
29 | |||
30 | *input* <identifier> xkb\_rules <rules> | ||
31 | Sets files of rules to be used for keyboard mapping composition. | ||
32 | |||
33 | *input* <identifier> xkb\_variant <variant> | ||
34 | Sets the variant of the keyboard like _dvorak_ or _colemak_. | ||
35 | |||
36 | ## MAPPING CONFIGURATION | ||
37 | |||
38 | *input* <identifier> map\_to\_output <identifier> | ||
39 | Maps inputs from this device to the specified output. Only meaningful if the | ||
40 | device is a pointer, touch, or drawing tablet device. | ||
41 | |||
42 | *input* <identifier> map\_to\_region <WxH@X,Y> | ||
43 | Maps inputs from this device to the specified region of the global output | ||
44 | layout. Only meaningful if the device is a pointer, touch, or drawing tablet | ||
45 | device. | ||
46 | |||
47 | *input* <identifier> map\_from\_region <X1xY1> <X2xY2> | ||
48 | Ignores inputs from this device that do not occur within the specified | ||
49 | region. Can be in millimeters (e.g. 10x20mm 20x40mm) or in terms of 0..1 | ||
50 | (e.g. 0.5x0.5 0.7x0.7). Not all devices support millimeters. Only meaningful | ||
51 | if the device is not a keyboard an provides events in absolute terms (such | ||
52 | as a drawing tablet or touch screen - most pointers provide events relative | ||
53 | to the previous frame). | ||
54 | |||
55 | ## LIBINPUT CONFIGURATION | ||
56 | |||
57 | *input* <identifier> accel\_profile adaptive|flat | ||
58 | Sets the pointer acceleration profile for the specified input device. | ||
59 | |||
60 | *input* <identifier> click\_method none|button\_areas|clickfinger | ||
61 | Changes the click method for the specified device. | ||
62 | |||
63 | *input* <identifier> drag\_lock enabled|disabled | ||
64 | Enables or disables drag lock for specified input device. | ||
65 | |||
66 | *input* <identifier> dwt enabled|disabled | ||
67 | Enables or disables disable-while-typing for the specified input device. | ||
68 | |||
69 | *input* <identifier> events enabled|disabled|disabled\_on\_external\_mouse | ||
70 | Enables or disables send_events for specified input device. (Disabling | ||
71 | send_events disables the input device) | ||
72 | |||
73 | *input* <identifier> left\_handed enabled|disabled | ||
74 | Enables or disables left handed mode for specified input device. | ||
75 | |||
76 | *input* <identifier> middle\_emulation enabled|disabled | ||
77 | Enables or disables middle click emulation. | ||
78 | |||
79 | *input* <identifier> natural\_scroll enabled|disabled | ||
80 | Enables or disables natural (inverted) scrolling for the specified input | ||
81 | device. | ||
82 | |||
83 | *input* <identifier> pointer\_accel [<-1|1>] | ||
84 | Changes the pointer acceleration for the specified input device. | ||
85 | |||
86 | *input* <identifier> repeat\_delay <milliseconds> | ||
87 | Sets the amount of time a key must be held before it starts repeating. | ||
88 | |||
89 | *input* <identifier> repeat\_rate <characters per second> | ||
90 | Sets the frequency of key repeats once the repeat\_delay has passed. | ||
91 | |||
92 | *input* <identifier> scroll\_method none|two\_finger|edge|on\_button\_down | ||
93 | Changes the scroll method for the specified input device. | ||
94 | |||
95 | *input* <identifier> tap enabled|disabled | ||
96 | Enables or disables tap for specified input device. | ||
97 | |||
98 | ## SEAT CONFIGURATION | ||
99 | |||
100 | Configure options for multiseat mode. sway-seat commands must be used inside a | ||
101 | _seat { }_ block in the config. | ||
102 | |||
103 | A *seat* is a collection of input devices that act independently of each other. | ||
104 | Seats are identified by name and the default seat is _seat0_ if no seats are | ||
105 | configured. Each seat has an independent keyboard focus and a separate cursor that | ||
106 | is controlled by the pointer devices of the seat. This is useful for multiple | ||
107 | people using the desktop at the same time with their own devices (each sitting | ||
108 | in their own "seat"). | ||
109 | |||
110 | *seat* <name> attach <input\_identifier> | ||
111 | Attach an input device to this seat by its input identifier. A special | ||
112 | value of "\*" will attach all devices to the seat. | ||
113 | |||
114 | *seat* <name> fallback true|false | ||
115 | Set this seat as the fallback seat. A fallback seat will attach any device | ||
116 | not explicitly attached to another seat (similar to a "default" seat). | ||
117 | |||
118 | # SEE ALSO | ||
119 | |||
120 | *sway*(5) | ||