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 | |
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
-rw-r--r-- | sway/sway-bar.5.scd | 56 | ||||
-rw-r--r-- | sway/sway-input.5.scd | 70 | ||||
-rw-r--r-- | sway/sway-output.5.scd | 12 | ||||
-rw-r--r-- | sway/sway.1.scd | 6 | ||||
-rw-r--r-- | sway/sway.5.scd | 162 |
5 files changed, 153 insertions, 153 deletions
diff --git a/sway/sway-bar.5.scd b/sway/sway-bar.5.scd index 9a6397e3..5c8b9417 100644 --- a/sway/sway-bar.5.scd +++ b/sway/sway-bar.5.scd | |||
@@ -10,7 +10,7 @@ Sway allows configuring swaybar in the sway configuration file. | |||
10 | 10 | ||
11 | # COMMANDS | 11 | # COMMANDS |
12 | 12 | ||
13 | *status\_command* <status command> | 13 | *status_command* <status command> |
14 | Executes the bar _status command_ with _sh -c_. Each line of text printed | 14 | Executes the bar _status command_ with _sh -c_. Each line of text printed |
15 | to stdout from this command will be displayed in the status area of the | 15 | to stdout from this command will be displayed in the status area of the |
16 | bar. You may also use the i3bar JSON protocol: | 16 | bar. You may also use the i3bar JSON protocol: |
@@ -18,13 +18,13 @@ Sway allows configuring swaybar in the sway configuration file. | |||
18 | https://i3wm.org/docs/i3bar-protocol.html | 18 | https://i3wm.org/docs/i3bar-protocol.html |
19 | 19 | ||
20 | If running this command via IPC, you can disable a running status command by | 20 | If running this command via IPC, you can disable a running status command by |
21 | setting the command to a single dash: _swaybar bar bar-0 status\_command -_ | 21 | setting the command to a single dash: _swaybar bar bar-0 status_command -_ |
22 | 22 | ||
23 | *pango\_markup* enabled|disabled | 23 | *pango_markup* enabled|disabled |
24 | Enables or disables pango markup for status lines. This has no effect on | 24 | Enables or disables pango markup for status lines. This has no effect on |
25 | status lines using the i3bar JSON protocol. | 25 | status lines using the i3bar JSON protocol. |
26 | 26 | ||
27 | *id* <bar\_id> | 27 | *id* <bar_id> |
28 | Sets the ID of the bar. | 28 | Sets the ID of the bar. |
29 | 29 | ||
30 | *position* top|bottom | 30 | *position* top|bottom |
@@ -34,31 +34,31 @@ Sway allows configuring swaybar in the sway configuration file. | |||
34 | Restrict the bar to a certain output, can be specified multiple times. If | 34 | Restrict the bar to a certain output, can be specified multiple times. If |
35 | the output command is omitted, the bar will be displayed on all outputs. | 35 | the output command is omitted, the bar will be displayed on all outputs. |
36 | 36 | ||
37 | *swaybar\_command* <command> | 37 | *swaybar_command* <command> |
38 | Executes custom bar command. Default is _swaybar_. | 38 | Executes custom bar command. Default is _swaybar_. |
39 | 39 | ||
40 | *font* <font> | 40 | *font* <font> |
41 | Specifies the font to be used in the bar. | 41 | Specifies the font to be used in the bar. |
42 | 42 | ||
43 | *separator\_symbol* <symbol> | 43 | *separator_symbol* <symbol> |
44 | Specifies the separator symbol to separate blocks on the bar. | 44 | Specifies the separator symbol to separate blocks on the bar. |
45 | 45 | ||
46 | *wrap\_scroll* yes|no | 46 | *wrap_scroll* yes|no |
47 | Enables or disables wrapping when scrolling through workspaces with the | 47 | Enables or disables wrapping when scrolling through workspaces with the |
48 | scroll wheel. Default is _no_. | 48 | scroll wheel. Default is _no_. |
49 | 49 | ||
50 | *workspace\_buttons* yes|no | 50 | *workspace_buttons* yes|no |
51 | Enables or disables workspace buttons on the bar. Default is _yes_. | 51 | Enables or disables workspace buttons on the bar. Default is _yes_. |
52 | 52 | ||
53 | *strip\_workspace\_name* yes|no | 53 | *strip_workspace_name* yes|no |
54 | If set to _yes_, then workspace names will be omitted from the workspace | 54 | If set to _yes_, then workspace names will be omitted from the workspace |
55 | button and only the custom number will be shown. Default is _no_. | 55 | button and only the custom number will be shown. Default is _no_. |
56 | 56 | ||
57 | *strip\_workspace\_numbers* yes|no | 57 | *strip_workspace_numbers* yes|no |
58 | If set to _yes_, then workspace numbers will be omitted from the workspace | 58 | If set to _yes_, then workspace numbers will be omitted from the workspace |
59 | button and only the custom name will be shown. Default is _no_. | 59 | button and only the custom name will be shown. Default is _no_. |
60 | 60 | ||
61 | *binding\_mode\_indicator* yes|no | 61 | *binding_mode_indicator* yes|no |
62 | Enable or disable binding mode indicator. Default is _yes_. | 62 | Enable or disable binding mode indicator. Default is _yes_. |
63 | 63 | ||
64 | *gaps* <all> | <horizontal> <vertical> | <top> <right> <bottom> <left> | 64 | *gaps* <all> | <horizontal> <vertical> | <top> <right> <bottom> <left> |
@@ -90,7 +90,7 @@ Sway allows configuring swaybar in the sway configuration file. | |||
90 | modifier key is pressed, though this behaviour depends on the hidden state. | 90 | modifier key is pressed, though this behaviour depends on the hidden state. |
91 | In _invisible_ mode, it is permanently hidden. Default is _dock_. | 91 | In _invisible_ mode, it is permanently hidden. Default is _dock_. |
92 | 92 | ||
93 | *hidden\_state* hide|show | 93 | *hidden_state* hide|show |
94 | Specifies the behaviour of the bar when it is in _hide_ mode. When the | 94 | Specifies the behaviour of the bar when it is in _hide_ mode. When the |
95 | hidden state is _hide_, then it is normally hidden, and only unhidden by | 95 | hidden state is _hide_, then it is normally hidden, and only unhidden by |
96 | pressing the modifier key or in case of urgency hints. When the hidden | 96 | pressing the modifier key or in case of urgency hints. When the hidden |
@@ -100,12 +100,12 @@ Sway allows configuring swaybar in the sway configuration file. | |||
100 | *modifier* <Modifier>|none | 100 | *modifier* <Modifier>|none |
101 | Specifies the modifier key that shows a hidden bar. Default is _Mod4_. | 101 | Specifies the modifier key that shows a hidden bar. Default is _Mod4_. |
102 | 102 | ||
103 | *status\_padding* <padding> | 103 | *status_padding* <padding> |
104 | Sets the vertical padding that is used for the status line. The default is | 104 | Sets the vertical padding that is used for the status line. The default is |
105 | _1_. If _padding_ is _0_, blocks will be able to take up the full height of | 105 | _1_. If _padding_ is _0_, blocks will be able to take up the full height of |
106 | the bar. This value will be multiplied by the output scale. | 106 | the bar. This value will be multiplied by the output scale. |
107 | 107 | ||
108 | *status\_edge\_padding* <padding> | 108 | *status_edge_padding* <padding> |
109 | Sets the padding that is used when the status line is at the right edge of | 109 | Sets the padding that is used when the status line is at the right edge of |
110 | the bar. This value will be multiplied by the output scale. The default is | 110 | the bar. This value will be multiplied by the output scale. The default is |
111 | _3_. | 111 | _3_. |
@@ -115,13 +115,13 @@ Sway allows configuring swaybar in the sway configuration file. | |||
115 | Swaybar provides a system tray where third-party applications may place icons. | 115 | Swaybar provides a system tray where third-party applications may place icons. |
116 | The following commands configure the tray. | 116 | The following commands configure the tray. |
117 | 117 | ||
118 | *tray\_bindcode* <event-code> | 118 | *tray_bindcode* <event-code> |
119 | ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollUp|nop | 119 | ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollUp|nop |
120 | Executes the action when the mouse button has been pressed. The buttons can | 120 | Executes the action when the mouse button has been pressed. The buttons can |
121 | be given as an event code, which can be obtained from `libinput debug-events`. | 121 | be given as an event code, which can be obtained from `libinput debug-events`. |
122 | To disable the default behavior for a button, use the command _nop_. | 122 | To disable the default behavior for a button, use the command _nop_. |
123 | 123 | ||
124 | *tray\_bindsym* button[1-9]|<event-name> | 124 | *tray_bindsym* button[1-9]|<event-name> |
125 | ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollUp|nop | 125 | ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollUp|nop |
126 | Executes the action when the mouse button has been pressed. The buttons can | 126 | Executes the action when the mouse button has been pressed. The buttons can |
127 | be given as a x11 button number or an event name, which can be obtained | 127 | be given as a x11 button number or an event name, which can be obtained |
@@ -129,16 +129,16 @@ ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollU | |||
129 | action (Activate for button1, ContextMenu for button2 and SecondaryActivate | 129 | action (Activate for button1, ContextMenu for button2 and SecondaryActivate |
130 | for button3). | 130 | for button3). |
131 | 131 | ||
132 | *tray\_padding* <px> [px] | 132 | *tray_padding* <px> [px] |
133 | Sets the pixel padding of the system tray. This padding will surround the | 133 | Sets the pixel padding of the system tray. This padding will surround the |
134 | tray on all sides and between each item. The default value for _px_ is 2. | 134 | tray on all sides and between each item. The default value for _px_ is 2. |
135 | 135 | ||
136 | *tray\_output* none|<output> | 136 | *tray_output* none|<output> |
137 | Restrict the tray to a certain output, can be specified multiple times. If | 137 | Restrict the tray to a certain output, can be specified multiple times. If |
138 | omitted, the tray will be displayed on all outputs. Unlike i3bar, swaybar | 138 | omitted, the tray will be displayed on all outputs. Unlike i3bar, swaybar |
139 | can show icons on any number of bars and outputs without races. | 139 | can show icons on any number of bars and outputs without races. |
140 | 140 | ||
141 | *icon\_theme* <name> | 141 | *icon_theme* <name> |
142 | Sets the icon theme that sway will look for item icons in. This option has | 142 | Sets the icon theme that sway will look for item icons in. This option has |
143 | no default value, because sway will always default to the fallback theme, | 143 | no default value, because sway will always default to the fallback theme, |
144 | hicolor. | 144 | hicolor. |
@@ -157,40 +157,40 @@ must be defined in hex: _#RRGGBB_ or _#RRGGBBAA_. | |||
157 | *separator* <color> | 157 | *separator* <color> |
158 | Text color to be used for the separator. | 158 | Text color to be used for the separator. |
159 | 159 | ||
160 | *focused\_background* <color> | 160 | *focused_background* <color> |
161 | Background color of the bar on the currently focused monitor output. If not | 161 | Background color of the bar on the currently focused monitor output. If not |
162 | used, the color will be taken from _background_. | 162 | used, the color will be taken from _background_. |
163 | 163 | ||
164 | *focused\_statusline* <color> | 164 | *focused_statusline* <color> |
165 | Text color to be used for the statusline on the currently focused monitor | 165 | Text color to be used for the statusline on the currently focused monitor |
166 | output. If not used, the color will be taken from _statusline_. | 166 | output. If not used, the color will be taken from _statusline_. |
167 | 167 | ||
168 | *focused\_separator* <color> | 168 | *focused_separator* <color> |
169 | Text color to be used for the separator on the currently focused monitor | 169 | Text color to be used for the separator on the currently focused monitor |
170 | output. If not used, the color will be taken from _separator_. | 170 | output. If not used, the color will be taken from _separator_. |
171 | 171 | ||
172 | *focused\_workspace* <border> <background> <text> | 172 | *focused_workspace* <border> <background> <text> |
173 | Border, background and text color for a workspace button when the workspace | 173 | Border, background and text color for a workspace button when the workspace |
174 | has focus. | 174 | has focus. |
175 | 175 | ||
176 | *active\_workspace* <border> <background> <text> | 176 | *active_workspace* <border> <background> <text> |
177 | Border, background and text color for a workspace button when the workspace | 177 | Border, background and text color for a workspace button when the workspace |
178 | is active (visible) on some output, but the focus is on another one. You | 178 | is active (visible) on some output, but the focus is on another one. You |
179 | can only tell this apart from the focused workspace when you are using | 179 | can only tell this apart from the focused workspace when you are using |
180 | multiple monitors. | 180 | multiple monitors. |
181 | 181 | ||
182 | *inactive\_workspace* <border> <background> <text> | 182 | *inactive_workspace* <border> <background> <text> |
183 | Border, background and text color for a workspace button when the workspace | 183 | Border, background and text color for a workspace button when the workspace |
184 | does not have focus and is not active (visible) on any output. This will be | 184 | does not have focus and is not active (visible) on any output. This will be |
185 | the case for most workspaces. | 185 | the case for most workspaces. |
186 | 186 | ||
187 | *urgent\_workspace* <border> <background> <text> | 187 | *urgent_workspace* <border> <background> <text> |
188 | Border, background and text color for a workspace button when the workspace | 188 | Border, background and text color for a workspace button when the workspace |
189 | contains a window with the urgency hint set. | 189 | contains a window with the urgency hint set. |
190 | 190 | ||
191 | *binding\_mode* <border> <background> <text> | 191 | *binding_mode* <border> <background> <text> |
192 | Border, background and text color for the binding mode indicator. If not used, | 192 | Border, background and text color for the binding mode indicator. If not used, |
193 | the colors will be taken from _urgent\_workspace_. | 193 | the colors will be taken from _urgent_workspace_. |
194 | 194 | ||
195 | # SEE ALSO | 195 | # SEE ALSO |
196 | 196 | ||
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 |
diff --git a/sway/sway-output.5.scd b/sway/sway-output.5.scd index 28524478..876f4de1 100644 --- a/sway/sway-output.5.scd +++ b/sway/sway-output.5.scd | |||
@@ -10,12 +10,12 @@ You may combine output commands into one, like so: | |||
10 | 10 | ||
11 | output HDMI-A-1 mode 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch | 11 | output HDMI-A-1 mode 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch |
12 | 12 | ||
13 | You can get a list of output names with *swaymsg -t get\_outputs*. You may also | 13 | You can get a list of output names with *swaymsg -t get_outputs*. You may also |
14 | match any output by using the output name "\*". | 14 | match any output by using the output name "\*". |
15 | 15 | ||
16 | Some outputs may have different names when disconnecting and reconnecting. To | 16 | Some outputs may have different names when disconnecting and reconnecting. To |
17 | identify these, the name can be substituted for a string consisting of the make, | 17 | identify these, the name can be substituted for a string consisting of the make, |
18 | model and serial which you can get from *swaymsg -t get\_outputs*. Each value | 18 | model and serial which you can get from *swaymsg -t get_outputs*. Each value |
19 | must be separated by one space. For example: | 19 | must be separated by one space. For example: |
20 | 20 | ||
21 | output "Some Company ABC123 0x00000000" pos 1920,0 | 21 | output "Some Company ABC123 0x00000000" pos 1920,0 |
@@ -26,7 +26,7 @@ must be separated by one space. For example: | |||
26 | Configures the specified output to use the given mode. Modes are a | 26 | Configures the specified output to use the given mode. Modes are a |
27 | combination of width and height (in pixels) and a refresh rate that your | 27 | combination of width and height (in pixels) and a refresh rate that your |
28 | display can be configured to use. For a list of available modes for each | 28 | display can be configured to use. For a list of available modes for each |
29 | output, use *swaymsg -t get\_outputs*. | 29 | output, use *swaymsg -t get_outputs*. |
30 | 30 | ||
31 | Examples: | 31 | Examples: |
32 | 32 | ||
@@ -63,15 +63,15 @@ must be separated by one space. For example: | |||
63 | applications to taste. HiDPI isn't supported with Xwayland clients (windows | 63 | applications to taste. HiDPI isn't supported with Xwayland clients (windows |
64 | will blur). | 64 | will blur). |
65 | 65 | ||
66 | *output* <name> background|bg <file> <mode> [<fallback\_color>] | 66 | *output* <name> background|bg <file> <mode> [<fallback_color>] |
67 | Sets the wallpaper for the given output to the specified file, using the | 67 | Sets the wallpaper for the given output to the specified file, using the |
68 | given scaling mode (one of "stretch", "fill", "fit", "center", "tile"). If | 68 | given scaling mode (one of "stretch", "fill", "fit", "center", "tile"). If |
69 | the specified file cannot be accessed or if the image does fill the entire | 69 | the specified file cannot be accessed or if the image does fill the entire |
70 | output, a fallback color may be provided to cover the rest of the output. | 70 | output, a fallback color may be provided to cover the rest of the output. |
71 | __fallback\_color__ should be specified as _#RRGGBB_. Alpha is not | 71 | __fallback_color__ should be specified as _#RRGGBB_. Alpha is not |
72 | supported. | 72 | supported. |
73 | 73 | ||
74 | *output* <name> background|bg <color> solid\_color | 74 | *output* <name> background|bg <color> solid_color |
75 | Sets the background of the given output to the specified color. _color_ | 75 | Sets the background of the given output to the specified color. _color_ |
76 | should be specified as _#RRGGBB_. Alpha is not supported. | 76 | should be specified as _#RRGGBB_. Alpha is not supported. |
77 | 77 | ||
diff --git a/sway/sway.1.scd b/sway/sway.1.scd index 09c8ccfd..bce63527 100644 --- a/sway/sway.1.scd +++ b/sway/sway.1.scd | |||
@@ -47,13 +47,13 @@ You can run sway directly from a tty, or via a Wayland-compatible login manager. | |||
47 | sway searches for a config file in the following locations, in this order: | 47 | sway searches for a config file in the following locations, in this order: |
48 | 48 | ||
49 | . ~/.sway/config | 49 | . ~/.sway/config |
50 | . $XDG\_CONFIG\_HOME/sway/config (suggested location) | 50 | . $XDG_CONFIG_HOME/sway/config (suggested location) |
51 | . ~/.i3/config | 51 | . ~/.i3/config |
52 | . $XDG\_CONFIG\_HOME/i3/config | 52 | . $XDG_CONFIG_HOME/i3/config |
53 | . /etc/sway/config | 53 | . /etc/sway/config |
54 | . /etc/i3/config | 54 | . /etc/i3/config |
55 | 55 | ||
56 | If unset, $XDG\_CONFIG\_HOME defaults to *~/.config*. | 56 | If unset, $XDG_CONFIG_HOME defaults to *~/.config*. |
57 | 57 | ||
58 | An error is raised when no config file is found. The recommended default | 58 | An error is raised when no config file is found. The recommended default |
59 | configuration is usually installed to */etc/sway/config*; you are encouraged to | 59 | configuration is usually installed to */etc/sway/config*; you are encouraged to |
diff --git a/sway/sway.5.scd b/sway/sway.5.scd index 06bc0dbf..0ac6f185 100644 --- a/sway/sway.5.scd +++ b/sway/sway.5.scd | |||
@@ -58,7 +58,7 @@ The following commands may only be used in the configuration file. | |||
58 | *bar* [<bar-id>] <bar-subcommands...> | 58 | *bar* [<bar-id>] <bar-subcommands...> |
59 | For details on bar subcommands, see *sway-bar*(5). | 59 | For details on bar subcommands, see *sway-bar*(5). |
60 | 60 | ||
61 | *default\_orientation* horizontal|vertical|auto | 61 | *default_orientation* horizontal|vertical|auto |
62 | Sets the default container layout for tiled containers. | 62 | Sets the default container layout for tiled containers. |
63 | 63 | ||
64 | *include* <path> | 64 | *include* <path> |
@@ -67,14 +67,14 @@ The following commands may only be used in the configuration file. | |||
67 | *wordexp*(3) for details). The same include file can only be included once; | 67 | *wordexp*(3) for details). The same include file can only be included once; |
68 | subsequent attempts will be ignored. | 68 | subsequent attempts will be ignored. |
69 | 69 | ||
70 | *swaybg\_command* <command> | 70 | *swaybg_command* <command> |
71 | Executes custom background _command_. Default is _swaybg_. Refer to | 71 | Executes custom background _command_. Default is _swaybg_. Refer to |
72 | *sway-output*(5) for more information. | 72 | *sway-output*(5) for more information. |
73 | 73 | ||
74 | It can be disabled by setting the command to a single dash: | 74 | It can be disabled by setting the command to a single dash: |
75 | _swaybg\_command -_ | 75 | _swaybg_command -_ |
76 | 76 | ||
77 | *swaynag\_command* <command> | 77 | *swaynag_command* <command> |
78 | Executes custom command for _swaynag_. Default is _swaynag_. Additional | 78 | Executes custom command for _swaynag_. Default is _swaynag_. Additional |
79 | arguments may be appended to the end. This should only be used to either | 79 | arguments may be appended to the end. This should only be used to either |
80 | direct sway to call swaynag from a custom path or to provide additional | 80 | direct sway to call swaynag from a custom path or to provide additional |
@@ -82,7 +82,7 @@ The following commands may only be used in the configuration file. | |||
82 | results. | 82 | results. |
83 | 83 | ||
84 | It can be disabled by setting the command to a single dash: | 84 | It can be disabled by setting the command to a single dash: |
85 | _swaynag\_command -_ | 85 | _swaynag_command -_ |
86 | 86 | ||
87 | *xwayland* enable|disable | 87 | *xwayland* enable|disable |
88 | Enables or disables Xwayland support, which allows X11 applications to be | 88 | Enables or disables Xwayland support, which allows X11 applications to be |
@@ -131,7 +131,7 @@ They are expected to be used with *bindsym* or at runtime through *swaymsg*(1). | |||
131 | *focus floating* | 131 | *focus floating* |
132 | Sets focus to the last focused floating container. | 132 | Sets focus to the last focused floating container. |
133 | 133 | ||
134 | *focus* mode\_toggle | 134 | *focus* mode_toggle |
135 | Moves focus between the floating and tiled layers. | 135 | Moves focus between the floating and tiled layers. |
136 | 136 | ||
137 | *fullscreen* [enable|disable|toggle] | 137 | *fullscreen* [enable|disable|toggle] |
@@ -163,7 +163,7 @@ set|plus|minus <amount> | |||
163 | If unspecified, the default is 10 pixels. Pixels are ignored when moving | 163 | If unspecified, the default is 10 pixels. Pixels are ignored when moving |
164 | tiled containers. | 164 | tiled containers. |
165 | 165 | ||
166 | *move* [absolute] position <pos\_x> [px] <pos\_y> [px] | 166 | *move* [absolute] position <pos_x> [px] <pos_y> [px] |
167 | Moves the focused container to the specified position in the workspace. If | 167 | Moves the focused container to the specified position in the workspace. If |
168 | _absolute_ is used, the position is relative to all outputs. | 168 | _absolute_ is used, the position is relative to all outputs. |
169 | 169 | ||
@@ -186,11 +186,11 @@ set|plus|minus <amount> | |||
186 | Moves the focused container to the previous, next or current workspace on | 186 | Moves the focused container to the previous, next or current workspace on |
187 | this output, or if no workspaces remain, the previous or next output. | 187 | this output, or if no workspaces remain, the previous or next output. |
188 | 188 | ||
189 | *move* container|window [to] workspace prev\_on\_output|next\_on\_output | 189 | *move* container|window [to] workspace prev_on_output|next_on_output |
190 | Moves the focused container to the previous or next workspace on this | 190 | Moves the focused container to the previous or next workspace on this |
191 | output, wrapping around if already at the first or last workspace. | 191 | output, wrapping around if already at the first or last workspace. |
192 | 192 | ||
193 | *move* container|window [to] workspace back\_and\_forth | 193 | *move* container|window [to] workspace back_and_forth |
194 | Moves the focused container to previously focused workspace. | 194 | Moves the focused container to previously focused workspace. |
195 | 195 | ||
196 | *move* container|window|workspace [to] output <name> | 196 | *move* container|window|workspace [to] output <name> |
@@ -255,10 +255,10 @@ set|plus|minus <amount> | |||
255 | "Sticks" a floating window to the current output so that it shows up on all | 255 | "Sticks" a floating window to the current output so that it shows up on all |
256 | workspaces. | 256 | workspaces. |
257 | 257 | ||
258 | *swap* container with id|con\_id|mark <arg> | 258 | *swap* container with id|con_id|mark <arg> |
259 | Swaps the position, geometry, and fullscreen status of two containers. The | 259 | Swaps the position, geometry, and fullscreen status of two containers. The |
260 | first container can be selected either by criteria or focus. The second | 260 | first container can be selected either by criteria or focus. The second |
261 | container can be selected by _id_, _con\_id_, or _mark_. _id_ can only be | 261 | container can be selected by _id_, _con_id_, or _mark_. _id_ can only be |
262 | used with xwayland views. If the first container has focus, it will retain | 262 | used with xwayland views. If the first container has focus, it will retain |
263 | focus unless it is moved to a different workspace or the second container | 263 | focus unless it is moved to a different workspace or the second container |
264 | becomes fullscreen on the same workspace as the first container. In either | 264 | becomes fullscreen on the same workspace as the first container. In either |
@@ -272,14 +272,14 @@ runtime. | |||
272 | _workspace_. The → (U+2192) is optional and cosmetic. This command is | 272 | _workspace_. The → (U+2192) is optional and cosmetic. This command is |
273 | equivalent to: | 273 | equivalent to: |
274 | 274 | ||
275 | for\_window <criteria> move container to workspace <workspace> | 275 | for_window <criteria> move container to workspace <workspace> |
276 | 276 | ||
277 | *assign* <criteria> [→] output left|right|up|down|<name> | 277 | *assign* <criteria> [→] output left|right|up|down|<name> |
278 | Assigns views matching _criteria_ (see *CRITERIA* for details) to the | 278 | Assigns views matching _criteria_ (see *CRITERIA* for details) to the |
279 | specified output. The → (U+2192) is optional and cosmetic. This command is | 279 | specified output. The → (U+2192) is optional and cosmetic. This command is |
280 | equivalent to: | 280 | equivalent to: |
281 | 281 | ||
282 | for\_window <criteria> move container to output <output> | 282 | for_window <criteria> move container to output <output> |
283 | 283 | ||
284 | *bindsym* [--release|--locked] [--input-device=<device>] [--no-warn] <key combo> <command> | 284 | *bindsym* [--release|--locked] [--input-device=<device>] [--no-warn] <key combo> <command> |
285 | Binds _key combo_ to execute the sway command _command_ when pressed. You | 285 | Binds _key combo_ to execute the sway command _command_ when pressed. You |
@@ -293,7 +293,7 @@ runtime. | |||
293 | the _--no-warn_ flag. | 293 | the _--no-warn_ flag. |
294 | 294 | ||
295 | Mouse buttons can either be specified in the form _button[1-9]_ or by using | 295 | Mouse buttons can either be specified in the form _button[1-9]_ or by using |
296 | the name of the event code (ex _BTN\_LEFT_ or _BTN\_RIGHT_). For the former | 296 | the name of the event code (ex _BTN_LEFT_ or _BTN_RIGHT_). For the former |
297 | option, the buttons will be mapped to their values in X11 (1=left, 2=middle, | 297 | option, the buttons will be mapped to their values in X11 (1=left, 2=middle, |
298 | 3=right, 4=scroll up, 5=scroll down, 6=scroll left, 7=scroll right, 8=back, | 298 | 3=right, 4=scroll up, 5=scroll down, 6=scroll left, 7=scroll right, 8=back, |
299 | 9=forward). For the latter option, you can find the event names using | 299 | 9=forward). For the latter option, you can find the event names using |
@@ -308,7 +308,7 @@ runtime. | |||
308 | *bindcode* [--release|--locked] [--input-device=<device>] [--no-warn] <code> <command> | 308 | *bindcode* [--release|--locked] [--input-device=<device>] [--no-warn] <code> <command> |
309 | is also available for binding with key/button codes instead of key/button names. | 309 | is also available for binding with key/button codes instead of key/button names. |
310 | 310 | ||
311 | *client.<class>* <border> <background> <text> <indicator> <child\_border> | 311 | *client.<class>* <border> <background> <text> <indicator> <child_border> |
312 | Configures the color of window borders and title bars. All 5 colors are | 312 | Configures the color of window borders and title bars. All 5 colors are |
313 | required, with the exception of *client.background*, which requires exactly | 313 | required, with the exception of *client.background*, which requires exactly |
314 | one. Colors may be specified in hex, either as _#RRGGBB_ or _#RRGGBBAA_. | 314 | one. Colors may be specified in hex, either as _#RRGGBB_ or _#RRGGBBAA_. |
@@ -321,7 +321,7 @@ runtime. | |||
321 | *client.focused* | 321 | *client.focused* |
322 | The window that has focus. | 322 | The window that has focus. |
323 | 323 | ||
324 | *client.focused\_inactive* | 324 | *client.focused_inactive* |
325 | The most recently focused view within a container which is not focused. | 325 | The most recently focused view within a container which is not focused. |
326 | 326 | ||
327 | *client.placeholder* | 327 | *client.placeholder* |
@@ -350,7 +350,7 @@ runtime. | |||
350 | container, this would paint the right border of the current view if a | 350 | container, this would paint the right border of the current view if a |
351 | new view would be opened to the right. | 351 | new view would be opened to the right. |
352 | 352 | ||
353 | _child\_border_ | 353 | _child_border_ |
354 | The border around the view itself. | 354 | The border around the view itself. |
355 | 355 | ||
356 | The default colors are: | 356 | The default colors are: |
@@ -360,7 +360,7 @@ The default colors are: | |||
360 | :[ _background_ | 360 | :[ _background_ |
361 | :[ _text_ | 361 | :[ _text_ |
362 | :[ _indicator_ | 362 | :[ _indicator_ |
363 | :[ _child\_border_ | 363 | :[ _child_border_ |
364 | |[ *background* | 364 | |[ *background* |
365 | : n/a | 365 | : n/a |
366 | : #ffffff | 366 | : #ffffff |
@@ -373,7 +373,7 @@ The default colors are: | |||
373 | : #ffffff | 373 | : #ffffff |
374 | : #2e9ef4 | 374 | : #2e9ef4 |
375 | : #285577 | 375 | : #285577 |
376 | | *focused\_inactive* | 376 | | *focused_inactive* |
377 | : #333333 | 377 | : #333333 |
378 | : #5f676a | 378 | : #5f676a |
379 | : #ffffff | 379 | : #ffffff |
@@ -403,10 +403,10 @@ The default colors are: | |||
403 | Enables, disables or toggles debug logging. _toggle_ cannot be used in the | 403 | Enables, disables or toggles debug logging. _toggle_ cannot be used in the |
404 | configuration file. | 404 | configuration file. |
405 | 405 | ||
406 | *default\_border* normal|none|pixel [<n>] | 406 | *default_border* normal|none|pixel [<n>] |
407 | Set default border style for new tiled windows. | 407 | Set default border style for new tiled windows. |
408 | 408 | ||
409 | *default\_floating\_border* normal|none|pixel [<n>] | 409 | *default_floating_border* normal|none|pixel [<n>] |
410 | Set default border style for new floating windows. This only applies to | 410 | Set default border style for new floating windows. This only applies to |
411 | windows that are spawned in floating mode, not windows that become floating | 411 | windows that are spawned in floating mode, not windows that become floating |
412 | afterwards. | 412 | afterwards. |
@@ -414,32 +414,32 @@ The default colors are: | |||
414 | *exec* <shell command> | 414 | *exec* <shell command> |
415 | Executes _shell command_ with sh. | 415 | Executes _shell command_ with sh. |
416 | 416 | ||
417 | *exec\_always* <shell command> | 417 | *exec_always* <shell command> |
418 | Like *exec*, but the shell command will be executed _again_ after *reload*. | 418 | Like *exec*, but the shell command will be executed _again_ after *reload*. |
419 | 419 | ||
420 | *floating\_maximum\_size* <width> x <height> | 420 | *floating_maximum_size* <width> x <height> |
421 | Specifies the maximum size of floating windows. -1 x -1 removes the upper | 421 | Specifies the maximum size of floating windows. -1 x -1 removes the upper |
422 | limit. | 422 | limit. |
423 | 423 | ||
424 | *floating\_minimum\_size* <width> x <height> | 424 | *floating_minimum_size* <width> x <height> |
425 | Specifies the minimum size of floating windows. The default is 75 x 50. | 425 | Specifies the minimum size of floating windows. The default is 75 x 50. |
426 | 426 | ||
427 | *floating\_modifier* <modifier> [normal|inverse] | 427 | *floating_modifier* <modifier> [normal|inverse] |
428 | When the _modifier_ key is held down, you may hold left click to move | 428 | When the _modifier_ key is held down, you may hold left click to move |
429 | windows, and right click to resize them. If _inverse_ is specified, left | 429 | windows, and right click to resize them. If _inverse_ is specified, left |
430 | click is used for resizing and right click for moving. | 430 | click is used for resizing and right click for moving. |
431 | 431 | ||
432 | *floating\_scroll* up|right|down|left [command] | 432 | *floating_scroll* up|right|down|left [command] |
433 | Sets a command to be executed when the mouse wheel is scrolled in the | 433 | Sets a command to be executed when the mouse wheel is scrolled in the |
434 | specified direction while holding the floating modifier. Resets the | 434 | specified direction while holding the floating modifier. Resets the |
435 | command, when given no arguments. | 435 | command, when given no arguments. |
436 | 436 | ||
437 | *focus\_follows\_mouse* yes|no|always | 437 | *focus_follows_mouse* yes|no|always |
438 | If set to _yes_, moving your mouse over a window will focus that window. If | 438 | If set to _yes_, moving your mouse over a window will focus that window. If |
439 | set to _always_, the window under the cursor will always be focused, even | 439 | set to _always_, the window under the cursor will always be focused, even |
440 | after switching between workspaces. | 440 | after switching between workspaces. |
441 | 441 | ||
442 | *focus\_wrapping* yes|no|force | 442 | *focus_wrapping* yes|no|force |
443 | This option determines what to do when attempting to focus over the edge | 443 | This option determines what to do when attempting to focus over the edge |
444 | of a container. If set to _no_, the focused container will retain focus, | 444 | of a container. If set to _no_, the focused container will retain focus, |
445 | if there are no other containers in the direction. If set to _yes_, focus | 445 | if there are no other containers in the direction. If set to _yes_, focus |
@@ -451,25 +451,25 @@ The default colors are: | |||
451 | *font* <font> | 451 | *font* <font> |
452 | Sets font for use in title bars in Pango format. | 452 | Sets font for use in title bars in Pango format. |
453 | 453 | ||
454 | *titlebar\_border\_thickness* <thickness> | 454 | *titlebar_border_thickness* <thickness> |
455 | Thickness of the titlebar border in pixels | 455 | Thickness of the titlebar border in pixels |
456 | 456 | ||
457 | *titlebar\_padding* <horizontal> [<vertical>] | 457 | *titlebar_padding* <horizontal> [<vertical>] |
458 | Padding of the text in the titlebar. _horizontal_ value affects horizontal | 458 | Padding of the text in the titlebar. _horizontal_ value affects horizontal |
459 | padding of the text while _vertical_ value affects vertical padding (space | 459 | padding of the text while _vertical_ value affects vertical padding (space |
460 | above and below text). Padding includes titlebar borders so their value | 460 | above and below text). Padding includes titlebar borders so their value |
461 | should be greater than titlebar\_border\_thickness. If _vertical_ value is | 461 | should be greater than titlebar_border_thickness. If _vertical_ value is |
462 | not specified it is set to the _horizontal_ value. | 462 | not specified it is set to the _horizontal_ value. |
463 | 463 | ||
464 | *for\_window* <criteria> <command> | 464 | *for_window* <criteria> <command> |
465 | Whenever a window that matches _criteria_ appears, run list of commands. | 465 | Whenever a window that matches _criteria_ appears, run list of commands. |
466 | See *CRITERIA* for more details. | 466 | See *CRITERIA* for more details. |
467 | 467 | ||
468 | *force\_focus\_wrapping* yes|no | 468 | *force_focus_wrapping* yes|no |
469 | This option is a wrapper to support i3's legacy syntax. _no_ is equivalent | 469 | This option is a wrapper to support i3's legacy syntax. _no_ is equivalent |
470 | to _focus\_wrapping yes_ and _yes_ is equivalent to | 470 | to _focus_wrapping yes_ and _yes_ is equivalent to |
471 | _focus\_wrapping force_. This is only available for convenience. Please | 471 | _focus_wrapping force_. This is only available for convenience. Please |
472 | use _focus\_wrapping_ instead when possible. | 472 | use _focus_wrapping_ instead when possible. |
473 | 473 | ||
474 | *gaps* inner|outer|horizontal|vertical|top|right|bottom|left <amount> | 474 | *gaps* inner|outer|horizontal|vertical|top|right|bottom|left <amount> |
475 | Sets default _amount_ pixels of _inner_ or _outer_ gap, where the inner | 475 | Sets default _amount_ pixels of _inner_ or _outer_ gap, where the inner |
@@ -482,15 +482,15 @@ The default colors are: | |||
482 | This affects new workspaces only, and is used when the workspace doesn't | 482 | This affects new workspaces only, and is used when the workspace doesn't |
483 | have its own gaps settings (see: workspace <ws> gaps ...). | 483 | have its own gaps settings (see: workspace <ws> gaps ...). |
484 | 484 | ||
485 | *hide\_edge\_borders* none|vertical|horizontal|both|smart|smart\_no\_gaps | 485 | *hide_edge_borders* none|vertical|horizontal|both|smart|smart_no_gaps |
486 | Hides window borders adjacent to the screen edges. Default is _none_. | 486 | Hides window borders adjacent to the screen edges. Default is _none_. |
487 | 487 | ||
488 | *input* <input\_device> <input-subcommands...> | 488 | *input* <input_device> <input-subcommands...> |
489 | For details on input subcommands, see *sway-input*(5). | 489 | For details on input subcommands, see *sway-input*(5). |
490 | 490 | ||
491 | \* may be used in lieu of a specific device name to configure all input | 491 | \* may be used in lieu of a specific device name to configure all input |
492 | devices. A list of input device names may be obtained via *swaymsg -t | 492 | devices. A list of input device names may be obtained via *swaymsg -t |
493 | get\_inputs*. | 493 | get_inputs*. |
494 | 494 | ||
495 | *seat* <seat> <seat-subcommands...> | 495 | *seat* <seat> <seat-subcommands...> |
496 | For details on seat subcommands, see *sway-input*(5). | 496 | For details on seat subcommands, see *sway-input*(5). |
@@ -498,14 +498,14 @@ The default colors are: | |||
498 | *kill* | 498 | *kill* |
499 | Kills (closes) the currently focused container and all of its children. | 499 | Kills (closes) the currently focused container and all of its children. |
500 | 500 | ||
501 | *smart\_borders* on|no\_gaps|off | 501 | *smart_borders* on|no_gaps|off |
502 | If smart\_borders are _on_, borders will only be enabled if the workspace | 502 | If smart_borders are _on_, borders will only be enabled if the workspace |
503 | only has one visible child (identical to _hide\_edge\_borders_ smart). If | 503 | only has one visible child (identical to _hide_edge_borders_ smart). If |
504 | smart\_borders is set to _no\_gaps_, borders will only be enabled if the | 504 | smart_borders is set to _no_gaps_, borders will only be enabled if the |
505 | workspace only has one visible child and gaps greater than zero. | 505 | workspace only has one visible child and gaps greater than zero. |
506 | 506 | ||
507 | *smart\_gaps* on|off | 507 | *smart_gaps* on|off |
508 | If smart\_gaps are _on_ gaps will only be enabled if a workspace has more | 508 | If smart_gaps are _on_ gaps will only be enabled if a workspace has more |
509 | than one child. | 509 | than one child. |
510 | 510 | ||
511 | *mark* --add|--replace [--toggle] <identifier> | 511 | *mark* --add|--replace [--toggle] <identifier> |
@@ -518,30 +518,30 @@ The default colors are: | |||
518 | *mode* <mode> | 518 | *mode* <mode> |
519 | Switches to the specified mode. The default mode _default_. | 519 | Switches to the specified mode. The default mode _default_. |
520 | 520 | ||
521 | *mode* [--pango\_markup] <mode> <mode-subcommands...> | 521 | *mode* [--pango_markup] <mode> <mode-subcommands...> |
522 | The only two valid _mode-subcommands..._ are *bindsym* and *bindcode*. | 522 | The only two valid _mode-subcommands..._ are *bindsym* and *bindcode*. |
523 | If _--pango\_markup_ is given, then _mode_ will be interpreted as pango | 523 | If _--pango_markup_ is given, then _mode_ will be interpreted as pango |
524 | markup. | 524 | markup. |
525 | 525 | ||
526 | *mouse\_warping* output|container|none | 526 | *mouse_warping* output|container|none |
527 | If _output_ is specified, the mouse will be moved to new outputs as you | 527 | If _output_ is specified, the mouse will be moved to new outputs as you |
528 | move focus between them. If _container_ is specified, the mouse will be | 528 | move focus between them. If _container_ is specified, the mouse will be |
529 | moved to the middle of the container on switch. Default is _output_. | 529 | moved to the middle of the container on switch. Default is _output_. |
530 | 530 | ||
531 | *no\_focus* <criteria> | 531 | *no_focus* <criteria> |
532 | Prevents windows matching <criteria> from being focused automatically when | 532 | Prevents windows matching <criteria> from being focused automatically when |
533 | they're created. This has no effect on the first window in a workspace. | 533 | they're created. This has no effect on the first window in a workspace. |
534 | 534 | ||
535 | *output* <output\_name> <output-subcommands...> | 535 | *output* <output_name> <output-subcommands...> |
536 | For details on output subcommands, see *sway-output*(5). | 536 | For details on output subcommands, see *sway-output*(5). |
537 | 537 | ||
538 | \* may be used in lieu of a specific output name to configure all outputs. | 538 | \* may be used in lieu of a specific output name to configure all outputs. |
539 | A list of output names may be obtained via *swaymsg -t get\_outputs*. | 539 | A list of output names may be obtained via *swaymsg -t get_outputs*. |
540 | 540 | ||
541 | *popup\_during\_fullscreen* smart|ignore|leave\_fullscreen | 541 | *popup_during_fullscreen* smart|ignore|leave_fullscreen |
542 | Determines what to do when a fullscreen view opens a dialog. | 542 | Determines what to do when a fullscreen view opens a dialog. |
543 | If _smart_ (the default), the dialog will be displayed. If _ignore_, the | 543 | If _smart_ (the default), the dialog will be displayed. If _ignore_, the |
544 | dialog will not be rendered. If _leave\_fullscreen_, the view will exit | 544 | dialog will not be rendered. If _leave_fullscreen_, the view will exit |
545 | fullscreen mode and the dialog will be rendered. | 545 | fullscreen mode and the dialog will be rendered. |
546 | 546 | ||
547 | *set* $<name> <value> | 547 | *set* $<name> <value> |
@@ -552,32 +552,32 @@ The default colors are: | |||
552 | sense for the variable to be replaced at run time since some arguments do | 552 | sense for the variable to be replaced at run time since some arguments do |
553 | need to be known at config time. | 553 | need to be known at config time. |
554 | 554 | ||
555 | *show\_marks* yes|no | 555 | *show_marks* yes|no |
556 | If *show\_marks* is yes, marks will be displayed in the window borders. | 556 | If *show_marks* is yes, marks will be displayed in the window borders. |
557 | Any mark that starts with an underscore will not be drawn even if | 557 | Any mark that starts with an underscore will not be drawn even if |
558 | *show\_marks* is yes. The default is _yes_. | 558 | *show_marks* is yes. The default is _yes_. |
559 | 559 | ||
560 | *opacity* <value> | 560 | *opacity* <value> |
561 | Set the opacity of the window between 0 (completely transparent) and 1 | 561 | Set the opacity of the window between 0 (completely transparent) and 1 |
562 | (completely opaque). | 562 | (completely opaque). |
563 | 563 | ||
564 | *tiling\_drag* enable|disable|toggle | 564 | *tiling_drag* enable|disable|toggle |
565 | Sets whether or not tiling containers can be dragged with the mouse. If | 565 | Sets whether or not tiling containers can be dragged with the mouse. If |
566 | enabled (default), the _floating\_mod_ can be used to drag tiling, as well | 566 | enabled (default), the _floating_mod_ can be used to drag tiling, as well |
567 | as floating, containers. Using the left mouse button on title bars without | 567 | as floating, containers. Using the left mouse button on title bars without |
568 | the _floating\_mod_ will also allow the container to be dragged. _toggle_ | 568 | the _floating_mod_ will also allow the container to be dragged. _toggle_ |
569 | should not be used in the config file. | 569 | should not be used in the config file. |
570 | 570 | ||
571 | *tiling\_drag\_threshold* <threshold> | 571 | *tiling_drag_threshold* <threshold> |
572 | Sets the threshold that must be exceeded for a container to be dragged by | 572 | Sets the threshold that must be exceeded for a container to be dragged by |
573 | its titlebar. This has no effect if _floating\_mod_ is used or if | 573 | its titlebar. This has no effect if _floating_mod_ is used or if |
574 | _tiling\_drag_ is set to _disable_. Once the threshold has been exceeded | 574 | _tiling_drag_ is set to _disable_. Once the threshold has been exceeded |
575 | once, the drag starts and the cursor can come back inside the threshold | 575 | once, the drag starts and the cursor can come back inside the threshold |
576 | without stopping the drag. _threshold_ is multiplied by the scale of the | 576 | without stopping the drag. _threshold_ is multiplied by the scale of the |
577 | output that the cursor on. The default is 9. | 577 | output that the cursor on. The default is 9. |
578 | 578 | ||
579 | *title\_align* left|center|right | 579 | *title_align* left|center|right |
580 | Sets the title alignment. If _right_ is selected and _show\_marks_ is set | 580 | Sets the title alignment. If _right_ is selected and _show_marks_ is set |
581 | to _yes_, the marks will be shown on the _left_ side instead of the | 581 | to _yes_, the marks will be shown on the _left_ side instead of the |
582 | _right_ side. | 582 | _right_ side. |
583 | 583 | ||
@@ -598,10 +598,10 @@ The default colors are: | |||
598 | Switches to the next workspace on the current output or on the next output | 598 | Switches to the next workspace on the current output or on the next output |
599 | if currently on the last workspace. | 599 | if currently on the last workspace. |
600 | 600 | ||
601 | *workspace* prev\_on\_output|next\_on\_output | 601 | *workspace* prev_on_output|next_on_output |
602 | Switches to the next workspace on the current output. | 602 | Switches to the next workspace on the current output. |
603 | 603 | ||
604 | *workspace* back\_and\_forth | 604 | *workspace* back_and_forth |
605 | Switches to the previously focused workspace. | 605 | Switches to the previously focused workspace. |
606 | 606 | ||
607 | *workspace* <name> gaps inner|outer|horizontal|vertical|top|right|bottom|left | 607 | *workspace* <name> gaps inner|outer|horizontal|vertical|top|right|bottom|left |
@@ -616,23 +616,23 @@ The default colors are: | |||
616 | is higher on the list becomes available, the workspace will be move to the | 616 | is higher on the list becomes available, the workspace will be move to the |
617 | higher priority output. | 617 | higher priority output. |
618 | 618 | ||
619 | *workspace\_auto\_back\_and\_forth* yes|no | 619 | *workspace_auto_back_and_forth* yes|no |
620 | When _yes_, repeating a workspace switch command will switch back to the | 620 | When _yes_, repeating a workspace switch command will switch back to the |
621 | prior workspace. For example, if you are currently on workspace 1, | 621 | prior workspace. For example, if you are currently on workspace 1, |
622 | switch to workspace 2, then invoke the "workspace 2" command again, you | 622 | switch to workspace 2, then invoke the "workspace 2" command again, you |
623 | will be returned to workspace 1. Default is _no_. | 623 | will be returned to workspace 1. Default is _no_. |
624 | 624 | ||
625 | *workspace\_layout* default|stacking|tabbed | 625 | *workspace_layout* default|stacking|tabbed |
626 | Specifies the initial layout for new workspaces. | 626 | Specifies the initial layout for new workspaces. |
627 | 627 | ||
628 | # BAR CONTROL | 628 | # BAR CONTROL |
629 | 629 | ||
630 | *bar hidden\_state* hide|show|toggle [<bar\_id>] | 630 | *bar hidden_state* hide|show|toggle [<bar_id>] |
631 | Sets the hidden state of the bar (see *sway-bar*(5)), either individually, | 631 | Sets the hidden state of the bar (see *sway-bar*(5)), either individually, |
632 | by specifying a bar id, or if none is given, for all bar instances. | 632 | by specifying a bar id, or if none is given, for all bar instances. |
633 | _toggle_ switches between _hide_ and _show_. | 633 | _toggle_ switches between _hide_ and _show_. |
634 | 634 | ||
635 | *bar mode* dock|hide|invisible|toggle [<bar\_id>] | 635 | *bar mode* dock|hide|invisible|toggle [<bar_id>] |
636 | Sets the mode of the bar (see *sway-bar*(5)), either individually, | 636 | Sets the mode of the bar (see *sway-bar*(5)), either individually, |
637 | by specifying a bar id, or if none is given, for all bar instances. | 637 | by specifying a bar id, or if none is given, for all bar instances. |
638 | _toggle_ switches between _dock_ and _hide_. | 638 | _toggle_ switches between _dock_ and _hide_. |
@@ -649,7 +649,7 @@ The string contains one or more (space separated) attribute/value pairs. They | |||
649 | are used by some commands to choose which views to execute actions on. All | 649 | are used by some commands to choose which views to execute actions on. All |
650 | attributes must match for the criteria to match. | 650 | attributes must match for the criteria to match. |
651 | 651 | ||
652 | Criteria may be used with either the *for\_window* or *assign* commands to | 652 | Criteria may be used with either the *for_window* or *assign* commands to |
653 | specify operations to perform on new views. A criteria may also be used to | 653 | specify operations to perform on new views. A criteria may also be used to |
654 | perform specific commands (ones that normally act upon one window) on all views | 654 | perform specific commands (ones that normally act upon one window) on all views |
655 | that match that criteria. For example: | 655 | that match that criteria. For example: |
@@ -674,7 +674,7 @@ Mark all Firefox windows with "Browser": | |||
674 | 674 | ||
675 | The following attributes may be matched with: | 675 | The following attributes may be matched with: |
676 | 676 | ||
677 | *app\_id* | 677 | *app_id* |
678 | Compare value against the app id. Can be a regular expression. If value is | 678 | Compare value against the app id. Can be a regular expression. If value is |
679 | \_\_focused\_\_, then the app id must be the same as that of the currently | 679 | \_\_focused\_\_, then the app id must be the same as that of the currently |
680 | focused window. | 680 | focused window. |
@@ -684,12 +684,12 @@ The following attributes may be matched with: | |||
684 | value is \_\_focused\_\_, then the window class must be the same as that of | 684 | value is \_\_focused\_\_, then the window class must be the same as that of |
685 | the currently focused window. | 685 | the currently focused window. |
686 | 686 | ||
687 | *con\_id* | 687 | *con_id* |
688 | Compare against the internal container ID, which you can find via IPC. If | 688 | Compare against the internal container ID, which you can find via IPC. If |
689 | value is \_\_focused\_\_, then the id must be the same as that of the | 689 | value is \_\_focused\_\_, then the id must be the same as that of the |
690 | currently focused window. | 690 | currently focused window. |
691 | 691 | ||
692 | *con\_mark* | 692 | *con_mark* |
693 | Compare against the window marks. Can be a regular expression. | 693 | Compare against the window marks. Can be a regular expression. |
694 | 694 | ||
695 | *floating* | 695 | *floating* |
@@ -704,7 +704,7 @@ The following attributes may be matched with: | |||
704 | of the currently focused window. | 704 | of the currently focused window. |
705 | 705 | ||
706 | *shell* | 706 | *shell* |
707 | Compare value against the window shell, such as "xdg\_shell" or "xwayland". | 707 | Compare value against the window shell, such as "xdg_shell" or "xwayland". |
708 | Can be a regular expression. If value is \_\_focused\_\_, then the shell | 708 | Can be a regular expression. If value is \_\_focused\_\_, then the shell |
709 | must be the same as that of the currently focused window. | 709 | must be the same as that of the currently focused window. |
710 | 710 | ||
@@ -720,15 +720,15 @@ The following attributes may be matched with: | |||
720 | Compares the urgent state of the window. Can be "first", "last", "latest", | 720 | Compares the urgent state of the window. Can be "first", "last", "latest", |
721 | "newest", "oldest" or "recent". | 721 | "newest", "oldest" or "recent". |
722 | 722 | ||
723 | *window\_role* | 723 | *window_role* |
724 | Compare against the window role (WM\_WINDOW\_ROLE). Can be a regular | 724 | Compare against the window role (WM_WINDOW_ROLE). Can be a regular |
725 | expression. If value is \_\_focused\_\_, then the window role must be the | 725 | expression. If value is \_\_focused\_\_, then the window role must be the |
726 | same as that of the currently focused window. | 726 | same as that of the currently focused window. |
727 | 727 | ||
728 | *window\_type* | 728 | *window_type* |
729 | Compare against the window type (\_NET\_WM\_WINDOW\_TYPE). Possible values | 729 | Compare against the window type (\_NET_WM_WINDOW_TYPE). Possible values |
730 | are normal, dialog, utility, toolbar, splash, menu, dropdown\_menu, | 730 | are normal, dialog, utility, toolbar, splash, menu, dropdown_menu, |
731 | popup\_menu, tooltip and notification. | 731 | popup_menu, tooltip and notification. |
732 | 732 | ||
733 | *workspace* | 733 | *workspace* |
734 | Compare against the workspace name for this view. Can be a regular | 734 | Compare against the workspace name for this view. Can be a regular |