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