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 c2539804..55de3c9c 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] [global] | 137 | *fullscreen* [enable|disable|toggle] [global] |
@@ -164,7 +164,7 @@ set|plus|minus <amount> | |||
164 | If unspecified, the default is 10 pixels. Pixels are ignored when moving | 164 | If unspecified, the default is 10 pixels. Pixels are ignored when moving |
165 | tiled containers. | 165 | tiled containers. |
166 | 166 | ||
167 | *move* [absolute] position <pos\_x> [px] <pos\_y> [px] | 167 | *move* [absolute] position <pos_x> [px] <pos_y> [px] |
168 | Moves the focused container to the specified position in the workspace. If | 168 | Moves the focused container to the specified position in the workspace. If |
169 | _absolute_ is used, the position is relative to all outputs. | 169 | _absolute_ is used, the position is relative to all outputs. |
170 | 170 | ||
@@ -187,11 +187,11 @@ set|plus|minus <amount> | |||
187 | Moves the focused container to the previous, next or current workspace on | 187 | Moves the focused container to the previous, next or current workspace on |
188 | this output, or if no workspaces remain, the previous or next output. | 188 | this output, or if no workspaces remain, the previous or next output. |
189 | 189 | ||
190 | *move* container|window [to] workspace prev\_on\_output|next\_on\_output | 190 | *move* container|window [to] workspace prev_on_output|next_on_output |
191 | Moves the focused container to the previous or next workspace on this | 191 | Moves the focused container to the previous or next workspace on this |
192 | output, wrapping around if already at the first or last workspace. | 192 | output, wrapping around if already at the first or last workspace. |
193 | 193 | ||
194 | *move* container|window [to] workspace back\_and\_forth | 194 | *move* container|window [to] workspace back_and_forth |
195 | Moves the focused container to previously focused workspace. | 195 | Moves the focused container to previously focused workspace. |
196 | 196 | ||
197 | *move* container|window|workspace [to] output <name> | 197 | *move* container|window|workspace [to] output <name> |
@@ -256,10 +256,10 @@ set|plus|minus <amount> | |||
256 | "Sticks" a floating window to the current output so that it shows up on all | 256 | "Sticks" a floating window to the current output so that it shows up on all |
257 | workspaces. | 257 | workspaces. |
258 | 258 | ||
259 | *swap* container with id|con\_id|mark <arg> | 259 | *swap* container with id|con_id|mark <arg> |
260 | Swaps the position, geometry, and fullscreen status of two containers. The | 260 | Swaps the position, geometry, and fullscreen status of two containers. The |
261 | first container can be selected either by criteria or focus. The second | 261 | first container can be selected either by criteria or focus. The second |
262 | container can be selected by _id_, _con\_id_, or _mark_. _id_ can only be | 262 | container can be selected by _id_, _con_id_, or _mark_. _id_ can only be |
263 | used with xwayland views. If the first container has focus, it will retain | 263 | used with xwayland views. If the first container has focus, it will retain |
264 | focus unless it is moved to a different workspace or the second container | 264 | focus unless it is moved to a different workspace or the second container |
265 | becomes fullscreen on the same workspace as the first container. In either | 265 | becomes fullscreen on the same workspace as the first container. In either |
@@ -273,14 +273,14 @@ runtime. | |||
273 | _workspace_. The → (U+2192) is optional and cosmetic. This command is | 273 | _workspace_. The → (U+2192) is optional and cosmetic. This command is |
274 | equivalent to: | 274 | equivalent to: |
275 | 275 | ||
276 | for\_window <criteria> move container to workspace <workspace> | 276 | for_window <criteria> move container to workspace <workspace> |
277 | 277 | ||
278 | *assign* <criteria> [→] output left|right|up|down|<name> | 278 | *assign* <criteria> [→] output left|right|up|down|<name> |
279 | Assigns views matching _criteria_ (see *CRITERIA* for details) to the | 279 | Assigns views matching _criteria_ (see *CRITERIA* for details) to the |
280 | specified output. The → (U+2192) is optional and cosmetic. This command is | 280 | specified output. The → (U+2192) is optional and cosmetic. This command is |
281 | equivalent to: | 281 | equivalent to: |
282 | 282 | ||
283 | for\_window <criteria> move container to output <output> | 283 | for_window <criteria> move container to output <output> |
284 | 284 | ||
285 | *bindsym* [--release|--locked] [--input-device=<device>] [--no-warn] <key combo> <command> | 285 | *bindsym* [--release|--locked] [--input-device=<device>] [--no-warn] <key combo> <command> |
286 | Binds _key combo_ to execute the sway command _command_ when pressed. You | 286 | Binds _key combo_ to execute the sway command _command_ when pressed. You |
@@ -294,7 +294,7 @@ runtime. | |||
294 | the _--no-warn_ flag. | 294 | the _--no-warn_ flag. |
295 | 295 | ||
296 | Mouse buttons can either be specified in the form _button[1-9]_ or by using | 296 | Mouse buttons can either be specified in the form _button[1-9]_ or by using |
297 | the name of the event code (ex _BTN\_LEFT_ or _BTN\_RIGHT_). For the former | 297 | the name of the event code (ex _BTN_LEFT_ or _BTN_RIGHT_). For the former |
298 | option, the buttons will be mapped to their values in X11 (1=left, 2=middle, | 298 | option, the buttons will be mapped to their values in X11 (1=left, 2=middle, |
299 | 3=right, 4=scroll up, 5=scroll down, 6=scroll left, 7=scroll right, 8=back, | 299 | 3=right, 4=scroll up, 5=scroll down, 6=scroll left, 7=scroll right, 8=back, |
300 | 9=forward). For the latter option, you can find the event names using | 300 | 9=forward). For the latter option, you can find the event names using |
@@ -309,7 +309,7 @@ runtime. | |||
309 | *bindcode* [--release|--locked] [--input-device=<device>] [--no-warn] <code> <command> | 309 | *bindcode* [--release|--locked] [--input-device=<device>] [--no-warn] <code> <command> |
310 | is also available for binding with key/button codes instead of key/button names. | 310 | is also available for binding with key/button codes instead of key/button names. |
311 | 311 | ||
312 | *client.<class>* <border> <background> <text> <indicator> <child\_border> | 312 | *client.<class>* <border> <background> <text> <indicator> <child_border> |
313 | Configures the color of window borders and title bars. All 5 colors are | 313 | Configures the color of window borders and title bars. All 5 colors are |
314 | required, with the exception of *client.background*, which requires exactly | 314 | required, with the exception of *client.background*, which requires exactly |
315 | one. Colors may be specified in hex, either as _#RRGGBB_ or _#RRGGBBAA_. | 315 | one. Colors may be specified in hex, either as _#RRGGBB_ or _#RRGGBBAA_. |
@@ -322,7 +322,7 @@ runtime. | |||
322 | *client.focused* | 322 | *client.focused* |
323 | The window that has focus. | 323 | The window that has focus. |
324 | 324 | ||
325 | *client.focused\_inactive* | 325 | *client.focused_inactive* |
326 | The most recently focused view within a container which is not focused. | 326 | The most recently focused view within a container which is not focused. |
327 | 327 | ||
328 | *client.placeholder* | 328 | *client.placeholder* |
@@ -351,7 +351,7 @@ runtime. | |||
351 | container, this would paint the right border of the current view if a | 351 | container, this would paint the right border of the current view if a |
352 | new view would be opened to the right. | 352 | new view would be opened to the right. |
353 | 353 | ||
354 | _child\_border_ | 354 | _child_border_ |
355 | The border around the view itself. | 355 | The border around the view itself. |
356 | 356 | ||
357 | The default colors are: | 357 | The default colors are: |
@@ -361,7 +361,7 @@ The default colors are: | |||
361 | :[ _background_ | 361 | :[ _background_ |
362 | :[ _text_ | 362 | :[ _text_ |
363 | :[ _indicator_ | 363 | :[ _indicator_ |
364 | :[ _child\_border_ | 364 | :[ _child_border_ |
365 | |[ *background* | 365 | |[ *background* |
366 | : n/a | 366 | : n/a |
367 | : #ffffff | 367 | : #ffffff |
@@ -374,7 +374,7 @@ The default colors are: | |||
374 | : #ffffff | 374 | : #ffffff |
375 | : #2e9ef4 | 375 | : #2e9ef4 |
376 | : #285577 | 376 | : #285577 |
377 | | *focused\_inactive* | 377 | | *focused_inactive* |
378 | : #333333 | 378 | : #333333 |
379 | : #5f676a | 379 | : #5f676a |
380 | : #ffffff | 380 | : #ffffff |
@@ -404,10 +404,10 @@ The default colors are: | |||
404 | Enables, disables or toggles debug logging. _toggle_ cannot be used in the | 404 | Enables, disables or toggles debug logging. _toggle_ cannot be used in the |
405 | configuration file. | 405 | configuration file. |
406 | 406 | ||
407 | *default\_border* normal|none|pixel [<n>] | 407 | *default_border* normal|none|pixel [<n>] |
408 | Set default border style for new tiled windows. | 408 | Set default border style for new tiled windows. |
409 | 409 | ||
410 | *default\_floating\_border* normal|none|pixel [<n>] | 410 | *default_floating_border* normal|none|pixel [<n>] |
411 | Set default border style for new floating windows. This only applies to | 411 | Set default border style for new floating windows. This only applies to |
412 | windows that are spawned in floating mode, not windows that become floating | 412 | windows that are spawned in floating mode, not windows that become floating |
413 | afterwards. | 413 | afterwards. |
@@ -415,32 +415,32 @@ The default colors are: | |||
415 | *exec* <shell command> | 415 | *exec* <shell command> |
416 | Executes _shell command_ with sh. | 416 | Executes _shell command_ with sh. |
417 | 417 | ||
418 | *exec\_always* <shell command> | 418 | *exec_always* <shell command> |
419 | Like *exec*, but the shell command will be executed _again_ after *reload*. | 419 | Like *exec*, but the shell command will be executed _again_ after *reload*. |
420 | 420 | ||
421 | *floating\_maximum\_size* <width> x <height> | 421 | *floating_maximum_size* <width> x <height> |
422 | Specifies the maximum size of floating windows. -1 x -1 removes the upper | 422 | Specifies the maximum size of floating windows. -1 x -1 removes the upper |
423 | limit. | 423 | limit. |
424 | 424 | ||
425 | *floating\_minimum\_size* <width> x <height> | 425 | *floating_minimum_size* <width> x <height> |
426 | Specifies the minimum size of floating windows. The default is 75 x 50. | 426 | Specifies the minimum size of floating windows. The default is 75 x 50. |
427 | 427 | ||
428 | *floating\_modifier* <modifier> [normal|inverse] | 428 | *floating_modifier* <modifier> [normal|inverse] |
429 | When the _modifier_ key is held down, you may hold left click to move | 429 | When the _modifier_ key is held down, you may hold left click to move |
430 | windows, and right click to resize them. If _inverse_ is specified, left | 430 | windows, and right click to resize them. If _inverse_ is specified, left |
431 | click is used for resizing and right click for moving. | 431 | click is used for resizing and right click for moving. |
432 | 432 | ||
433 | *floating\_scroll* up|right|down|left [command] | 433 | *floating_scroll* up|right|down|left [command] |
434 | Sets a command to be executed when the mouse wheel is scrolled in the | 434 | Sets a command to be executed when the mouse wheel is scrolled in the |
435 | specified direction while holding the floating modifier. Resets the | 435 | specified direction while holding the floating modifier. Resets the |
436 | command, when given no arguments. | 436 | command, when given no arguments. |
437 | 437 | ||
438 | *focus\_follows\_mouse* yes|no|always | 438 | *focus_follows_mouse* yes|no|always |
439 | If set to _yes_, moving your mouse over a window will focus that window. If | 439 | If set to _yes_, moving your mouse over a window will focus that window. If |
440 | set to _always_, the window under the cursor will always be focused, even | 440 | set to _always_, the window under the cursor will always be focused, even |
441 | after switching between workspaces. | 441 | after switching between workspaces. |
442 | 442 | ||
443 | *focus\_wrapping* yes|no|force | 443 | *focus_wrapping* yes|no|force |
444 | This option determines what to do when attempting to focus over the edge | 444 | This option determines what to do when attempting to focus over the edge |
445 | of a container. If set to _no_, the focused container will retain focus, | 445 | of a container. If set to _no_, the focused container will retain focus, |
446 | if there are no other containers in the direction. If set to _yes_, focus | 446 | if there are no other containers in the direction. If set to _yes_, focus |
@@ -452,25 +452,25 @@ The default colors are: | |||
452 | *font* <font> | 452 | *font* <font> |
453 | Sets font for use in title bars in Pango format. | 453 | Sets font for use in title bars in Pango format. |
454 | 454 | ||
455 | *titlebar\_border\_thickness* <thickness> | 455 | *titlebar_border_thickness* <thickness> |
456 | Thickness of the titlebar border in pixels | 456 | Thickness of the titlebar border in pixels |
457 | 457 | ||
458 | *titlebar\_padding* <horizontal> [<vertical>] | 458 | *titlebar_padding* <horizontal> [<vertical>] |
459 | Padding of the text in the titlebar. _horizontal_ value affects horizontal | 459 | Padding of the text in the titlebar. _horizontal_ value affects horizontal |
460 | padding of the text while _vertical_ value affects vertical padding (space | 460 | padding of the text while _vertical_ value affects vertical padding (space |
461 | above and below text). Padding includes titlebar borders so their value | 461 | above and below text). Padding includes titlebar borders so their value |
462 | should be greater than titlebar\_border\_thickness. If _vertical_ value is | 462 | should be greater than titlebar_border_thickness. If _vertical_ value is |
463 | not specified it is set to the _horizontal_ value. | 463 | not specified it is set to the _horizontal_ value. |
464 | 464 | ||
465 | *for\_window* <criteria> <command> | 465 | *for_window* <criteria> <command> |
466 | Whenever a window that matches _criteria_ appears, run list of commands. | 466 | Whenever a window that matches _criteria_ appears, run list of commands. |
467 | See *CRITERIA* for more details. | 467 | See *CRITERIA* for more details. |
468 | 468 | ||
469 | *force\_focus\_wrapping* yes|no | 469 | *force_focus_wrapping* yes|no |
470 | This option is a wrapper to support i3's legacy syntax. _no_ is equivalent | 470 | This option is a wrapper to support i3's legacy syntax. _no_ is equivalent |
471 | to _focus\_wrapping yes_ and _yes_ is equivalent to | 471 | to _focus_wrapping yes_ and _yes_ is equivalent to |
472 | _focus\_wrapping force_. This is only available for convenience. Please | 472 | _focus_wrapping force_. This is only available for convenience. Please |
473 | use _focus\_wrapping_ instead when possible. | 473 | use _focus_wrapping_ instead when possible. |
474 | 474 | ||
475 | *gaps* inner|outer|horizontal|vertical|top|right|bottom|left <amount> | 475 | *gaps* inner|outer|horizontal|vertical|top|right|bottom|left <amount> |
476 | Sets default _amount_ pixels of _inner_ or _outer_ gap, where the inner | 476 | Sets default _amount_ pixels of _inner_ or _outer_ gap, where the inner |
@@ -483,15 +483,15 @@ The default colors are: | |||
483 | This affects new workspaces only, and is used when the workspace doesn't | 483 | This affects new workspaces only, and is used when the workspace doesn't |
484 | have its own gaps settings (see: workspace <ws> gaps ...). | 484 | have its own gaps settings (see: workspace <ws> gaps ...). |
485 | 485 | ||
486 | *hide\_edge\_borders* none|vertical|horizontal|both|smart|smart\_no\_gaps | 486 | *hide_edge_borders* none|vertical|horizontal|both|smart|smart_no_gaps |
487 | Hides window borders adjacent to the screen edges. Default is _none_. | 487 | Hides window borders adjacent to the screen edges. Default is _none_. |
488 | 488 | ||
489 | *input* <input\_device> <input-subcommands...> | 489 | *input* <input_device> <input-subcommands...> |
490 | For details on input subcommands, see *sway-input*(5). | 490 | For details on input subcommands, see *sway-input*(5). |
491 | 491 | ||
492 | \* may be used in lieu of a specific device name to configure all input | 492 | \* may be used in lieu of a specific device name to configure all input |
493 | devices. A list of input device names may be obtained via *swaymsg -t | 493 | devices. A list of input device names may be obtained via *swaymsg -t |
494 | get\_inputs*. | 494 | get_inputs*. |
495 | 495 | ||
496 | *seat* <seat> <seat-subcommands...> | 496 | *seat* <seat> <seat-subcommands...> |
497 | For details on seat subcommands, see *sway-input*(5). | 497 | For details on seat subcommands, see *sway-input*(5). |
@@ -499,14 +499,14 @@ The default colors are: | |||
499 | *kill* | 499 | *kill* |
500 | Kills (closes) the currently focused container and all of its children. | 500 | Kills (closes) the currently focused container and all of its children. |
501 | 501 | ||
502 | *smart\_borders* on|no\_gaps|off | 502 | *smart_borders* on|no_gaps|off |
503 | If smart\_borders are _on_, borders will only be enabled if the workspace | 503 | If smart_borders are _on_, borders will only be enabled if the workspace |
504 | only has one visible child (identical to _hide\_edge\_borders_ smart). If | 504 | only has one visible child (identical to _hide_edge_borders_ smart). If |
505 | smart\_borders is set to _no\_gaps_, borders will only be enabled if the | 505 | smart_borders is set to _no_gaps_, borders will only be enabled if the |
506 | workspace only has one visible child and gaps greater than zero. | 506 | workspace only has one visible child and gaps greater than zero. |
507 | 507 | ||
508 | *smart\_gaps* on|off | 508 | *smart_gaps* on|off |
509 | If smart\_gaps are _on_ gaps will only be enabled if a workspace has more | 509 | If smart_gaps are _on_ gaps will only be enabled if a workspace has more |
510 | than one child. | 510 | than one child. |
511 | 511 | ||
512 | *mark* --add|--replace [--toggle] <identifier> | 512 | *mark* --add|--replace [--toggle] <identifier> |
@@ -519,30 +519,30 @@ The default colors are: | |||
519 | *mode* <mode> | 519 | *mode* <mode> |
520 | Switches to the specified mode. The default mode _default_. | 520 | Switches to the specified mode. The default mode _default_. |
521 | 521 | ||
522 | *mode* [--pango\_markup] <mode> <mode-subcommands...> | 522 | *mode* [--pango_markup] <mode> <mode-subcommands...> |
523 | The only two valid _mode-subcommands..._ are *bindsym* and *bindcode*. | 523 | The only two valid _mode-subcommands..._ are *bindsym* and *bindcode*. |
524 | If _--pango\_markup_ is given, then _mode_ will be interpreted as pango | 524 | If _--pango_markup_ is given, then _mode_ will be interpreted as pango |
525 | markup. | 525 | markup. |
526 | 526 | ||
527 | *mouse\_warping* output|container|none | 527 | *mouse_warping* output|container|none |
528 | If _output_ is specified, the mouse will be moved to new outputs as you | 528 | If _output_ is specified, the mouse will be moved to new outputs as you |
529 | move focus between them. If _container_ is specified, the mouse will be | 529 | move focus between them. If _container_ is specified, the mouse will be |
530 | moved to the middle of the container on switch. Default is _output_. | 530 | moved to the middle of the container on switch. Default is _output_. |
531 | 531 | ||
532 | *no\_focus* <criteria> | 532 | *no_focus* <criteria> |
533 | Prevents windows matching <criteria> from being focused automatically when | 533 | Prevents windows matching <criteria> from being focused automatically when |
534 | they're created. This has no effect on the first window in a workspace. | 534 | they're created. This has no effect on the first window in a workspace. |
535 | 535 | ||
536 | *output* <output\_name> <output-subcommands...> | 536 | *output* <output_name> <output-subcommands...> |
537 | For details on output subcommands, see *sway-output*(5). | 537 | For details on output subcommands, see *sway-output*(5). |
538 | 538 | ||
539 | \* may be used in lieu of a specific output name to configure all outputs. | 539 | \* may be used in lieu of a specific output name to configure all outputs. |
540 | A list of output names may be obtained via *swaymsg -t get\_outputs*. | 540 | A list of output names may be obtained via *swaymsg -t get_outputs*. |
541 | 541 | ||
542 | *popup\_during\_fullscreen* smart|ignore|leave\_fullscreen | 542 | *popup_during_fullscreen* smart|ignore|leave_fullscreen |
543 | Determines what to do when a fullscreen view opens a dialog. | 543 | Determines what to do when a fullscreen view opens a dialog. |
544 | If _smart_ (the default), the dialog will be displayed. If _ignore_, the | 544 | If _smart_ (the default), the dialog will be displayed. If _ignore_, the |
545 | dialog will not be rendered. If _leave\_fullscreen_, the view will exit | 545 | dialog will not be rendered. If _leave_fullscreen_, the view will exit |
546 | fullscreen mode and the dialog will be rendered. | 546 | fullscreen mode and the dialog will be rendered. |
547 | 547 | ||
548 | *set* $<name> <value> | 548 | *set* $<name> <value> |
@@ -553,32 +553,32 @@ The default colors are: | |||
553 | sense for the variable to be replaced at run time since some arguments do | 553 | sense for the variable to be replaced at run time since some arguments do |
554 | need to be known at config time. | 554 | need to be known at config time. |
555 | 555 | ||
556 | *show\_marks* yes|no | 556 | *show_marks* yes|no |
557 | If *show\_marks* is yes, marks will be displayed in the window borders. | 557 | If *show_marks* is yes, marks will be displayed in the window borders. |
558 | Any mark that starts with an underscore will not be drawn even if | 558 | Any mark that starts with an underscore will not be drawn even if |
559 | *show\_marks* is yes. The default is _yes_. | 559 | *show_marks* is yes. The default is _yes_. |
560 | 560 | ||
561 | *opacity* <value> | 561 | *opacity* <value> |
562 | Set the opacity of the window between 0 (completely transparent) and 1 | 562 | Set the opacity of the window between 0 (completely transparent) and 1 |
563 | (completely opaque). | 563 | (completely opaque). |
564 | 564 | ||
565 | *tiling\_drag* enable|disable|toggle | 565 | *tiling_drag* enable|disable|toggle |
566 | Sets whether or not tiling containers can be dragged with the mouse. If | 566 | Sets whether or not tiling containers can be dragged with the mouse. If |
567 | enabled (default), the _floating\_mod_ can be used to drag tiling, as well | 567 | enabled (default), the _floating_mod_ can be used to drag tiling, as well |
568 | as floating, containers. Using the left mouse button on title bars without | 568 | as floating, containers. Using the left mouse button on title bars without |
569 | the _floating\_mod_ will also allow the container to be dragged. _toggle_ | 569 | the _floating_mod_ will also allow the container to be dragged. _toggle_ |
570 | should not be used in the config file. | 570 | should not be used in the config file. |
571 | 571 | ||
572 | *tiling\_drag\_threshold* <threshold> | 572 | *tiling_drag_threshold* <threshold> |
573 | Sets the threshold that must be exceeded for a container to be dragged by | 573 | Sets the threshold that must be exceeded for a container to be dragged by |
574 | its titlebar. This has no effect if _floating\_mod_ is used or if | 574 | its titlebar. This has no effect if _floating_mod_ is used or if |
575 | _tiling\_drag_ is set to _disable_. Once the threshold has been exceeded | 575 | _tiling_drag_ is set to _disable_. Once the threshold has been exceeded |
576 | once, the drag starts and the cursor can come back inside the threshold | 576 | once, the drag starts and the cursor can come back inside the threshold |
577 | without stopping the drag. _threshold_ is multiplied by the scale of the | 577 | without stopping the drag. _threshold_ is multiplied by the scale of the |
578 | output that the cursor on. The default is 9. | 578 | output that the cursor on. The default is 9. |
579 | 579 | ||
580 | *title\_align* left|center|right | 580 | *title_align* left|center|right |
581 | Sets the title alignment. If _right_ is selected and _show\_marks_ is set | 581 | Sets the title alignment. If _right_ is selected and _show_marks_ is set |
582 | to _yes_, the marks will be shown on the _left_ side instead of the | 582 | to _yes_, the marks will be shown on the _left_ side instead of the |
583 | _right_ side. | 583 | _right_ side. |
584 | 584 | ||
@@ -599,10 +599,10 @@ The default colors are: | |||
599 | Switches to the next workspace on the current output or on the next output | 599 | Switches to the next workspace on the current output or on the next output |
600 | if currently on the last workspace. | 600 | if currently on the last workspace. |
601 | 601 | ||
602 | *workspace* prev\_on\_output|next\_on\_output | 602 | *workspace* prev_on_output|next_on_output |
603 | Switches to the next workspace on the current output. | 603 | Switches to the next workspace on the current output. |
604 | 604 | ||
605 | *workspace* back\_and\_forth | 605 | *workspace* back_and_forth |
606 | Switches to the previously focused workspace. | 606 | Switches to the previously focused workspace. |
607 | 607 | ||
608 | *workspace* <name> gaps inner|outer|horizontal|vertical|top|right|bottom|left | 608 | *workspace* <name> gaps inner|outer|horizontal|vertical|top|right|bottom|left |
@@ -617,23 +617,23 @@ The default colors are: | |||
617 | is higher on the list becomes available, the workspace will be move to the | 617 | is higher on the list becomes available, the workspace will be move to the |
618 | higher priority output. | 618 | higher priority output. |
619 | 619 | ||
620 | *workspace\_auto\_back\_and\_forth* yes|no | 620 | *workspace_auto_back_and_forth* yes|no |
621 | When _yes_, repeating a workspace switch command will switch back to the | 621 | When _yes_, repeating a workspace switch command will switch back to the |
622 | prior workspace. For example, if you are currently on workspace 1, | 622 | prior workspace. For example, if you are currently on workspace 1, |
623 | switch to workspace 2, then invoke the "workspace 2" command again, you | 623 | switch to workspace 2, then invoke the "workspace 2" command again, you |
624 | will be returned to workspace 1. Default is _no_. | 624 | will be returned to workspace 1. Default is _no_. |
625 | 625 | ||
626 | *workspace\_layout* default|stacking|tabbed | 626 | *workspace_layout* default|stacking|tabbed |
627 | Specifies the initial layout for new workspaces. | 627 | Specifies the initial layout for new workspaces. |
628 | 628 | ||
629 | # BAR CONTROL | 629 | # BAR CONTROL |
630 | 630 | ||
631 | *bar hidden\_state* hide|show|toggle [<bar\_id>] | 631 | *bar hidden_state* hide|show|toggle [<bar_id>] |
632 | Sets the hidden state of the bar (see *sway-bar*(5)), either individually, | 632 | Sets the hidden state of the bar (see *sway-bar*(5)), either individually, |
633 | by specifying a bar id, or if none is given, for all bar instances. | 633 | by specifying a bar id, or if none is given, for all bar instances. |
634 | _toggle_ switches between _hide_ and _show_. | 634 | _toggle_ switches between _hide_ and _show_. |
635 | 635 | ||
636 | *bar mode* dock|hide|invisible|toggle [<bar\_id>] | 636 | *bar mode* dock|hide|invisible|toggle [<bar_id>] |
637 | Sets the mode of the bar (see *sway-bar*(5)), either individually, | 637 | Sets the mode of the bar (see *sway-bar*(5)), either individually, |
638 | by specifying a bar id, or if none is given, for all bar instances. | 638 | by specifying a bar id, or if none is given, for all bar instances. |
639 | _toggle_ switches between _dock_ and _hide_. | 639 | _toggle_ switches between _dock_ and _hide_. |
@@ -650,7 +650,7 @@ The string contains one or more (space separated) attribute/value pairs. They | |||
650 | are used by some commands to choose which views to execute actions on. All | 650 | are used by some commands to choose which views to execute actions on. All |
651 | attributes must match for the criteria to match. | 651 | attributes must match for the criteria to match. |
652 | 652 | ||
653 | Criteria may be used with either the *for\_window* or *assign* commands to | 653 | Criteria may be used with either the *for_window* or *assign* commands to |
654 | specify operations to perform on new views. A criteria may also be used to | 654 | specify operations to perform on new views. A criteria may also be used to |
655 | perform specific commands (ones that normally act upon one window) on all views | 655 | perform specific commands (ones that normally act upon one window) on all views |
656 | that match that criteria. For example: | 656 | that match that criteria. For example: |
@@ -675,7 +675,7 @@ Mark all Firefox windows with "Browser": | |||
675 | 675 | ||
676 | The following attributes may be matched with: | 676 | The following attributes may be matched with: |
677 | 677 | ||
678 | *app\_id* | 678 | *app_id* |
679 | Compare value against the app id. Can be a regular expression. If value is | 679 | Compare value against the app id. Can be a regular expression. If value is |
680 | \_\_focused\_\_, then the app id must be the same as that of the currently | 680 | \_\_focused\_\_, then the app id must be the same as that of the currently |
681 | focused window. | 681 | focused window. |
@@ -685,12 +685,12 @@ The following attributes may be matched with: | |||
685 | value is \_\_focused\_\_, then the window class must be the same as that of | 685 | value is \_\_focused\_\_, then the window class must be the same as that of |
686 | the currently focused window. | 686 | the currently focused window. |
687 | 687 | ||
688 | *con\_id* | 688 | *con_id* |
689 | Compare against the internal container ID, which you can find via IPC. If | 689 | Compare against the internal container ID, which you can find via IPC. If |
690 | value is \_\_focused\_\_, then the id must be the same as that of the | 690 | value is \_\_focused\_\_, then the id must be the same as that of the |
691 | currently focused window. | 691 | currently focused window. |
692 | 692 | ||
693 | *con\_mark* | 693 | *con_mark* |
694 | Compare against the window marks. Can be a regular expression. | 694 | Compare against the window marks. Can be a regular expression. |
695 | 695 | ||
696 | *floating* | 696 | *floating* |
@@ -705,7 +705,7 @@ The following attributes may be matched with: | |||
705 | of the currently focused window. | 705 | of the currently focused window. |
706 | 706 | ||
707 | *shell* | 707 | *shell* |
708 | Compare value against the window shell, such as "xdg\_shell" or "xwayland". | 708 | Compare value against the window shell, such as "xdg_shell" or "xwayland". |
709 | Can be a regular expression. If value is \_\_focused\_\_, then the shell | 709 | Can be a regular expression. If value is \_\_focused\_\_, then the shell |
710 | must be the same as that of the currently focused window. | 710 | must be the same as that of the currently focused window. |
711 | 711 | ||
@@ -721,15 +721,15 @@ The following attributes may be matched with: | |||
721 | Compares the urgent state of the window. Can be "first", "last", "latest", | 721 | Compares the urgent state of the window. Can be "first", "last", "latest", |
722 | "newest", "oldest" or "recent". | 722 | "newest", "oldest" or "recent". |
723 | 723 | ||
724 | *window\_role* | 724 | *window_role* |
725 | Compare against the window role (WM\_WINDOW\_ROLE). Can be a regular | 725 | Compare against the window role (WM_WINDOW_ROLE). Can be a regular |
726 | expression. If value is \_\_focused\_\_, then the window role must be the | 726 | expression. If value is \_\_focused\_\_, then the window role must be the |
727 | same as that of the currently focused window. | 727 | same as that of the currently focused window. |
728 | 728 | ||
729 | *window\_type* | 729 | *window_type* |
730 | Compare against the window type (\_NET\_WM\_WINDOW\_TYPE). Possible values | 730 | Compare against the window type (\_NET_WM_WINDOW_TYPE). Possible values |
731 | are normal, dialog, utility, toolbar, splash, menu, dropdown\_menu, | 731 | are normal, dialog, utility, toolbar, splash, menu, dropdown_menu, |
732 | popup\_menu, tooltip and notification. | 732 | popup_menu, tooltip and notification. |
733 | 733 | ||
734 | *workspace* | 734 | *workspace* |
735 | Compare against the workspace name for this view. Can be a regular | 735 | Compare against the workspace name for this view. Can be a regular |