diff options
Diffstat (limited to 'sway/sway.5.scd')
-rw-r--r-- | sway/sway.5.scd | 121 |
1 files changed, 101 insertions, 20 deletions
diff --git a/sway/sway.5.scd b/sway/sway.5.scd index 02592b5f..d8a462d3 100644 --- a/sway/sway.5.scd +++ b/sway/sway.5.scd | |||
@@ -155,7 +155,7 @@ They are expected to be used with *bindsym* or at runtime through *swaymsg*(1). | |||
155 | is specified, the view will be fullscreen across all outputs. | 155 | is specified, the view will be fullscreen across all outputs. |
156 | 156 | ||
157 | *gaps* inner|outer|horizontal|vertical|top|right|bottom|left all|current | 157 | *gaps* inner|outer|horizontal|vertical|top|right|bottom|left all|current |
158 | set|plus|minus <amount> | 158 | set|plus|minus|toggle <amount> |
159 | Changes the _inner_ or _outer_ gaps for either _all_ workspaces or the | 159 | Changes the _inner_ or _outer_ gaps for either _all_ workspaces or the |
160 | _current_ workspace. _outer_ gaps can be altered per side with _top_, | 160 | _current_ workspace. _outer_ gaps can be altered per side with _top_, |
161 | _right_, _bottom_, and _left_ or per direction with _horizontal_ and | 161 | _right_, _bottom_, and _left_ or per direction with _horizontal_ and |
@@ -176,6 +176,12 @@ set|plus|minus <amount> | |||
176 | *layout* default|splith|splitv|stacking|tabbed | 176 | *layout* default|splith|splitv|stacking|tabbed |
177 | Sets the layout mode of the focused container. | 177 | Sets the layout mode of the focused container. |
178 | 178 | ||
179 | When using the _stacking_ layout, only the focused window in the container is | ||
180 | displayed, with the opened windows' list on the top of the container. | ||
181 | |||
182 | The _tabbed_ layout is similar to _stacking_, but the windows’ list is vertically | ||
183 | split. | ||
184 | |||
179 | *layout* toggle [split|all] | 185 | *layout* toggle [split|all] |
180 | Cycles the layout mode of the focused container though a preset list of | 186 | Cycles the layout mode of the focused container though a preset list of |
181 | layouts. If no argument is given, then it cycles through stacking, tabbed | 187 | layouts. If no argument is given, then it cycles through stacking, tabbed |
@@ -210,15 +216,14 @@ set|plus|minus <amount> | |||
210 | further details. | 216 | further details. |
211 | 217 | ||
212 | *move* left|right|up|down [<px> px] | 218 | *move* left|right|up|down [<px> px] |
213 | Moves the focused container in the direction specified. If the container, | 219 | Moves the focused container in the direction specified. The optional _px_ |
214 | the optional _px_ argument specifies how many pixels to move the container. | 220 | argument specifies how many pixels to move the container. If unspecified, |
215 | If unspecified, the default is 10 pixels. Pixels are ignored when moving | 221 | the default is 10 pixels. Pixels are ignored when moving tiled containers. |
216 | tiled containers. | ||
217 | 222 | ||
218 | *move* [absolute] position <pos_x> [px|ppt] <pos_y> [px|ptt] | 223 | *move* [absolute] position <pos_x> [px|ppt] <pos_y> [px|ppt] |
219 | Moves the focused container to the specified position in the workspace. | 224 | Moves the focused container to the specified position in the workspace. |
220 | The position can be specified in pixels or percentage points, omitting | 225 | The position can be specified in pixels or percentage points, omitting |
221 | the unit defaults to pixels. If _absolute_ is used, the position is | 226 | the unit defaults to pixels. If _absolute_ is used, the position is |
222 | relative to all outputs. _absolute_ can not be used with percentage points. | 227 | relative to all outputs. _absolute_ can not be used with percentage points. |
223 | 228 | ||
224 | *move* [absolute] position center | 229 | *move* [absolute] position center |
@@ -319,8 +324,10 @@ set|plus|minus <amount> | |||
319 | established by the *seat* subcommand of the same name. See | 324 | established by the *seat* subcommand of the same name. See |
320 | *sway-input*(5) for more ways to affect inhibitors. | 325 | *sway-input*(5) for more ways to affect inhibitors. |
321 | 326 | ||
322 | *split* vertical|v|horizontal|h|toggle|t | 327 | *split* vertical|v|horizontal|h|none|n|toggle|t |
323 | Splits the current container, vertically or horizontally. When _toggle_ is | 328 | Splits the current container, vertically or horizontally. When _none_ is |
329 | specified, the effect of a previous split is undone if the current | ||
330 | container is the only child of a split parent. When _toggle_ is | ||
324 | specified, the current container is split opposite to the parent | 331 | specified, the current container is split opposite to the parent |
325 | container's layout. | 332 | container's layout. |
326 | 333 | ||
@@ -404,7 +411,7 @@ runtime. | |||
404 | a keyboard shortcuts inhibitor is active for the currently focused | 411 | a keyboard shortcuts inhibitor is active for the currently focused |
405 | window. Such inhibitors are usually requested by remote desktop and | 412 | window. Such inhibitors are usually requested by remote desktop and |
406 | virtualization software to enable the user to send keyboard shortcuts | 413 | virtualization software to enable the user to send keyboard shortcuts |
407 | to the remote or virtual session. The _--inhibited_ flag allows to | 414 | to the remote or virtual session. The _--inhibited_ flag allows one to |
408 | define bindings which will be exempt from pass-through to such | 415 | define bindings which will be exempt from pass-through to such |
409 | software. The same preference logic as for _--locked_ applies. | 416 | software. The same preference logic as for _--locked_ applies. |
410 | 417 | ||
@@ -480,6 +487,62 @@ runtime. | |||
480 | bindswitch lid:toggle exec echo "Lid moved" | 487 | bindswitch lid:toggle exec echo "Lid moved" |
481 | ``` | 488 | ``` |
482 | 489 | ||
490 | *bindgesture* [--exact] [--input-device=<device>] [--no-warn] \ | ||
491 | <gesture>[:<fingers>][:directions] <command> | ||
492 | Binds _gesture_ to execute the sway command _command_ when detected. | ||
493 | Currently supports the _hold_, _pinch_ or _swipe_ gesture. Optionally | ||
494 | can be limited to bind to a certain number of _fingers_ or, for a | ||
495 | _pinch_ or _swipe_ gesture, to certain _directions_. | ||
496 | |||
497 | [[ *type* | ||
498 | :[ *fingers* | ||
499 | :< *direction* | ||
500 | | hold | ||
501 | :- 1 - 5 | ||
502 | : none | ||
503 | | swipe | ||
504 | : 3 - 5 | ||
505 | : up, down, left, right | ||
506 | | pinch | ||
507 | : 2 - 5 | ||
508 | : all above + inward, outward, clockwise, counterclockwise | ||
509 | |||
510 | The _fingers_ can be limited to any sensible number or left empty to accept | ||
511 | any finger counts. | ||
512 | Valid directions are _up_, _down_, _left_ and _right_, as well as _inward_, | ||
513 | _outward_, _clockwise_, _counterclockwise_ for the _pinch_ gesture. | ||
514 | Multiple directions can be combined by a plus. | ||
515 | |||
516 | If a _input-device_ is given, the binding will only be executed for | ||
517 | that input device and will be executed instead of any binding that is | ||
518 | generic to all devices. By default, if you overwrite a binding, | ||
519 | swaynag will give you a warning. To silence this, use the _--no-warn_ flag. | ||
520 | |||
521 | The _--exact_ flag can be used to ensure a binding only matches when exactly | ||
522 | all specified directions are matched and nothing more. If there is matching | ||
523 | binding with _--exact_, it will be preferred. | ||
524 | |||
525 | The priority for matching bindings is as follows: input device, then | ||
526 | exact matches followed by matches with the highest number of matching | ||
527 | directions. | ||
528 | |||
529 | Gestures executed while the pointer is above a bar are not handled by sway. | ||
530 | See the respective documentation, e.g. *bindgesture* in *sway-bar*(5). | ||
531 | |||
532 | Example: | ||
533 | ``` | ||
534 | # Allow switching between workspaces with left and right swipes | ||
535 | bindgesture swipe:right workspace prev | ||
536 | bindgesture swipe:left workspace next | ||
537 | |||
538 | # Allow container movements by pinching them | ||
539 | bindgesture pinch:inward+up move up | ||
540 | bindgesture pinch:inward+down move down | ||
541 | bindgesture pinch:inward+left move left | ||
542 | bindgesture pinch:inward+right move right | ||
543 | |||
544 | ``` | ||
545 | |||
483 | *client.background* <color> | 546 | *client.background* <color> |
484 | This command is ignored and is only present for i3 compatibility. | 547 | This command is ignored and is only present for i3 compatibility. |
485 | 548 | ||
@@ -497,6 +560,12 @@ runtime. | |||
497 | *client.focused_inactive* | 560 | *client.focused_inactive* |
498 | The most recently focused view within a container which is not focused. | 561 | The most recently focused view within a container which is not focused. |
499 | 562 | ||
563 | *client.focused_tab_title* | ||
564 | A view that has focused descendant container. | ||
565 | Tab or stack container title that is the parent of the focused container | ||
566 | but is not directly focused. Defaults to focused_inactive if not | ||
567 | specified and does not use the indicator and child_border colors. | ||
568 | |||
500 | *client.placeholder* | 569 | *client.placeholder* |
501 | Ignored (present for i3 compatibility). | 570 | Ignored (present for i3 compatibility). |
502 | 571 | ||
@@ -552,6 +621,12 @@ The default colors are: | |||
552 | : #ffffff | 621 | : #ffffff |
553 | : #484e50 | 622 | : #484e50 |
554 | : #5f676a | 623 | : #5f676a |
624 | | *focused_tab_title* | ||
625 | : #333333 | ||
626 | : #5f676a | ||
627 | : #ffffff | ||
628 | : n/a | ||
629 | : n/a | ||
555 | | *unfocused* | 630 | | *unfocused* |
556 | : #333333 | 631 | : #333333 |
557 | : #222222 | 632 | : #222222 |
@@ -606,11 +681,11 @@ The default colors are: | |||
606 | after switching between workspaces. | 681 | after switching between workspaces. |
607 | 682 | ||
608 | *focus_on_window_activation* smart|urgent|focus|none | 683 | *focus_on_window_activation* smart|urgent|focus|none |
609 | This option determines what to do when an xwayland client requests | 684 | This option determines what to do when a client requests window activation. |
610 | window activation. If set to _urgent_, the urgent state will be set | 685 | If set to _urgent_, the urgent state will be set for that window. If set to |
611 | for that window. If set to _focus_, the window will become focused. | 686 | _focus_, the window will become focused. If set to _smart_, the window will |
612 | If set to _smart_, the window will become focused only if it is already | 687 | become focused only if it is already visible, otherwise the urgent state |
613 | visible, otherwise the urgent state will be set. Default is _urgent_. | 688 | will be set. Default is _urgent_. |
614 | 689 | ||
615 | *focus_wrapping* yes|no|force|workspace | 690 | *focus_wrapping* yes|no|force|workspace |
616 | This option determines what to do when attempting to focus over the edge | 691 | This option determines what to do when attempting to focus over the edge |
@@ -630,14 +705,14 @@ The default colors are: | |||
630 | should be used instead. Regardless of whether pango markup is enabled, | 705 | should be used instead. Regardless of whether pango markup is enabled, |
631 | _font_ should be specified as a pango font description. For more | 706 | _font_ should be specified as a pango font description. For more |
632 | information on pango font descriptions, see | 707 | information on pango font descriptions, see |
633 | https://developer.gnome.org/pango/stable/pango-Fonts.html#pango-font-description-from-string | 708 | https://docs.gtk.org/Pango/type_func.FontDescription.from_string.html#description |
634 | 709 | ||
635 | *force_display_urgency_hint* <timeout> [ms] | 710 | *force_display_urgency_hint* <timeout> [ms] |
636 | If an application on another workspace sets an urgency hint, switching to this | 711 | If an application on another workspace sets an urgency hint, switching to this |
637 | workspace may lead to immediate focus of the application, which also means the | 712 | workspace may lead to immediate focus of the application, which also means the |
638 | window decoration color would be immediately resetted to *client.focused*. This | 713 | window decoration color would be immediately reset to *client.focused*. This |
639 | may make it unnecessarily hard to tell which window originally raised the | 714 | may make it unnecessarily hard to tell which window originally raised the |
640 | event. This option allows to set a _timeout_ in ms to delay the urgency hint reset. | 715 | event. This option allows one to set a _timeout_ in ms to delay the urgency hint reset. |
641 | 716 | ||
642 | *titlebar_border_thickness* <thickness> | 717 | *titlebar_border_thickness* <thickness> |
643 | Thickness of the titlebar border in pixels | 718 | Thickness of the titlebar border in pixels |
@@ -690,9 +765,10 @@ The default colors are: | |||
690 | borders will only be enabled if the workspace has more than one visible | 765 | borders will only be enabled if the workspace has more than one visible |
691 | child and gaps equal to zero. | 766 | child and gaps equal to zero. |
692 | 767 | ||
693 | *smart_gaps* on|off | 768 | *smart_gaps* on|off|toggle|inverse_outer |
694 | If smart_gaps are _on_ gaps will only be enabled if a workspace has more | 769 | If smart_gaps are _on_ gaps will only be enabled if a workspace has more |
695 | than one child. | 770 | than one child. If smart_gaps are _inverse_outer_ outer gaps will only |
771 | be enabled if a workspace has exactly one child. | ||
696 | 772 | ||
697 | *mark* --add|--replace [--toggle] <identifier> | 773 | *mark* --add|--replace [--toggle] <identifier> |
698 | Marks are arbitrary labels that can be used to identify certain windows and | 774 | Marks are arbitrary labels that can be used to identify certain windows and |
@@ -771,6 +847,11 @@ The default colors are: | |||
771 | *unbindswitch* <switch>:<state> | 847 | *unbindswitch* <switch>:<state> |
772 | Removes a binding for when <switch> changes to <state>. | 848 | Removes a binding for when <switch> changes to <state>. |
773 | 849 | ||
850 | *unbindgesture* [--exact] [--input-device=<device>] \ | ||
851 | <gesture>[:<fingers>][:directions] | ||
852 | Removes a binding for the specified _gesture_, _fingers_ | ||
853 | and _directions_ combination. | ||
854 | |||
774 | *unbindsym* [--whole-window] [--border] [--exclude-titlebar] [--release] [--locked] \ | 855 | *unbindsym* [--whole-window] [--border] [--exclude-titlebar] [--release] [--locked] \ |
775 | [--to-code] [--input-device=<device>] <key combo> | 856 | [--to-code] [--input-device=<device>] <key combo> |
776 | Removes the binding for _key combo_ that was previously bound with the | 857 | Removes the binding for _key combo_ that was previously bound with the |