diff options
author | Drew DeVault <sir@cmpwn.com> | 2019-01-27 11:27:34 -0500 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2019-01-27 11:27:48 -0500 |
commit | cd22d555e8a665c3f2a8e2c07e7d54beb6ac254c (patch) | |
tree | ff8b2fb310177fd1a4ff30ba09faf1c389ff0a38 /sway/sway-input.5.scd | |
parent | Merge pull request #3509 from ianyfan/log-errno (diff) | |
download | sway-cd22d555e8a665c3f2a8e2c07e7d54beb6ac254c.tar.gz sway-cd22d555e8a665c3f2a8e2c07e7d54beb6ac254c.tar.zst sway-cd22d555e8a665c3f2a8e2c07e7d54beb6ac254c.zip |
Remove unnecessary underscores in man pages
Diffstat (limited to 'sway/sway-input.5.scd')
-rw-r--r-- | sway/sway-input.5.scd | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/sway/sway-input.5.scd b/sway/sway-input.5.scd index 872fe8e2..4b14ef14 100644 --- a/sway/sway-input.5.scd +++ b/sway/sway-input.5.scd | |||
@@ -7,57 +7,57 @@ sway-input - input configuration file and commands | |||
7 | # DESCRIPTION | 7 | # DESCRIPTION |
8 | 8 | ||
9 | Sway allows for configuration of devices within the sway configuration file. | 9 | Sway allows for configuration of devices within the sway configuration file. |
10 | To obtain a list of available device identifiers, run *swaymsg -t get\_inputs*. | 10 | To obtain a list of available device identifiers, run *swaymsg -t get_inputs*. |
11 | 11 | ||
12 | # INPUT COMMANDS | 12 | # INPUT COMMANDS |
13 | 13 | ||
14 | ## KEYBOARD CONFIGURATION | 14 | ## KEYBOARD CONFIGURATION |
15 | 15 | ||
16 | *input* <identifier> repeat\_delay <n> | 16 | *input* <identifier> repeat_delay <n> |
17 | Sets the delay before repeating a held-down key, in milliseconds. | 17 | Sets the delay before repeating a held-down key, in milliseconds. |
18 | 18 | ||
19 | *input* <identifier> repeat\_rate <n> | 19 | *input* <identifier> repeat_rate <n> |
20 | Sets the key repeat rate in number of keypresses per second. | 20 | Sets the key repeat rate in number of keypresses per second. |
21 | 21 | ||
22 | For more information on these xkb configuration options, see | 22 | For more information on these xkb configuration options, see |
23 | *xkeyboard-config*(7). | 23 | *xkeyboard-config*(7). |
24 | 24 | ||
25 | *input* <identifier> xkb\_layout <layout\_name> | 25 | *input* <identifier> xkb_layout <layout_name> |
26 | Sets the layout of the keyboard like _us_ or _de_. | 26 | Sets the layout of the keyboard like _us_ or _de_. |
27 | 27 | ||
28 | *input* <identifier> xkb\_model <model\_name> | 28 | *input* <identifier> xkb_model <model_name> |
29 | Sets the model of the keyboard. This has an influence for some extra keys | 29 | Sets the model of the keyboard. This has an influence for some extra keys |
30 | your keyboard might have. | 30 | your keyboard might have. |
31 | 31 | ||
32 | *input* <identifier> xkb\_options <options> | 32 | *input* <identifier> xkb_options <options> |
33 | Sets extra xkb configuration options for the keyboard. | 33 | Sets extra xkb configuration options for the keyboard. |
34 | 34 | ||
35 | *input* <identifier> xkb\_rules <rules> | 35 | *input* <identifier> xkb_rules <rules> |
36 | Sets files of rules to be used for keyboard mapping composition. | 36 | Sets files of rules to be used for keyboard mapping composition. |
37 | 37 | ||
38 | *input* <identifier> xkb\_variant <variant> | 38 | *input* <identifier> xkb_variant <variant> |
39 | Sets the variant of the keyboard like _dvorak_ or _colemak_. | 39 | Sets the variant of the keyboard like _dvorak_ or _colemak_. |
40 | 40 | ||
41 | The following commands may only be used in the configuration file. | 41 | The following commands may only be used in the configuration file. |
42 | 42 | ||
43 | *input* <identifier> xkb\_capslock enabled|disabled | 43 | *input* <identifier> xkb_capslock enabled|disabled |
44 | Initially enables or disables CapsLock on startup, the default is disabled. | 44 | Initially enables or disables CapsLock on startup, the default is disabled. |
45 | 45 | ||
46 | *input* <identifier> xkb\_numlock enabled|disabled | 46 | *input* <identifier> xkb_numlock enabled|disabled |
47 | Initially enables or disables NumLock on startup, the default is disabled. | 47 | Initially enables or disables NumLock on startup, the default is disabled. |
48 | 48 | ||
49 | ## MAPPING CONFIGURATION | 49 | ## MAPPING CONFIGURATION |
50 | 50 | ||
51 | *input* <identifier> map\_to\_output <identifier> | 51 | *input* <identifier> map_to_output <identifier> |
52 | Maps inputs from this device to the specified output. Only meaningful if the | 52 | Maps inputs from this device to the specified output. Only meaningful if the |
53 | device is a pointer, touch, or drawing tablet device. | 53 | device is a pointer, touch, or drawing tablet device. |
54 | 54 | ||
55 | *input* <identifier> map\_to\_region <WxH@X,Y> | 55 | *input* <identifier> map_to_region <WxH@X,Y> |
56 | Maps inputs from this device to the specified region of the global output | 56 | Maps inputs from this device to the specified region of the global output |
57 | layout. Only meaningful if the device is a pointer, touch, or drawing tablet | 57 | layout. Only meaningful if the device is a pointer, touch, or drawing tablet |
58 | device. | 58 | device. |
59 | 59 | ||
60 | *input* <identifier> map\_from\_region <X1xY1> <X2xY2> | 60 | *input* <identifier> map_from_region <X1xY1> <X2xY2> |
61 | Ignores inputs from this device that do not occur within the specified | 61 | Ignores inputs from this device that do not occur within the specified |
62 | region. Can be in millimeters (e.g. 10x20mm 20x40mm) or in terms of 0..1 | 62 | region. Can be in millimeters (e.g. 10x20mm 20x40mm) or in terms of 0..1 |
63 | (e.g. 0.5x0.5 0.7x0.7). Not all devices support millimeters. Only meaningful | 63 | (e.g. 0.5x0.5 0.7x0.7). Not all devices support millimeters. Only meaningful |
@@ -67,68 +67,68 @@ The following commands may only be used in the configuration file. | |||
67 | 67 | ||
68 | ## LIBINPUT CONFIGURATION | 68 | ## LIBINPUT CONFIGURATION |
69 | 69 | ||
70 | *input* <identifier> accel\_profile adaptive|flat | 70 | *input* <identifier> accel_profile adaptive|flat |
71 | Sets the pointer acceleration profile for the specified input device. | 71 | Sets the pointer acceleration profile for the specified input device. |
72 | 72 | ||
73 | *input* <identifier> click\_method none|button\_areas|clickfinger | 73 | *input* <identifier> click_method none|button_areas|clickfinger |
74 | Changes the click method for the specified device. | 74 | Changes the click method for the specified device. |
75 | 75 | ||
76 | *input* <identifier> drag enabled|disabled | 76 | *input* <identifier> drag enabled|disabled |
77 | Enables or disables tap-and-drag for specified input device. | 77 | Enables or disables tap-and-drag for specified input device. |
78 | 78 | ||
79 | *input* <identifier> drag\_lock enabled|disabled | 79 | *input* <identifier> drag_lock enabled|disabled |
80 | Enables or disables drag lock for specified input device. | 80 | Enables or disables drag lock for specified input device. |
81 | 81 | ||
82 | *input* <identifier> dwt enabled|disabled | 82 | *input* <identifier> dwt enabled|disabled |
83 | Enables or disables disable-while-typing for the specified input device. | 83 | Enables or disables disable-while-typing for the specified input device. |
84 | 84 | ||
85 | *input* <identifier> events enabled|disabled|disabled\_on\_external\_mouse|toggle [<toggle-modes>] | 85 | *input* <identifier> events enabled|disabled|disabled_on_external_mouse|toggle [<toggle-modes>] |
86 | Enables or disables send\_events for specified input device. Disabling | 86 | Enables or disables send_events for specified input device. Disabling |
87 | send\_events disables the input device. | 87 | send_events disables the input device. |
88 | 88 | ||
89 | The _toggle_ option cannot be used in the config. If no toggle modes are | 89 | The _toggle_ option cannot be used in the config. If no toggle modes are |
90 | listed, all supported modes for the device will be toggled through in the | 90 | listed, all supported modes for the device will be toggled through in the |
91 | order: enabled, disabled\_on\_external\_mouse, disabled, (loop back). If | 91 | order: enabled, disabled_on_external_mouse, disabled, (loop back). If |
92 | toggle modes are listed, they will be cycled through, defaulting to the | 92 | toggle modes are listed, they will be cycled through, defaulting to the |
93 | first mode listed if the current mode is not in the list. They will also | 93 | first mode listed if the current mode is not in the list. They will also |
94 | not be checked to see if they are supported for the device and may fail. | 94 | not be checked to see if they are supported for the device and may fail. |
95 | 95 | ||
96 | *input* <identifier> left\_handed enabled|disabled | 96 | *input* <identifier> left_handed enabled|disabled |
97 | Enables or disables left handed mode for specified input device. | 97 | Enables or disables left handed mode for specified input device. |
98 | 98 | ||
99 | *input* <identifier> middle\_emulation enabled|disabled | 99 | *input* <identifier> middle_emulation enabled|disabled |
100 | Enables or disables middle click emulation. | 100 | Enables or disables middle click emulation. |
101 | 101 | ||
102 | *input* <identifier> natural\_scroll enabled|disabled | 102 | *input* <identifier> natural_scroll enabled|disabled |
103 | Enables or disables natural (inverted) scrolling for the specified input | 103 | Enables or disables natural (inverted) scrolling for the specified input |
104 | device. | 104 | device. |
105 | 105 | ||
106 | *input* <identifier> pointer\_accel [<-1|1>] | 106 | *input* <identifier> pointer_accel [<-1|1>] |
107 | Changes the pointer acceleration for the specified input device. | 107 | Changes the pointer acceleration for the specified input device. |
108 | 108 | ||
109 | *input* <identifier> repeat\_delay <milliseconds> | 109 | *input* <identifier> repeat_delay <milliseconds> |
110 | Sets the amount of time a key must be held before it starts repeating. | 110 | Sets the amount of time a key must be held before it starts repeating. |
111 | 111 | ||
112 | *input* <identifier> repeat\_rate <characters per second> | 112 | *input* <identifier> repeat_rate <characters per second> |
113 | Sets the frequency of key repeats once the repeat\_delay has passed. | 113 | Sets the frequency of key repeats once the repeat_delay has passed. |
114 | 114 | ||
115 | *input* <identifier> scroll\_button disable|button[1-3,8,9]|<event-code-or-name> | 115 | *input* <identifier> scroll_button disable|button[1-3,8,9]|<event-code-or-name> |
116 | Sets the button used for scroll\_method on\_button\_down. The button can | 116 | Sets the button used for scroll_method on_button_down. The button can |
117 | be given as an event name or code, which can be obtained from `libinput | 117 | be given as an event name or code, which can be obtained from `libinput |
118 | debug-events`, or as a x11 mouse button (button[1-3,8,9]). If set to | 118 | debug-events`, or as a x11 mouse button (button[1-3,8,9]). If set to |
119 | _disable_, it disables the scroll\_method on\_button\_down. | 119 | _disable_, it disables the scroll_method on_button_down. |
120 | 120 | ||
121 | *input* <identifier> scroll\_factor <floating point value> | 121 | *input* <identifier> scroll_factor <floating point value> |
122 | Changes the scroll factor for the specified input device. Scroll speed will | 122 | Changes the scroll factor for the specified input device. Scroll speed will |
123 | be scaled by the given value, which must be non-negative. | 123 | be scaled by the given value, which must be non-negative. |
124 | 124 | ||
125 | *input* <identifier> scroll\_method none|two\_finger|edge|on\_button\_down | 125 | *input* <identifier> scroll_method none|two_finger|edge|on_button_down |
126 | Changes the scroll method for the specified input device. | 126 | Changes the scroll method for the specified input device. |
127 | 127 | ||
128 | *input* <identifier> tap enabled|disabled | 128 | *input* <identifier> tap enabled|disabled |
129 | Enables or disables tap for specified input device. | 129 | Enables or disables tap for specified input device. |
130 | 130 | ||
131 | *input* <identifier> tap\_button\_map lrm|lmr | 131 | *input* <identifier> tap_button_map lrm|lmr |
132 | Specifies which button mapping to use for tapping. _lrm_ treats 1 finger as | 132 | Specifies which button mapping to use for tapping. _lrm_ treats 1 finger as |
133 | left click, 2 fingers as right click, and 3 fingers as middle click. _lmr_ | 133 | left click, 2 fingers as right click, and 3 fingers as middle click. _lmr_ |
134 | treats 1 finger as left click, 2 fingers as middle click, and 3 fingers as | 134 | treats 1 finger as left click, 2 fingers as middle click, and 3 fingers as |
@@ -145,7 +145,7 @@ is controlled by the pointer devices of the seat. This is useful for multiple | |||
145 | people using the desktop at the same time with their own devices (each sitting | 145 | people using the desktop at the same time with their own devices (each sitting |
146 | in their own "seat"). | 146 | in their own "seat"). |
147 | 147 | ||
148 | *seat* <name> attach <input\_identifier> | 148 | *seat* <name> attach <input_identifier> |
149 | Attach an input device to this seat by its input identifier. A special | 149 | Attach an input device to this seat by its input identifier. A special |
150 | value of "\*" will attach all devices to the seat. | 150 | value of "\*" will attach all devices to the seat. |
151 | 151 | ||
@@ -166,7 +166,7 @@ in their own "seat"). | |||
166 | Set this seat as the fallback seat. A fallback seat will attach any device | 166 | Set this seat as the fallback seat. A fallback seat will attach any device |
167 | not explicitly attached to another seat (similar to a "default" seat). | 167 | not explicitly attached to another seat (similar to a "default" seat). |
168 | 168 | ||
169 | *seat* <name> hide\_cursor <timeout> | 169 | *seat* <name> hide_cursor <timeout> |
170 | Hides the cursor image after the specified _timeout_ (in milliseconds) | 170 | Hides the cursor image after the specified _timeout_ (in milliseconds) |
171 | has elapsed with no activity on that cursor. A timeout of 0 (default) | 171 | has elapsed with no activity on that cursor. A timeout of 0 (default) |
172 | disables hiding the cursor. The minimal timeout is 100 and any value less | 172 | disables hiding the cursor. The minimal timeout is 100 and any value less |