diff options
Diffstat (limited to 'sway/sway.5.scd')
-rw-r--r-- | sway/sway.5.scd | 157 |
1 files changed, 129 insertions, 28 deletions
diff --git a/sway/sway.5.scd b/sway/sway.5.scd index 8958c7e3..9f823947 100644 --- a/sway/sway.5.scd +++ b/sway/sway.5.scd | |||
@@ -176,6 +176,12 @@ set|plus|minus|toggle <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|toggle <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|toggle <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 | ||
@@ -382,8 +389,8 @@ runtime. | |||
382 | for_window <criteria> move container to output <output> | 389 | for_window <criteria> move container to output <output> |
383 | 390 | ||
384 | *bindsym* [--whole-window] [--border] [--exclude-titlebar] [--release] [--locked] \ | 391 | *bindsym* [--whole-window] [--border] [--exclude-titlebar] [--release] [--locked] \ |
385 | [--to-code] [--input-device=<device>] [--no-warn] [--no-repeat] [Group<1-4>+]<key combo> \ | 392 | [--to-code] [--input-device=<device>] [--no-warn] [--no-repeat] [--inhibited] \ |
386 | <command> | 393 | [Group<1-4>+]<key combo> <command> |
387 | Binds _key combo_ to execute the sway command _command_ when pressed. You | 394 | Binds _key combo_ to execute the sway command _command_ when pressed. You |
388 | may use XKB key names here (*wev*(1) is a good tool for discovering these). | 395 | may use XKB key names here (*wev*(1) is a good tool for discovering these). |
389 | With the flag _--release_, the command is executed when the key combo is | 396 | With the flag _--release_, the command is executed when the key combo is |
@@ -393,6 +400,12 @@ runtime. | |||
393 | only be available for that group. By default, if you overwrite a binding, | 400 | only be available for that group. By default, if you overwrite a binding, |
394 | swaynag will give you a warning. To silence this, use the _--no-warn_ flag. | 401 | swaynag will give you a warning. To silence this, use the _--no-warn_ flag. |
395 | 402 | ||
403 | For specifying modifier keys, you can use the XKB modifier names _Shift_, | ||
404 | _Lock_ (for Caps Lock), _Control_, _Mod1_ (for Alt), _Mod2_ (for Num Lock), | ||
405 | _Mod3_ (for XKB modifier Mod3), _Mod4_ (for the Logo key), and _Mod5_ (for | ||
406 | AltGr). In addition, you can use the aliases _Ctrl_ (for Control), _Alt_ | ||
407 | (for Alt), and _Super_ (for the Logo key). | ||
408 | |||
396 | Unless the flag _--locked_ is set, the command will not be run when a | 409 | Unless the flag _--locked_ is set, the command will not be run when a |
397 | screen locking program is active. If there is a matching binding with | 410 | screen locking program is active. If there is a matching binding with |
398 | and without _--locked_, the one with will be preferred when locked and the | 411 | and without _--locked_, the one with will be preferred when locked and the |
@@ -404,7 +417,7 @@ runtime. | |||
404 | a keyboard shortcuts inhibitor is active for the currently focused | 417 | a keyboard shortcuts inhibitor is active for the currently focused |
405 | window. Such inhibitors are usually requested by remote desktop and | 418 | window. Such inhibitors are usually requested by remote desktop and |
406 | virtualization software to enable the user to send keyboard shortcuts | 419 | virtualization software to enable the user to send keyboard shortcuts |
407 | to the remote or virtual session. The _--inhibited_ flag allows to | 420 | to the remote or virtual session. The _--inhibited_ flag allows one to |
408 | define bindings which will be exempt from pass-through to such | 421 | define bindings which will be exempt from pass-through to such |
409 | software. The same preference logic as for _--locked_ applies. | 422 | software. The same preference logic as for _--locked_ applies. |
410 | 423 | ||
@@ -447,7 +460,8 @@ runtime. | |||
447 | ``` | 460 | ``` |
448 | 461 | ||
449 | *bindcode* [--whole-window] [--border] [--exclude-titlebar] [--release] \ | 462 | *bindcode* [--whole-window] [--border] [--exclude-titlebar] [--release] \ |
450 | [--locked] [--input-device=<device>] [--no-warn] [Group<1-4>+]<code> <command> | 463 | [--locked] [--input-device=<device>] [--no-warn] [--no-repeat] [--inhibited] \ |
464 | [Group<1-4>+]<code> <command> | ||
451 | is also available for binding with key/button codes instead of key/button names. | 465 | is also available for binding with key/button codes instead of key/button names. |
452 | 466 | ||
453 | *bindswitch* [--locked] [--no-warn] [--reload] <switch>:<state> <command> | 467 | *bindswitch* [--locked] [--no-warn] [--reload] <switch>:<state> <command> |
@@ -480,6 +494,62 @@ runtime. | |||
480 | bindswitch lid:toggle exec echo "Lid moved" | 494 | bindswitch lid:toggle exec echo "Lid moved" |
481 | ``` | 495 | ``` |
482 | 496 | ||
497 | *bindgesture* [--exact] [--input-device=<device>] [--no-warn] \ | ||
498 | <gesture>[:<fingers>][:directions] <command> | ||
499 | Binds _gesture_ to execute the sway command _command_ when detected. | ||
500 | Currently supports the _hold_, _pinch_ or _swipe_ gesture. Optionally | ||
501 | can be limited to bind to a certain number of _fingers_ or, for a | ||
502 | _pinch_ or _swipe_ gesture, to certain _directions_. | ||
503 | |||
504 | [[ *type* | ||
505 | :[ *fingers* | ||
506 | :< *direction* | ||
507 | | hold | ||
508 | :- 1 - 5 | ||
509 | : none | ||
510 | | swipe | ||
511 | : 3 - 5 | ||
512 | : up, down, left, right | ||
513 | | pinch | ||
514 | : 2 - 5 | ||
515 | : all above + inward, outward, clockwise, counterclockwise | ||
516 | |||
517 | The _fingers_ can be limited to any sensible number or left empty to accept | ||
518 | any finger counts. | ||
519 | Valid directions are _up_, _down_, _left_ and _right_, as well as _inward_, | ||
520 | _outward_, _clockwise_, _counterclockwise_ for the _pinch_ gesture. | ||
521 | Multiple directions can be combined by a plus. | ||
522 | |||
523 | If a _input-device_ is given, the binding will only be executed for | ||
524 | that input device and will be executed instead of any binding that is | ||
525 | generic to all devices. By default, if you overwrite a binding, | ||
526 | swaynag will give you a warning. To silence this, use the _--no-warn_ flag. | ||
527 | |||
528 | The _--exact_ flag can be used to ensure a binding only matches when exactly | ||
529 | all specified directions are matched and nothing more. If there is matching | ||
530 | binding with _--exact_, it will be preferred. | ||
531 | |||
532 | The priority for matching bindings is as follows: input device, then | ||
533 | exact matches followed by matches with the highest number of matching | ||
534 | directions. | ||
535 | |||
536 | Gestures executed while the pointer is above a bar are not handled by sway. | ||
537 | See the respective documentation, e.g. *bindgesture* in *sway-bar*(5). | ||
538 | |||
539 | Example: | ||
540 | ``` | ||
541 | # Allow switching between workspaces with left and right swipes | ||
542 | bindgesture swipe:right workspace prev | ||
543 | bindgesture swipe:left workspace next | ||
544 | |||
545 | # Allow container movements by pinching them | ||
546 | bindgesture pinch:inward+up move up | ||
547 | bindgesture pinch:inward+down move down | ||
548 | bindgesture pinch:inward+left move left | ||
549 | bindgesture pinch:inward+right move right | ||
550 | |||
551 | ``` | ||
552 | |||
483 | *client.background* <color> | 553 | *client.background* <color> |
484 | This command is ignored and is only present for i3 compatibility. | 554 | This command is ignored and is only present for i3 compatibility. |
485 | 555 | ||
@@ -497,6 +567,12 @@ runtime. | |||
497 | *client.focused_inactive* | 567 | *client.focused_inactive* |
498 | The most recently focused view within a container which is not focused. | 568 | The most recently focused view within a container which is not focused. |
499 | 569 | ||
570 | *client.focused_tab_title* | ||
571 | A view that has focused descendant container. | ||
572 | Tab or stack container title that is the parent of the focused container | ||
573 | but is not directly focused. Defaults to focused_inactive if not | ||
574 | specified and does not use the indicator and child_border colors. | ||
575 | |||
500 | *client.placeholder* | 576 | *client.placeholder* |
501 | Ignored (present for i3 compatibility). | 577 | Ignored (present for i3 compatibility). |
502 | 578 | ||
@@ -552,6 +628,12 @@ The default colors are: | |||
552 | : #ffffff | 628 | : #ffffff |
553 | : #484e50 | 629 | : #484e50 |
554 | : #5f676a | 630 | : #5f676a |
631 | | *focused_tab_title* | ||
632 | : #333333 | ||
633 | : #5f676a | ||
634 | : #ffffff | ||
635 | : n/a | ||
636 | : n/a | ||
555 | | *unfocused* | 637 | | *unfocused* |
556 | : #333333 | 638 | : #333333 |
557 | : #222222 | 639 | : #222222 |
@@ -573,7 +655,8 @@ The default colors are: | |||
573 | 655 | ||
574 | 656 | ||
575 | *default_border* normal|none|pixel [<n>] | 657 | *default_border* normal|none|pixel [<n>] |
576 | Set default border style for new tiled windows. | 658 | Set default border style for new tiled windows. Config reload won't affect |
659 | existing windows, only newly created ones after the reload. | ||
577 | 660 | ||
578 | *default_floating_border* normal|none|pixel [<n>] | 661 | *default_floating_border* normal|none|pixel [<n>] |
579 | Set default border style for new floating windows. This only applies to | 662 | Set default border style for new floating windows. This only applies to |
@@ -606,11 +689,11 @@ The default colors are: | |||
606 | after switching between workspaces. | 689 | after switching between workspaces. |
607 | 690 | ||
608 | *focus_on_window_activation* smart|urgent|focus|none | 691 | *focus_on_window_activation* smart|urgent|focus|none |
609 | This option determines what to do when an xwayland client requests | 692 | 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 | 693 | 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. | 694 | _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 | 695 | become focused only if it is already visible, otherwise the urgent state |
613 | visible, otherwise the urgent state will be set. Default is _urgent_. | 696 | will be set. Default is _urgent_. |
614 | 697 | ||
615 | *focus_wrapping* yes|no|force|workspace | 698 | *focus_wrapping* yes|no|force|workspace |
616 | This option determines what to do when attempting to focus over the edge | 699 | This option determines what to do when attempting to focus over the edge |
@@ -630,14 +713,14 @@ The default colors are: | |||
630 | should be used instead. Regardless of whether pango markup is enabled, | 713 | should be used instead. Regardless of whether pango markup is enabled, |
631 | _font_ should be specified as a pango font description. For more | 714 | _font_ should be specified as a pango font description. For more |
632 | information on pango font descriptions, see | 715 | information on pango font descriptions, see |
633 | https://developer.gnome.org/pango/stable/pango-Fonts.html#pango-font-description-from-string | 716 | https://docs.gtk.org/Pango/type_func.FontDescription.from_string.html#description |
634 | 717 | ||
635 | *force_display_urgency_hint* <timeout> [ms] | 718 | *force_display_urgency_hint* <timeout> [ms] |
636 | If an application on another workspace sets an urgency hint, switching to this | 719 | 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 | 720 | 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 | 721 | window decoration color would be immediately reset to *client.focused*. This |
639 | may make it unnecessarily hard to tell which window originally raised the | 722 | 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. | 723 | event. This option allows one to set a _timeout_ in ms to delay the urgency hint reset. |
641 | 724 | ||
642 | *titlebar_border_thickness* <thickness> | 725 | *titlebar_border_thickness* <thickness> |
643 | Thickness of the titlebar border in pixels | 726 | Thickness of the titlebar border in pixels |
@@ -690,9 +773,10 @@ The default colors are: | |||
690 | borders will only be enabled if the workspace has more than one visible | 773 | borders will only be enabled if the workspace has more than one visible |
691 | child and gaps equal to zero. | 774 | child and gaps equal to zero. |
692 | 775 | ||
693 | *smart_gaps* on|off | 776 | *smart_gaps* on|off|toggle|inverse_outer |
694 | If smart_gaps are _on_ gaps will only be enabled if a workspace has more | 777 | If smart_gaps are _on_ gaps will only be enabled if a workspace has more |
695 | than one child. | 778 | than one child. If smart_gaps are _inverse_outer_ outer gaps will only |
779 | be enabled if a workspace has exactly one child. | ||
696 | 780 | ||
697 | *mark* --add|--replace [--toggle] <identifier> | 781 | *mark* --add|--replace [--toggle] <identifier> |
698 | Marks are arbitrary labels that can be used to identify certain windows and | 782 | Marks are arbitrary labels that can be used to identify certain windows and |
@@ -731,6 +815,10 @@ The default colors are: | |||
731 | dialog will not be rendered. If _leave_fullscreen_, the view will exit | 815 | dialog will not be rendered. If _leave_fullscreen_, the view will exit |
732 | fullscreen mode and the dialog will be rendered. | 816 | fullscreen mode and the dialog will be rendered. |
733 | 817 | ||
818 | *primary_selection* enabled|disabled | ||
819 | Enable or disable the primary selection clipboard. May only be configured | ||
820 | at launch. Default is _enabled_. | ||
821 | |||
734 | *set* $<name> <value> | 822 | *set* $<name> <value> |
735 | Sets variable $_name_ to _value_. You can use the new variable in the | 823 | Sets variable $_name_ to _value_. You can use the new variable in the |
736 | arguments of future commands. When the variable is used, it can be escaped | 824 | arguments of future commands. When the variable is used, it can be escaped |
@@ -771,6 +859,11 @@ The default colors are: | |||
771 | *unbindswitch* <switch>:<state> | 859 | *unbindswitch* <switch>:<state> |
772 | Removes a binding for when <switch> changes to <state>. | 860 | Removes a binding for when <switch> changes to <state>. |
773 | 861 | ||
862 | *unbindgesture* [--exact] [--input-device=<device>] \ | ||
863 | <gesture>[:<fingers>][:directions] | ||
864 | Removes a binding for the specified _gesture_, _fingers_ | ||
865 | and _directions_ combination. | ||
866 | |||
774 | *unbindsym* [--whole-window] [--border] [--exclude-titlebar] [--release] [--locked] \ | 867 | *unbindsym* [--whole-window] [--border] [--exclude-titlebar] [--release] [--locked] \ |
775 | [--to-code] [--input-device=<device>] <key combo> | 868 | [--to-code] [--input-device=<device>] <key combo> |
776 | Removes the binding for _key combo_ that was previously bound with the | 869 | Removes the binding for _key combo_ that was previously bound with the |
@@ -876,6 +969,9 @@ properties in practice for your applications. | |||
876 | 969 | ||
877 | The following attributes may be matched with: | 970 | The following attributes may be matched with: |
878 | 971 | ||
972 | *all* | ||
973 | Matches all windows. | ||
974 | |||
879 | *app_id* | 975 | *app_id* |
880 | Compare value against the app id. Can be a regular expression. If value is | 976 | Compare value against the app id. Can be a regular expression. If value is |
881 | \_\_focused\_\_, then the app id must be the same as that of the currently | 977 | \_\_focused\_\_, then the app id must be the same as that of the currently |
@@ -884,7 +980,8 @@ The following attributes may be matched with: | |||
884 | *class* | 980 | *class* |
885 | Compare value against the window class. Can be a regular expression. If | 981 | Compare value against the window class. Can be a regular expression. If |
886 | value is \_\_focused\_\_, then the window class must be the same as that of | 982 | value is \_\_focused\_\_, then the window class must be the same as that of |
887 | the currently focused window. _class_ are specific to X11 applications. | 983 | the currently focused window. _class_ are specific to X11 applications and |
984 | require XWayland. | ||
888 | 985 | ||
889 | *con_id* | 986 | *con_id* |
890 | Compare against the internal container ID, which you can find via IPC. If | 987 | Compare against the internal container ID, which you can find via IPC. If |
@@ -898,12 +995,14 @@ The following attributes may be matched with: | |||
898 | Matches floating windows. | 995 | Matches floating windows. |
899 | 996 | ||
900 | *id* | 997 | *id* |
901 | Compare value against the X11 window ID. Must be numeric. | 998 | Compare value against the X11 window ID. Must be numeric. id is specific to |
999 | X11 applications and requires XWayland. | ||
902 | 1000 | ||
903 | *instance* | 1001 | *instance* |
904 | Compare value against the window instance. Can be a regular expression. If | 1002 | Compare value against the window instance. Can be a regular expression. If |
905 | value is \_\_focused\_\_, then the window instance must be the same as that | 1003 | value is \_\_focused\_\_, then the window instance must be the same as that |
906 | of the currently focused window. | 1004 | of the currently focused window. instance is specific to X11 applications and |
1005 | requires XWayland. | ||
907 | 1006 | ||
908 | *pid* | 1007 | *pid* |
909 | Compare value against the window's process ID. Must be numeric. | 1008 | Compare value against the window's process ID. Must be numeric. |
@@ -928,12 +1027,14 @@ The following attributes may be matched with: | |||
928 | *window_role* | 1027 | *window_role* |
929 | Compare against the window role (WM_WINDOW_ROLE). Can be a regular | 1028 | Compare against the window role (WM_WINDOW_ROLE). Can be a regular |
930 | expression. If value is \_\_focused\_\_, then the window role must be the | 1029 | expression. If value is \_\_focused\_\_, then the window role must be the |
931 | same as that of the currently focused window. | 1030 | same as that of the currently focused window. window_role is specific to X11 |
1031 | applications and requires XWayland. | ||
932 | 1032 | ||
933 | *window_type* | 1033 | *window_type* |
934 | Compare against the window type (\_NET_WM_WINDOW_TYPE). Possible values | 1034 | Compare against the window type (\_NET_WM_WINDOW_TYPE). Possible values |
935 | are normal, dialog, utility, toolbar, splash, menu, dropdown_menu, | 1035 | are normal, dialog, utility, toolbar, splash, menu, dropdown_menu, |
936 | popup_menu, tooltip and notification. | 1036 | popup_menu, tooltip and notification. window_type is specific to X11 |
1037 | applications and requires XWayland. | ||
937 | 1038 | ||
938 | *workspace* | 1039 | *workspace* |
939 | Compare against the workspace name for this view. Can be a regular | 1040 | Compare against the workspace name for this view. Can be a regular |