summaryrefslogtreecommitdiffstats
path: root/sway/sway.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'sway/sway.5.txt')
-rw-r--r--sway/sway.5.txt75
1 files changed, 51 insertions, 24 deletions
diff --git a/sway/sway.5.txt b/sway/sway.5.txt
index 750254c8..03975349 100644
--- a/sway/sway.5.txt
+++ b/sway/sway.5.txt
@@ -43,6 +43,9 @@ The following commands may only be used in the configuration file.
43 Sets variable $name to _value_. You can use the new variable in the arguments 43 Sets variable $name to _value_. You can use the new variable in the arguments
44 of future commands. 44 of future commands.
45 45
46**swaybg_command** <command>::
47 Executes custom bg command, default is _swaybg_.
48
46The following commands cannot be used directly in the configuration file. 49The following commands cannot be used directly in the configuration file.
47They are expected to be used with **bindsym** or at runtime through **swaymsg**(1). 50They are expected to be used with **bindsym** or at runtime through **swaymsg**(1).
48 51
@@ -126,22 +129,21 @@ They are expected to be used with **bindsym** or at runtime through **swaymsg**(
126 129
127**resize** <shrink|grow> <width|height> [<amount>] [px|ppt]:: 130**resize** <shrink|grow> <width|height> [<amount>] [px|ppt]::
128 Resizes the currently focused container or view by _amount_. _amount_ is 131 Resizes the currently focused container or view by _amount_. _amount_ is
129 optional: the default value is 10 (either px or ppt depending on the view 132 optional: the default value is 10 (either px or ppt depending on the view type).
130 type). The [px|ppt] parameter is optional. _px_ specifies that _amount_ refers 133 The [px|ppt] parameter is optional. _px_ specifies that _amount_ refers to pixels;
131 to pixels; _ppt_ specifies that _amount_ refers to percentage points of the 134 _ppt_ specifies that _amount_ refers to percentage points of the current
132 current dimension. Floating views use px dimensions by default (but can use 135 size. Floating views use px by default (but can use ppt if specified); tiled
133 ppt if specified); tiled views use ppt dimensions by default (but can use px 136 views use ppt by default (but can use px if specified).
134 if specified).
135 137
136**resize set** <width> [px] <height> [px]:: 138**resize set** <width> [px] <height> [px]::
137 Sets the width and height of the currently focused container to _width_ pixels 139 Sets the width and height of the currently focused container to _width_ pixels
138 and _height_ pixels. The [px] parameters are optional and have no effect. This 140 and _height_ pixels. The [px] parameters are optional and have no effect. This
139 command only accepts pixel dimensions. 141 command only accepts a size in pixels.
140 142
141**resize set** <width|height> <amount> [px] [<width|height> <amount> [px]]:: 143**resize set** <width|height> <amount> [px] [<width|height> <amount> [px]]::
142 Sets the _width_ and/or _height_ of the currently focused container to 144 Sets the _width_ and/or _height_ of the currently focused container to
143 _amount_. The [px] parameters are optional and have no effect. This command 145 _amount_. The [px] parameters are optional and have no effect. This command
144 only accepts pixel dimensions. 146 only accepts a size in pixels.
145 147
146**scratchpad show**:: 148**scratchpad show**::
147 Shows a window from the scratchpad. Repeatedly using this command will cycle 149 Shows a window from the scratchpad. Repeatedly using this command will cycle
@@ -254,14 +256,14 @@ The default colors are:
254 *restart* is executed. 256 *restart* is executed.
255 257
256**floating_maximum_size** <width> x <height>:: 258**floating_maximum_size** <width> x <height>::
257 Specifies the maximum dimensions of floating windows. 259 Specifies the maximum size of floating windows.
258 Uses the container dimensions as default. 260 Uses the container size as default.
259 -1 x -1 will remove any restriction on dimensions. 261 -1 x -1 will remove any restriction on size.
260 0 x 0 has the same behavior as not setting any value. 262 0 x 0 has the same behavior as not setting any value.
261 If in conflict, this option has precedence over floating_minimum_size. 263 If in conflict, this option has precedence over floating_minimum_size.
262 264
263**floating_minimum_size** <width> x <height>:: 265**floating_minimum_size** <width> x <height>::
264 Specifies the minimum dimensions of floating windows. 266 Specifies the minimum size of floating windows.
265 Default parameters are 75 x 50. 267 Default parameters are 75 x 50.
266 -1 and 0 are invalid parameters, default will be used instead. 268 -1 and 0 are invalid parameters, default will be used instead.
267 269
@@ -313,7 +315,7 @@ The default colors are:
313**hide_edge_borders** <none|vertical|horizontal|both|smart>:: 315**hide_edge_borders** <none|vertical|horizontal|both|smart>::
314 Hide window borders adjacent to the screen edges. Default is _none_. 316 Hide window borders adjacent to the screen edges. Default is _none_.
315 317
316**input** <input device> <block of commands>:: 318**input** <input_device> <block of commands>::
317 Append _{_ to this command, the following lines will be commands to configure 319 Append _{_ to this command, the following lines will be commands to configure
318 the named input device, and _}_ on its own line will close the block. 320 the named input device, and _}_ on its own line will close the block.
319 + 321 +
@@ -321,6 +323,18 @@ The default colors are:
321 + 323 +
322 See **sway-input**(5) for details. 324 See **sway-input**(5) for details.
323 325
326**seat** <seat_name> <block of commands>::
327 Append _{_ to this command, the following lines will be commands to configure
328 the named seat, and _}_ on its own line will close the block.
329 See **sway-input**(5) for details.
330
331**seat** <seat_name> cursor <move|set> <x> <y>::
332 Move cursor relatively to current position or set to absolute screen position.
333 A value of 0 causes the axis to be ignored in both commands.
334
335**seat** <seat_name> cursor <press|release> <left|right|1|2|3...>::
336 Simulate press of mouse button specified by left, right, or numerical code.
337
324**kill**:: 338**kill**::
325 Kills (force-closes) the currently-focused container and all of its children. 339 Kills (force-closes) the currently-focused container and all of its children.
326 340
@@ -349,35 +363,44 @@ The default colors are:
349 Prevents windows matching <criteria> from being focused automatically when 363 Prevents windows matching <criteria> from being focused automatically when
350 they're created. This does not apply to the first window in a workspace. 364 they're created. This does not apply to the first window in a workspace.
351 365
352**output** <name> <resolution|res> <WIDTHxHEIGHT>:: 366**output** <name> mode|resolution|res <WIDTHxHEIGHT>[@<RATE>[Hz]]::
353 Configures the specified output to use the given resolution. 367 Configures the specified output to use the given mode. Modes are a combination
368 of width and height (in pixels) and a refresh rate that your display can be
369 configured to use. For a list of available modes, use swaymsg -t get_outputs.
370 +
371 Examples:
372 +
373 output HDMI-A-1 mode 1920x1080
354 + 374 +
355 _Note_: sway does not currently support setting the output mode. Your output's native 375 output HDMI-A-1 mode 1920x1080@60Hz
356 resolution will be used and the screen will be scaled from the resolution
357 specified to your native resolution.
358 376
359**output** <name> <position|pos> <X,Y>:: 377**output** <name> position|pos <X,Y>::
360 Configures the specified output to be arranged at the given position. 378 Configures the specified output to be arranged at the given position.
361 379
362**output** <name> <scale> <I>:: 380**output** <name> scale <I>::
363 Configures the specified output to be scaled up by the specified integer 381 Configures the specified output to be scaled up by the specified integer
364 scaling factor (usually 2 for HiDPI screens). 382 scaling factor (usually 2 for HiDPI screens). Fractional scaling is supported.
365 383
366**output** <name> <background|bg> <file> <mode>:: 384**output** <name> background|bg <file> <mode>::
367 Sets the wallpaper for the given output to the specified file, using the given 385 Sets the wallpaper for the given output to the specified file, using the given
368 scaling mode (one of "stretch", "fill", "fit", "center", "tile"). 386 scaling mode (one of "stretch", "fill", "fit", "center", "tile").
369 387
370**output** <name> <background|bg> <color> solid_color:: 388**output** <name> background|bg <color> solid_color::
371 Sets the background of the given output to the specified color. _color_ should 389 Sets the background of the given output to the specified color. _color_ should
372 be specified as an _#rrggbb_ (no alpha) color. 390 be specified as an _#rrggbb_ (no alpha) color.
373 391
392**output** <name> transform <transform>::
393 Sets the background transform to the given value. Can be one of "90", "180",
394 "270" for rotation; or "flipped", "flipped-90", "flipped-180", "flipped-270"
395 to apply a rotation and flip, or "normal" to apply no transform.
396
374**output** <name> disable:: 397**output** <name> disable::
375 Disables the specified output. 398 Disables the specified output.
376 399
377**NOTES FOR THE OUTPUT COMMAND**:: 400**NOTES FOR THE OUTPUT COMMAND**::
378 You may combine output commands into one, like so: 401 You may combine output commands into one, like so:
379 + 402 +
380 output HDMI-A-1 res 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch 403 output HDMI-A-1 mode 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch
381 + 404 +
382 You can get a list of output names like so: 405 You can get a list of output names like so:
383 + 406 +
@@ -397,6 +420,10 @@ The default colors are:
397 However, any mark that starts with an underscore will not be drawn even if the 420 However, any mark that starts with an underscore will not be drawn even if the
398 option is on. The default option is _on_. 421 option is on. The default option is _on_.
399 422
423**opacity** <value>::
424 Set the opacity of the window between 0 (completely transparent) and 1
425 (completely opaque).
426
400**unmark** <identifier>:: 427**unmark** <identifier>::
401 **Unmark** will remove _identifier_ from the list of current marks on a window. If 428 **Unmark** will remove _identifier_ from the list of current marks on a window. If
402 no _identifier_ is specified, then **unmark** will remove all marks. 429 no _identifier_ is specified, then **unmark** will remove all marks.