summaryrefslogtreecommitdiff
path: root/sway/sway.5.scd
diff options
context:
space:
mode:
Diffstat (limited to 'sway/sway.5.scd')
-rw-r--r--sway/sway.5.scd101
1 files changed, 86 insertions, 15 deletions
diff --git a/sway/sway.5.scd b/sway/sway.5.scd
index bf936a27..15e60844 100644
--- a/sway/sway.5.scd
+++ b/sway/sway.5.scd
@@ -176,6 +176,12 @@ set|plus|minus|toggle <amount>
*layout* default|splith|splitv|stacking|tabbed
Sets the layout mode of the focused container.
+ When using the _stacking_ layout, only the focused window in the container is
+ displayed, with the opened windows' list on the top of the container.
+
+ The _tabbed_ layout is similar to _stacking_, but the windows’ list is vertically
+ split.
+
*layout* toggle [split|all]
Cycles the layout mode of the focused container though a preset list of
layouts. If no argument is given, then it cycles through stacking, tabbed
@@ -210,15 +216,14 @@ set|plus|minus|toggle <amount>
further details.
*move* left|right|up|down [<px> px]
- Moves the focused container in the direction specified. If the container,
- the optional _px_ argument specifies how many pixels to move the container.
- If unspecified, the default is 10 pixels. Pixels are ignored when moving
- tiled containers.
+ Moves the focused container in the direction specified. The optional _px_
+ argument specifies how many pixels to move the container. If unspecified,
+ the default is 10 pixels. Pixels are ignored when moving tiled containers.
*move* [absolute] position <pos_x> [px|ppt] <pos_y> [px|ppt]
Moves the focused container to the specified position in the workspace.
The position can be specified in pixels or percentage points, omitting
- the unit defaults to pixels. If _absolute_ is used, the position is
+ the unit defaults to pixels. If _absolute_ is used, the position is
relative to all outputs. _absolute_ can not be used with percentage points.
*move* [absolute] position center
@@ -482,6 +487,62 @@ runtime.
bindswitch lid:toggle exec echo "Lid moved"
```
+*bindgesture* [--exact] [--input-device=<device>] [--no-warn] \
+<gesture>[:<fingers>][:directions] <command>
+ Binds _gesture_ to execute the sway command _command_ when detected.
+ Currently supports the _hold_, _pinch_ or _swipe_ gesture. Optionally
+ can be limited to bind to a certain number of _fingers_ or, for a
+ _pinch_ or _swipe_ gesture, to certain _directions_.
+
+[[ *type*
+:[ *fingers*
+:< *direction*
+| hold
+:- 1 - 5
+: none
+| swipe
+: 3 - 5
+: up, down, left, right
+| pinch
+: 2 - 5
+: all above + inward, outward, clockwise, counterclockwise
+
+ The _fingers_ can be limited to any sensible number or left empty to accept
+ any finger counts.
+ Valid directions are _up_, _down_, _left_ and _right_, as well as _inward_,
+ _outward_, _clockwise_, _counterclockwise_ for the _pinch_ gesture.
+ Multiple directions can be combined by a plus.
+
+ If a _input-device_ is given, the binding will only be executed for
+ that input device and will be executed instead of any binding that is
+ generic to all devices. By default, if you overwrite a binding,
+ swaynag will give you a warning. To silence this, use the _--no-warn_ flag.
+
+ The _--exact_ flag can be used to ensure a binding only matches when exactly
+ all specified directions are matched and nothing more. If there is matching
+ binding with _--exact_, it will be preferred.
+
+ The priority for matching bindings is as follows: input device, then
+ exact matches followed by matches with the highest number of matching
+ directions.
+
+ Gestures executed while the pointer is above a bar are not handled by sway.
+ See the respective documentation, e.g. *bindgesture* in *sway-bar*(5).
+
+ Example:
+```
+ # Allow switching between workspaces with left and right swipes
+ bindgesture swipe:right workspace prev
+ bindgesture swipe:left workspace next
+
+ # Allow container movements by pinching them
+ bindgesture pinch:inward+up move up
+ bindgesture pinch:inward+down move down
+ bindgesture pinch:inward+left move left
+ bindgesture pinch:inward+right move right
+
+```
+
*client.background* <color>
This command is ignored and is only present for i3 compatibility.
@@ -632,11 +693,11 @@ The default colors are:
after switching between workspaces.
*focus_on_window_activation* smart|urgent|focus|none
- This option determines what to do when an xwayland client requests
- window activation. If set to _urgent_, the urgent state will be set
- for that window. If set to _focus_, the window will become focused.
- If set to _smart_, the window will become focused only if it is already
- visible, otherwise the urgent state will be set. Default is _urgent_.
+ This option determines what to do when a client requests window activation.
+ If set to _urgent_, the urgent state will be set for that window. If set to
+ _focus_, the window will become focused. If set to _smart_, the window will
+ become focused only if it is already visible, otherwise the urgent state
+ will be set. Default is _urgent_.
*focus_wrapping* yes|no|force|workspace
This option determines what to do when attempting to focus over the edge
@@ -805,6 +866,11 @@ The default colors are:
*unbindswitch* <switch>:<state>
Removes a binding for when <switch> changes to <state>.
+*unbindgesture* [--exact] [--input-device=<device>] \
+<gesture>[:<fingers>][:directions]
+ Removes a binding for the specified _gesture_, _fingers_
+ and _directions_ combination.
+
*unbindsym* [--whole-window] [--border] [--exclude-titlebar] [--release] [--locked] \
[--to-code] [--input-device=<device>] <key combo>
Removes the binding for _key combo_ that was previously bound with the
@@ -918,7 +984,8 @@ The following attributes may be matched with:
*class*
Compare value against the window class. Can be a regular expression. If
value is \_\_focused\_\_, then the window class must be the same as that of
- the currently focused window. _class_ are specific to X11 applications.
+ the currently focused window. _class_ are specific to X11 applications and
+ require XWayland.
*con_id*
Compare against the internal container ID, which you can find via IPC. If
@@ -932,12 +999,14 @@ The following attributes may be matched with:
Matches floating windows.
*id*
- Compare value against the X11 window ID. Must be numeric.
+ Compare value against the X11 window ID. Must be numeric. id is specific to
+ X11 applications and requires XWayland.
*instance*
Compare value against the window instance. Can be a regular expression. If
value is \_\_focused\_\_, then the window instance must be the same as that
- of the currently focused window.
+ of the currently focused window. instance is specific to X11 applications and
+ requires XWayland.
*pid*
Compare value against the window's process ID. Must be numeric.
@@ -962,12 +1031,14 @@ The following attributes may be matched with:
*window_role*
Compare against the window role (WM_WINDOW_ROLE). Can be a regular
expression. If value is \_\_focused\_\_, then the window role must be the
- same as that of the currently focused window.
+ same as that of the currently focused window. window_role is specific to X11
+ applications and requires XWayland.
*window_type*
Compare against the window type (\_NET_WM_WINDOW_TYPE). Possible values
are normal, dialog, utility, toolbar, splash, menu, dropdown_menu,
- popup_menu, tooltip and notification.
+ popup_menu, tooltip and notification. window_type is specific to X11
+ applications and requires XWayland.
*workspace*
Compare against the workspace name for this view. Can be a regular