diff options
-rw-r--r-- | sway/sway-bar.5.scd | 3 | ||||
-rw-r--r-- | sway/sway-input.5.scd | 4 | ||||
-rw-r--r-- | sway/sway.5.scd | 58 |
3 files changed, 37 insertions, 28 deletions
diff --git a/sway/sway-bar.5.scd b/sway/sway-bar.5.scd index a61e2829..00b9386e 100644 --- a/sway/sway-bar.5.scd +++ b/sway/sway-bar.5.scd | |||
@@ -6,8 +6,7 @@ sway-bar - bar configuration file and commands | |||
6 | 6 | ||
7 | # DESCRIPTION | 7 | # DESCRIPTION |
8 | 8 | ||
9 | Sway allows configuring swaybar in the sway configuration file. Swaybar | 9 | Sway allows configuring swaybar in the sway configuration file. |
10 | commands must be used inside a _bar { }_ block in the config file. | ||
11 | 10 | ||
12 | # COMMANDS | 11 | # COMMANDS |
13 | 12 | ||
diff --git a/sway/sway-input.5.scd b/sway/sway-input.5.scd index 707c36af..5736d70a 100644 --- a/sway/sway-input.5.scd +++ b/sway/sway-input.5.scd | |||
@@ -7,7 +7,6 @@ sway-input - input configuration file and commands | |||
7 | # DESCRIPTION | 7 | # DESCRIPTION |
8 | 8 | ||
9 | Sway allows for configuration of devices within the sway configuration file. | 9 | Sway allows for configuration of devices within the sway configuration file. |
10 | sway-input commands must be used inside an _input { }_ block in the config. | ||
11 | To obtain a list of available device identifiers, run *swaymsg -t get\_inputs*. | 10 | To obtain a list of available device identifiers, run *swaymsg -t get\_inputs*. |
12 | 11 | ||
13 | # INPUT COMMANDS | 12 | # INPUT COMMANDS |
@@ -116,8 +115,7 @@ The following commands may only be used in the configuration file. | |||
116 | 115 | ||
117 | ## SEAT CONFIGURATION | 116 | ## SEAT CONFIGURATION |
118 | 117 | ||
119 | Configure options for multiseat mode. sway-seat commands must be used inside a | 118 | Configure options for multiseat mode. |
120 | _seat { }_ block in the config. | ||
121 | 119 | ||
122 | A *seat* is a collection of input devices that act independently of each other. | 120 | A *seat* is a collection of input devices that act independently of each other. |
123 | Seats are identified by name and the default seat is _seat0_ if no seats are | 121 | Seats are identified by name and the default seat is _seat0_ if no seats are |
diff --git a/sway/sway.5.scd b/sway/sway.5.scd index 927bf55c..1526eee3 100644 --- a/sway/sway.5.scd +++ b/sway/sway.5.scd | |||
@@ -19,6 +19,24 @@ bindsym Shift+XF86AudioRaiseVolume exec \\ | |||
19 | pactl set-sink-volume @DEFAULT_SINK@ -1% | 19 | pactl set-sink-volume @DEFAULT_SINK@ -1% |
20 | ``` | 20 | ``` |
21 | 21 | ||
22 | Commands can also be given as a block in the form *command { <subcommands...> | ||
23 | }*. Anything before the opening *{* will be prepended to the lines inside the | ||
24 | block. For example: | ||
25 | |||
26 | ``` | ||
27 | output eDP-1 { | ||
28 | background ~/wallpaper.png | ||
29 | resolution 1920x1080 | ||
30 | } | ||
31 | ``` | ||
32 | |||
33 | is identical to | ||
34 | |||
35 | ``` | ||
36 | output eDP-1 background ~/wallpaper.png | ||
37 | output eDP-1 resolution 1920x1080 | ||
38 | ``` | ||
39 | |||
22 | These commands can be executed in your config file, via *swaymsg*(1), or via | 40 | These commands can be executed in your config file, via *swaymsg*(1), or via |
23 | the bindsym command. | 41 | the bindsym command. |
24 | 42 | ||
@@ -37,10 +55,8 @@ which you may only select one. *[...]* is used for optional arguments, and | |||
37 | 55 | ||
38 | The following commands may only be used in the configuration file. | 56 | The following commands may only be used in the configuration file. |
39 | 57 | ||
40 | *bar {* <commands...> *}* | 58 | *bar* [<bar-id>] <bar-subcommands...> |
41 | _commands..._ after *{* will be interpreted as bar commands. For | 59 | For details on bar subcommands, see *sway-bar*(5). |
42 | details, see *sway-bar*(5). A newline is required between *{* and the | ||
43 | first command, and *}* must be alone on a line. | ||
44 | 60 | ||
45 | *default\_orientation* horizontal|vertical|auto | 61 | *default\_orientation* horizontal|vertical|auto |
46 | Sets the default container layout for tiled containers. | 62 | Sets the default container layout for tiled containers. |
@@ -51,10 +67,6 @@ The following commands may only be used in the configuration file. | |||
51 | *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; |
52 | subsequent attempts will be ignored. | 68 | subsequent attempts will be ignored. |
53 | 69 | ||
54 | *set* $<name> <value> | ||
55 | Sets variable $_name_ to _value_. You can use the new variable in the | ||
56 | arguments of future commands. | ||
57 | |||
58 | *swaybg\_command* <command> | 70 | *swaybg\_command* <command> |
59 | Executes custom background _command_. Default is _swaybg_. Refer to | 71 | Executes custom background _command_. Default is _swaybg_. Refer to |
60 | *output* below for more information. | 72 | *output* below for more information. |
@@ -424,20 +436,15 @@ The default colors are: | |||
424 | *hide\_edge\_borders* none|vertical|horizontal|both|smart | 436 | *hide\_edge\_borders* none|vertical|horizontal|both|smart |
425 | Hides window borders adjacent to the screen edges. Default is _none_. | 437 | Hides window borders adjacent to the screen edges. Default is _none_. |
426 | 438 | ||
427 | *input* <input\_device> *{* <commands...> *}* | 439 | *input* <input\_device> <input-subcommands...> |
428 | _commands..._ after *{* will be interpreted as input commands applying to | 440 | For details on input subcommands, see *sway-input*(5). |
429 | the specified input device. For details, see *sway-input*(5). A newline is | ||
430 | required between *{* and the first command, and *}* must be alone on a | ||
431 | line. | ||
432 | 441 | ||
433 | \* may be used in lieu of a specific device name to configure all input | 442 | \* may be used in lieu of a specific device name to configure all input |
434 | devices. A list of input device names may be obtained via *swaymsg -t | 443 | devices. A list of input device names may be obtained via *swaymsg -t |
435 | get\_inputs*. | 444 | get\_inputs*. |
436 | 445 | ||
437 | *seat* <seat> *{* <commands...> *}* | 446 | *seat* <seat> <seat-subcommands...> |
438 | _commands..._ after *{* will be interpreted as seat commands applying to | 447 | For details on seat subcommands, see *sway-input*(5). |
439 | the specified seat. For details, see *sway-input*(5). A newline is required | ||
440 | between *{* and the first command, and *}* must be alone on a line. | ||
441 | 448 | ||
442 | *seat* <seat> cursor move|set <x> <y> | 449 | *seat* <seat> cursor move|set <x> <y> |
443 | Move specified seat's cursor relative to current position or wrap to | 450 | Move specified seat's cursor relative to current position or wrap to |
@@ -465,10 +472,8 @@ The default colors are: | |||
465 | *mode* <mode> | 472 | *mode* <mode> |
466 | Switches to the specified mode. The default mode _default_. | 473 | Switches to the specified mode. The default mode _default_. |
467 | 474 | ||
468 | *mode* [--pango\_markup] <mode> *{* <commands...> *}* | 475 | *mode* [--pango\_markup] <mode> <mode-subcommands...> |
469 | _commands..._ after *{* will be added to the specified mode. A newline is | 476 | The only two valid _mode-subcommands..._ are *bindsym* and *bindcode*. |
470 | required between *{* and the first command, and *}* must be alone on a | ||
471 | line. Only *bindsym* and *bindcode* commands are permitted in mode blocks. | ||
472 | If _--pango\_markup_ is given, then _mode_ will be interpreted as pango | 477 | If _--pango\_markup_ is given, then _mode_ will be interpreted as pango |
473 | markup. | 478 | markup. |
474 | 479 | ||
@@ -533,8 +538,15 @@ You may combine output commands into one, like so: | |||
533 | output HDMI-A-1 mode 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch | 538 | output HDMI-A-1 mode 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch |
534 | 539 | ||
535 | You can get a list of output names with *swaymsg -t get\_outputs*. You may also | 540 | You can get a list of output names with *swaymsg -t get\_outputs*. You may also |
536 | match any output by using the output name "\*". Be sure to add this output | 541 | match any output by using the output name "\*". |
537 | config after the others, or it will be matched instead of the others. | 542 | |
543 | *set* $<name> <value> | ||
544 | Sets variable $_name_ to _value_. You can use the new variable in the | ||
545 | arguments of future commands. When the variable is used, it can be escaped | ||
546 | with an additional $ (ie $$_name_) to have the replacement happen at run | ||
547 | time instead of when reading the config. However, it does not always make | ||
548 | sense for the variable to be replaced at run time since some arguments do | ||
549 | need to be known at config time. | ||
538 | 550 | ||
539 | *show\_marks* yes|no | 551 | *show\_marks* yes|no |
540 | If *show\_marks* is yes, marks will be displayed in the window borders. | 552 | If *show\_marks* is yes, marks will be displayed in the window borders. |