diff options
Diffstat (limited to 'sway.5.txt')
-rw-r--r-- | sway.5.txt | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/sway.5.txt b/sway.5.txt new file mode 100644 index 00000000..9f92dfe8 --- /dev/null +++ b/sway.5.txt | |||
@@ -0,0 +1,90 @@ | |||
1 | ///// | ||
2 | vim:set ts=4 sw=4 tw=82 noet: | ||
3 | ///// | ||
4 | sway (5) | ||
5 | ======== | ||
6 | |||
7 | Name | ||
8 | ---- | ||
9 | sway - configuration file and commands | ||
10 | |||
11 | Description | ||
12 | ----------- | ||
13 | |||
14 | A sway configuration file is a list of sway commands that are exected by sway on | ||
15 | startup. These commands usually consist of setting your preferences and setting | ||
16 | key bindings. An example config is likely present in /etc/sway/config for you to | ||
17 | check out. | ||
18 | |||
19 | All of these commands may be issued at runtime through **sway-msg**(1). | ||
20 | |||
21 | Commands | ||
22 | -------- | ||
23 | |||
24 | **bindsym** <key combo> <command>:: | ||
25 | Binds _key combo_ to execute _command_ when pressed. You may use XKB key names | ||
26 | here (**xev**(1) is a good tool for discovering them). An example bindsym | ||
27 | command would be _bindsym Mod1+Shift+f exec firefox_, which would execute | ||
28 | Firefox if the alt, shift, and F keys are pressed together. Any valid sway | ||
29 | command is eligible to be bound to a key combo. | ||
30 | |||
31 | **exec** <shell command>:: | ||
32 | Executes _shell command_ with sh. | ||
33 | |||
34 | **exec_always** <shell command>:: | ||
35 | Like exec, but the shell command will be executed _again_ after *reload* or | ||
36 | *restart* is executed. | ||
37 | |||
38 | **exit**:: | ||
39 | Exit sway and end your Wayland session. | ||
40 | |||
41 | **floating** toggle:: | ||
42 | Toggles the "floating" status of the focused view. | ||
43 | |||
44 | **focus** <direction>:: | ||
45 | Direction may be one of _up_, _down_, _left_, _right_, or _parent_. The | ||
46 | directional focus commands will move the focus in that direction. The parent | ||
47 | focus command will change the focus to the parent of the currently focused | ||
48 | container, which is useful, for example, to open a sibling of the parent | ||
49 | container, or to move the entire container around. | ||
50 | |||
51 | **focus_follows_mouse** <yes|no>:: | ||
52 | If set to _yes_, the currently focused view will change as you move your | ||
53 | mouse around the screen to the view that ends up underneath your mouse. | ||
54 | |||
55 | **kill**:: | ||
56 | Closes the currently focused view. | ||
57 | |||
58 | **layout** <mode>:: | ||
59 | Sets the layout mode of the focused container. _mode_ can be one of _splith_, | ||
60 | _splitv_, or _toggle split_. | ||
61 | |||
62 | **reload**:: | ||
63 | Reloads the sway config file without restarting sway. | ||
64 | |||
65 | **set** <name> <value>:: | ||
66 | Creates a substitution for _value_ that can be used with $_name_ in other | ||
67 | commands. | ||
68 | |||
69 | **split** <vertical|horizontal>:: | ||
70 | Splits the current container, vertically or horiziontally. The letters "h" and | ||
71 | "v" can be used instead of the full words "vertical" or "horizontal". | ||
72 | |||
73 | **splith**:: | ||
74 | Equivalent to **split horizontal**. | ||
75 | |||
76 | **splitv**:: | ||
77 | Equivalent to **split vertical**. | ||
78 | |||
79 | **fullscreen**: | ||
80 | Toggles fullscreen status for the focused view. | ||
81 | |||
82 | **workspace** <name>: | ||
83 | Switches to the specified workspace. | ||
84 | |||
85 | **workspace** <prev_on_output|next_on_output>: | ||
86 | Switches to the next workspace on the current output. | ||
87 | |||
88 | **workspace** <name> output <output>:: | ||
89 | Specifies that the workspace named _name_ should appear on the specified | ||
90 | _output_. | ||