diff options
Diffstat (limited to 'sway/sway.5.scd')
-rw-r--r-- | sway/sway.5.scd | 162 |
1 files changed, 81 insertions, 81 deletions
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 |