diff options
-rw-r--r-- | sway/sway-bar.5.txt | 11 | ||||
-rw-r--r-- | sway/sway-input.5.txt | 5 | ||||
-rw-r--r-- | sway/sway.1.txt | 13 | ||||
-rw-r--r-- | sway/sway.5.txt | 104 |
4 files changed, 73 insertions, 60 deletions
diff --git a/sway/sway-bar.5.txt b/sway/sway-bar.5.txt index d0727440..dc4a673c 100644 --- a/sway/sway-bar.5.txt +++ b/sway/sway-bar.5.txt | |||
@@ -19,10 +19,15 @@ Commands | |||
19 | -------- | 19 | -------- |
20 | 20 | ||
21 | **status_command** <status command>:: | 21 | **status_command** <status command>:: |
22 | Executes the bar _status command_ with _sh -c_. | 22 | Executes the bar _status command_ with _sh -c_. Each line of text printed to |
23 | stdout from this command will be displayed in the status area of the bar. You | ||
24 | can also use the i3bar JSON protocol: | ||
25 | + | ||
26 | https://i3wm.org/docs/i3bar-protocol.html | ||
23 | 27 | ||
24 | **pango_markup** <enabled|disabled>:: | 28 | **pango_markup** <enabled|disabled>:: |
25 | Enables or disables pango markup for plaintext statuslines. | 29 | Enables or disables pango markup for status lines. This has no effect on |
30 | status lines using the i3bar JSON protocol. | ||
26 | 31 | ||
27 | **id** <bar_id>:: | 32 | **id** <bar_id>:: |
28 | Sets the ID of the bar. | 33 | Sets the ID of the bar. |
@@ -112,4 +117,4 @@ channel. | |||
112 | See Also | 117 | See Also |
113 | -------- | 118 | -------- |
114 | 119 | ||
115 | **sway**(5) **sway-input**(5) | 120 | **sway**(5) |
diff --git a/sway/sway-input.5.txt b/sway/sway-input.5.txt index c2637830..2ac878cd 100644 --- a/sway/sway-input.5.txt +++ b/sway/sway-input.5.txt | |||
@@ -37,7 +37,8 @@ Commands | |||
37 | Enables or disables middle click emulation. | 37 | Enables or disables middle click emulation. |
38 | 38 | ||
39 | **input** <identifier> natural_scroll <enabled|disabled>:: | 39 | **input** <identifier> natural_scroll <enabled|disabled>:: |
40 | Enables or disables natural scrolling for the specified input device. | 40 | Enables or disables natural (inverted) scrolling for the specified input |
41 | device. | ||
41 | 42 | ||
42 | **input** <identifier> pointer_accel <[-1,1]>:: | 43 | **input** <identifier> pointer_accel <[-1,1]>:: |
43 | Changes the pointer acceleration for the specified input device. | 44 | Changes the pointer acceleration for the specified input device. |
@@ -51,4 +52,4 @@ Commands | |||
51 | See Also | 52 | See Also |
52 | -------- | 53 | -------- |
53 | 54 | ||
54 | **sway**(5) **sway-bar**(5) | 55 | **sway**(5) |
diff --git a/sway/sway.1.txt b/sway/sway.1.txt index 1243c354..f62e27f4 100644 --- a/sway/sway.1.txt +++ b/sway/sway.1.txt | |||
@@ -52,7 +52,7 @@ You may run sway from an ongoing x11 session to run it within x. Otherwise, you | |||
52 | can run sway on a tty and it will use your outputs directly. | 52 | can run sway on a tty and it will use your outputs directly. |
53 | 53 | ||
54 | *Important note for nvidia users*: The proprietary nvidia driver does _not_ have | 54 | *Important note for nvidia users*: The proprietary nvidia driver does _not_ have |
55 | support for Wayland as of 2016-03-27. Use nouveau. | 55 | support for Wayland as of 2016-06-10. Use nouveau. |
56 | 56 | ||
57 | Commands | 57 | Commands |
58 | -------- | 58 | -------- |
@@ -60,7 +60,7 @@ Commands | |||
60 | If sway is currently running, you may run _sway [command]_ to send _command_ to | 60 | If sway is currently running, you may run _sway [command]_ to send _command_ to |
61 | the running instance of sway. The same commands you would use in the config file | 61 | the running instance of sway. The same commands you would use in the config file |
62 | are valid here (see **sway**(5)). For compatibility reasons, you may also issue | 62 | are valid here (see **sway**(5)). For compatibility reasons, you may also issue |
63 | commands with **sway-msg**(1) or **i3-msg**(1) (or even with **i3**(1), probably). | 63 | commands with **swaymsg**(1) or **i3-msg**(1) (or even with **i3**(1), probably). |
64 | 64 | ||
65 | Configuration | 65 | Configuration |
66 | ------------- | 66 | ------------- |
@@ -69,11 +69,14 @@ If _-c_ is not specified, sway will look in several locations for your config | |||
69 | file. The suggested location for your config file is ~/.config/sway/config. | 69 | file. The suggested location for your config file is ~/.config/sway/config. |
70 | ~/.sway/config will also work, and the rest of the usual XDG config locations | 70 | ~/.sway/config will also work, and the rest of the usual XDG config locations |
71 | are supported. If no sway config is found, sway will attempt to load an i3 | 71 | are supported. If no sway config is found, sway will attempt to load an i3 |
72 | config from all the config locations i3 supports. At last, sway looks for a | 72 | config from all the config locations i3 supports. Sway looks for a config file in |
73 | config file in a fallback directory, which is /etc/sway/ by default. A standard | 73 | a fallback directory as a last resort, which is /etc/sway/ by default. A standard |
74 | configuration file is installed at this location. If still nothing is found, | 74 | configuration file is installed at this location. If still nothing is found, |
75 | you will receive an error. | 75 | you will receive an error. |
76 | 76 | ||
77 | To write your own config, it's suggested that you copy the default config file to | ||
78 | the location of your choosing and start there. | ||
79 | |||
77 | For information on the config file format, see **sway**(5). | 80 | For information on the config file format, see **sway**(5). |
78 | 81 | ||
79 | Authors | 82 | Authors |
@@ -86,4 +89,4 @@ source contributors. For more information about sway development, see | |||
86 | See Also | 89 | See Also |
87 | -------- | 90 | -------- |
88 | 91 | ||
89 | **sway**(5) **swaymsg**(1) **swaygrab**(1) **sway-input** (5) **sway-bar** (5) | 92 | **sway**(5) **swaymsg**(1) **swaygrab**(1) **sway-input**(5) **sway-bar**(5) |
diff --git a/sway/sway.5.txt b/sway/sway.5.txt index 397b6d87..00806112 100644 --- a/sway/sway.5.txt +++ b/sway/sway.5.txt | |||
@@ -22,7 +22,7 @@ adding a '\' character at the end of line. e.g.: | |||
22 | bindsym Shift+XF86AudioRaiseVolume exec pactl set-sink-volume \ | 22 | bindsym Shift+XF86AudioRaiseVolume exec pactl set-sink-volume \ |
23 | $(pactl list sinks | grep -B 1 RUNNING | sed '1q;d' | sed 's/[^0-9]\+//g') +5% | 23 | $(pactl list sinks | grep -B 1 RUNNING | sed '1q;d' | sed 's/[^0-9]\+//g') +5% |
24 | 24 | ||
25 | These commands can be executed in your config file, via **sway-msg**(1), or via | 25 | These commands can be executed in your config file, via **swaymsg**(1), or via |
26 | the bindsym command. | 26 | the bindsym command. |
27 | 27 | ||
28 | Commands | 28 | Commands |
@@ -36,53 +36,28 @@ The following commands may only be used in the configuration file. | |||
36 | + | 36 | + |
37 | See **sway-bar**(5) for details. | 37 | See **sway-bar**(5) for details. |
38 | 38 | ||
39 | **input** <input device> <block of commands>:: | ||
40 | Append _{_ to this command, the following lines will be commands to configure | ||
41 | the named input device, and _}_ on its own line will close the block. | ||
42 | + | ||
43 | See **sway-input**(5) for details. | ||
44 | |||
45 | **set** <name> <value>:: | 39 | **set** <name> <value>:: |
46 | Creates a substitution for _value_ that can be used with $_name_ in other | 40 | Sets variable $name to _value_. You can use the new variable in the arguments |
47 | commands. | 41 | of future commands. |
48 | 42 | ||
49 | The following commands cannot be used directly in the configuration file. | 43 | The following commands cannot be used directly in the configuration file. |
50 | They are expected to be used with **bindsym** or at runtime through **swaymsg**(1). | 44 | They are expected to be used with **bindsym** or at runtime through **swaymsg**(1). |
51 | 45 | ||
52 | **border** <normal|pixel> [<n>]:: | 46 | **border** <normal|pixel> [<n>]:: |
53 | Set border style for focused window. _normal_ includes a border of thickness | 47 | Set border style for focused window. _normal_ includes a border of thickness |
54 | _n_ and a title bar. _pixel_ is just the border without title bar. Default is | 48 | _n_ and a title bar. _pixel_ is a border without title bar _n_ pixels thick. |
55 | _normal_ with border thickness 2. | 49 | Default is _normal_ with border thickness 2. |
56 | 50 | ||
57 | **border** <none|toggle>:: | 51 | **border** <none|toggle>:: |
58 | Set border style for focused window to _none_ or _toggle_ between the | 52 | Set border style for focused window to _none_ or _toggle_ between the |
59 | available border styles: _normal_, _pixel_, _none_. | 53 | available border styles: _normal_, _pixel_, _none_. |
60 | 54 | ||
61 | **new_window** <normal|none|pixel> [<n>]:: | ||
62 | Set default border style for new windows. | ||
63 | |||
64 | **new_float** <normal|none|pixel> [<n>]:: | ||
65 | Set default border style for new floating windows. This does only apply to | ||
66 | windows that are spawned in floating mode. | ||
67 | |||
68 | **exit**:: | 55 | **exit**:: |
69 | Exit sway and end your Wayland session. | 56 | Exit sway and end your Wayland session. |
70 | 57 | ||
71 | **floating** <enable|disable|toggle>:: | 58 | **floating** <enable|disable|toggle>:: |
72 | Make focused view floating, non-floating, or the opposite of what it is now. | 59 | Make focused view floating, non-floating, or the opposite of what it is now. |
73 | 60 | ||
74 | **floating_maximum_size** <width> x <height>:: | ||
75 | Specifies the maximum dimensions of floating windows. | ||
76 | Uses the container dimensions as default. | ||
77 | -1 x -1 will remove any restriction on dimentions. | ||
78 | 0 x 0 has the same behavior as not setting any value. | ||
79 | If in conflict this option has precedence over floating_minimum_size. | ||
80 | |||
81 | **floating_minimum_size** <width> x <height>:: | ||
82 | Specifies the minimum dimensions of floating windows. | ||
83 | Default parameters are 75 x 50. | ||
84 | -1 and 0 are invalid parameters, default will be used instead. | ||
85 | |||
86 | **focus** <direction>:: | 61 | **focus** <direction>:: |
87 | Direction may be one of _up_, _down_, _left_, _right_, or _parent_. The | 62 | Direction may be one of _up_, _down_, _left_, _right_, or _parent_. The |
88 | directional focus commands will move the focus in that direction. The parent | 63 | directional focus commands will move the focus in that direction. The parent |
@@ -101,9 +76,6 @@ They are expected to be used with **bindsym** or at runtime through **swaymsg**( | |||
101 | **fullscreen**:: | 76 | **fullscreen**:: |
102 | Toggles fullscreen status for the focused view. | 77 | Toggles fullscreen status for the focused view. |
103 | 78 | ||
104 | **hide_edge_borders** <none|vertical|horizontal|both>:: | ||
105 | Hide window borders adjacent to the screen edges. Default is _none_. | ||
106 | |||
107 | **layout** <mode>:: | 79 | **layout** <mode>:: |
108 | Sets the layout mode of the focused container. _mode_ can be one of _splith_, | 80 | Sets the layout mode of the focused container. _mode_ can be one of _splith_, |
109 | _splitv_, _toggle split_, _stacking_ or _tabbed_. | 81 | _splitv_, _toggle split_, _stacking_ or _tabbed_. |
@@ -140,8 +112,8 @@ They are expected to be used with **bindsym** or at runtime through **swaymsg**( | |||
140 | Equivalent to **split toggle**. | 112 | Equivalent to **split toggle**. |
141 | 113 | ||
142 | **sticky** <enable|disable|toggle>:: | 114 | **sticky** <enable|disable|toggle>:: |
143 | If enabled and the windows is floating it will always be present on the active | 115 | "Sticks" a floating window to the current output so that it shows up on all |
144 | workspace on that output. | 116 | workspaces. |
145 | 117 | ||
146 | The following commands may be used either in the configuration file | 118 | The following commands may be used either in the configuration file |
147 | or triggered at runtime. | 119 | or triggered at runtime. |
@@ -155,7 +127,7 @@ or triggered at runtime. | |||
155 | **bindsym** <key combo> <command>:: | 127 | **bindsym** <key combo> <command>:: |
156 | Binds _key combo_ to execute _command_ when pressed. You may use XKB key | 128 | Binds _key combo_ to execute _command_ when pressed. You may use XKB key |
157 | names here (**xev**(1) is a good tool for discovering them). An example | 129 | names here (**xev**(1) is a good tool for discovering them). An example |
158 | bindsym command would be _bindsym Mod1+Shift+f exec firefox_, which would | 130 | bindsym command would be **bindsym Mod1+Shift+f exec firefox**, which would |
159 | execute Firefox if the alt, shift, and F keys are pressed together. Any | 131 | execute Firefox if the alt, shift, and F keys are pressed together. Any |
160 | valid sway command is eligible to be bound to a key combo. | 132 | valid sway command is eligible to be bound to a key combo. |
161 | + | 133 | + |
@@ -201,18 +173,18 @@ The default colors are: | |||
201 | [options="header"] | 173 | [options="header"] |
202 | |=========================================================================== | 174 | |=========================================================================== |
203 | |color_class |border |background |text |indicator |child_border | 175 | |color_class |border |background |text |indicator |child_border |
204 | |background |n/a |#ffffffff |n/a |n/a |n/a | 176 | |background |n/a |#ffffff |n/a |n/a |n/a |
205 | |focused |#4c7899ff |#285577ff |#ffffffff |#2e9ef4ff |#285577ff | 177 | |focused |#4c7899 |#285577 |#ffffff |#2e9ef4 |#285577 |
206 | |focused_inactive |#333333ff |#5f676aff |#ffffffff |#484e50ff |#5f676aff | 178 | |focused_inactive |#333333 |#5f676a |#ffffff |#484e50 |#5f676a |
207 | |unfocused |#333333ff |#222222ff |#888888ff |#292d2eff |#222222ff | 179 | |unfocused |#333333 |#222222 |#888888 |#292d2e |#222222 |
208 | |urgent |#2f343aff |#900000ff |#ffffffff |#900000ff |#900000ff | 180 | |urgent |#2f343a |#900000 |#ffffff |#900000 |#900000 |
209 | |placeholder |#000000ff |#0c0c0cff |#ffffffff |#000000ff |#0c0c0cff | 181 | |placeholder |#000000 |#0c0c0c |#ffffff |#000000 |#0c0c0c |
210 | |=========================================================================== | 182 | |=========================================================================== |
211 | -- | 183 | -- |
212 | 184 | ||
213 | **debuglog** <on|off|toggle>:: | 185 | **debuglog** <on|off|toggle>:: |
214 | Enables, disables or toggles logging for debug. The toggle argument cannot | 186 | Enables, disables or toggles debug logging. The toggle argument cannot be used |
215 | be used in the configuration file. | 187 | in the configuration file. |
216 | 188 | ||
217 | **exec** <shell command>:: | 189 | **exec** <shell command>:: |
218 | Executes _shell command_ with sh. | 190 | Executes _shell command_ with sh. |
@@ -221,21 +193,32 @@ The default colors are: | |||
221 | Like exec, but the shell command will be executed _again_ after *reload* or | 193 | Like exec, but the shell command will be executed _again_ after *reload* or |
222 | *restart* is executed. | 194 | *restart* is executed. |
223 | 195 | ||
196 | **floating_maximum_size** <width> x <height>:: | ||
197 | Specifies the maximum dimensions of floating windows. | ||
198 | Uses the container dimensions as default. | ||
199 | -1 x -1 will remove any restriction on dimentions. | ||
200 | 0 x 0 has the same behavior as not setting any value. | ||
201 | If in conflict this option has precedence over floating_minimum_size. | ||
202 | |||
203 | **floating_minimum_size** <width> x <height>:: | ||
204 | Specifies the minimum dimensions of floating windows. | ||
205 | Default parameters are 75 x 50. | ||
206 | -1 and 0 are invalid parameters, default will be used instead. | ||
207 | |||
224 | **floating_modifier** <modifier> [normal|inverse]:: | 208 | **floating_modifier** <modifier> [normal|inverse]:: |
225 | When the _modifier_ key is held down, you may use left click to drag floating | 209 | When the _modifier_ key is held down, you may hold left click to move floating |
226 | windows, and right click to resize them. Unlike i3, this modifier may also be | 210 | windows, and right click to resize them. Unlike i3, this modifier may also be |
227 | used to resize and move windows that are tiled. With the _inverse_ mode | 211 | used to resize and move windows that are tiled. With the _inverse_ mode |
228 | enabled, left click is used for resizing and right click for dragging. The | 212 | enabled, left click is used for resizing and right click for dragging. The |
229 | mode paramenter is optional and defaults to _normal_ if it isn't defined. | 213 | mode paramenter is optional and defaults to _normal_ if it isn't defined. |
230 | 214 | ||
231 | **floating_scroll** <up|down|left|right> [command]:: | 215 | **floating_scroll** <up|down|left|right> [command]:: |
232 | Sets the command to be executed on scrolling in the specified | 216 | Sets a command to be executed when the mouse wheel is scrolled in the |
233 | direction while holding the floating modifier. Resets the | 217 | specified direction while holding the floating modifier. Resets the command, |
234 | command, when given no arguments. | 218 | when given no arguments. |
235 | 219 | ||
236 | **focus_follows_mouse** <yes|no>:: | 220 | **focus_follows_mouse** <yes|no>:: |
237 | If set to _yes_, the currently focused view will change as you move your | 221 | If set to _yes_, moving your mouse over a window will focus that window. |
238 | mouse around the screen to the view that ends up underneath your mouse. | ||
239 | 222 | ||
240 | **for_window** <criteria> <command>:: | 223 | **for_window** <criteria> <command>:: |
241 | Whenever a window that matches _criteria_ appears, run list of commands. See | 224 | Whenever a window that matches _criteria_ appears, run list of commands. See |
@@ -262,6 +245,15 @@ The default colors are: | |||
262 | workspace (or current workspace), and _current_ changes gaps for the current | 245 | workspace (or current workspace), and _current_ changes gaps for the current |
263 | view or workspace. | 246 | view or workspace. |
264 | 247 | ||
248 | **hide_edge_borders** <none|vertical|horizontal|both>:: | ||
249 | Hide window borders adjacent to the screen edges. Default is _none_. | ||
250 | |||
251 | **input** <input device> <block of commands>:: | ||
252 | Append _{_ to this command, the following lines will be commands to configure | ||
253 | the named input device, and _}_ on its own line will close the block. | ||
254 | + | ||
255 | See **sway-input**(5) for details. | ||
256 | |||
265 | **smart_gaps** <on|off>:: | 257 | **smart_gaps** <on|off>:: |
266 | If smart_gaps are _on_ then gaps will only be enabled if a workspace has more | 258 | If smart_gaps are _on_ then gaps will only be enabled if a workspace has more |
267 | than one child container. | 259 | than one child container. |
@@ -275,8 +267,20 @@ The default colors are: | |||
275 | When _output_: place mouse at center of newly focused window when changing | 267 | When _output_: place mouse at center of newly focused window when changing |
276 | output. When _none_: don't move mouse. | 268 | output. When _none_: don't move mouse. |
277 | 269 | ||
270 | **new_window** <normal|none|pixel> [<n>]:: | ||
271 | Set default border style for new windows. | ||
272 | |||
273 | **new_float** <normal|none|pixel> [<n>]:: | ||
274 | Set default border style for new floating windows. This only applies to | ||
275 | windows that are spawned in floating mode, not windows that become floating | ||
276 | after the fact. | ||
277 | |||
278 | **output** <name> <resolution|res> <WIDTHxHEIGHT>:: | 278 | **output** <name> <resolution|res> <WIDTHxHEIGHT>:: |
279 | Configures the specified output to use the given resolution. | 279 | Configures the specified output to use the given resolution. |
280 | + | ||
281 | _Note_: sway does not currently support modesetting. Your output's native | ||
282 | resolution will be used and the screen will be scaled from the resolution | ||
283 | specified to your native resolution. | ||
280 | 284 | ||
281 | **output** <name> <position|pos> <X,Y>:: | 285 | **output** <name> <position|pos> <X,Y>:: |
282 | Configures the specified output to be arranged at the given position. | 286 | Configures the specified output to be arranged at the given position. |