summaryrefslogtreecommitdiffstats
path: root/sway-5.html
diff options
context:
space:
mode:
Diffstat (limited to 'sway-5.html')
-rw-r--r--sway-5.html246
1 files changed, 246 insertions, 0 deletions
diff --git a/sway-5.html b/sway-5.html
new file mode 100644
index 00000000..1f0590fb
--- /dev/null
+++ b/sway-5.html
@@ -0,0 +1,246 @@
1<!-- Creator : groff version 1.22.3 -->
2<!-- CreationDate: Sun Aug 23 20:49:58 2015 -->
3<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4"http://www.w3.org/TR/html4/loose.dtd">
5<html>
6<head>
7<meta name="generator" content="groff -Thtml, see www.gnu.org">
8<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9<meta name="Content-Style" content="text/css">
10<style type="text/css">
11 p { margin-top: 0; margin-bottom: 0; vertical-align: top }
12 pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
13 table { margin-top: 0; margin-bottom: 0; vertical-align: top }
14 h1 { text-align: center }
15 body { width: 500px; margin: 0 auto; background: #111; color: #fff; }
16 a { color: #0275D8; }
17</style>
18<title>SWAY</title>
19
20</head>
21<body>
22
23<h1 align="center">SWAY</h1>
24
25<a href="#NAME">NAME</a><br>
26<a href="#DESCRIPTION">DESCRIPTION</a><br>
27<a href="#COMMANDS">COMMANDS</a><br>
28
29<hr>
30
31
32<h2>NAME
33<a name="NAME"></a>
34</h2>
35
36
37<p style="margin-left:11%; margin-top: 1em">sway &minus;
38configuration file and commands</p>
39
40<h2>DESCRIPTION
41<a name="DESCRIPTION"></a>
42</h2>
43
44
45<p style="margin-left:11%; margin-top: 1em">A sway
46configuration file is a list of sway commands that are
47exected by sway on startup. These commands usually consist
48of setting your preferences and setting key bindings. An
49example config is likely present in /etc/sway/config for you
50to check out.</p>
51
52<p style="margin-left:11%; margin-top: 1em">All of these
53commands may be issued at runtime through
54<b>sway&minus;msg</b>(1).</p>
55
56<h2>COMMANDS
57<a name="COMMANDS"></a>
58</h2>
59
60
61<p style="margin-left:11%; margin-top: 1em"><b>bindsym</b>
62&lt;key combo&gt; &lt;command&gt;</p>
63
64<p style="margin-left:17%;">Binds <i>key combo</i> to
65execute <i>command</i> when pressed. You may use XKB key
66names here (<b>xev</b>(1) is a good tool for discovering
67them). An example bindsym command would be <i>bindsym
68Mod1+Shift+f exec firefox</i>, which would execute Firefox
69if the alt, shift, and F keys are pressed together. Any
70valid sway command is eligible to be bound to a key
71combo.</p>
72
73<p style="margin-left:11%; margin-top: 1em"><b>exec</b>
74&lt;shell command&gt;</p>
75
76<p style="margin-left:17%;">Executes <i>shell command</i>
77with sh.</p>
78
79
80<p style="margin-left:11%; margin-top: 1em"><b>exec_always</b>
81&lt;shell command&gt;</p>
82
83<p style="margin-left:17%;">Like exec, but the shell
84command will be executed <i>again</i> after <b>reload</b> or
85<b>restart</b> is executed.</p>
86
87
88<p style="margin-left:11%; margin-top: 1em"><b>exit</b></p>
89
90<p style="margin-left:17%;">Exit sway and end your Wayland
91session.</p>
92
93
94<p style="margin-left:11%; margin-top: 1em"><b>floating</b>
95toggle</p>
96
97<p style="margin-left:17%;">Toggles the
98&quot;floating&quot; status of the focused view.</p>
99
100
101<p style="margin-left:11%; margin-top: 1em"><b>floating_modifier</b>
102&lt;modifier&gt;</p>
103
104<p style="margin-left:17%;">When the <i>modifier</i> key is
105held down, you may use left click to drag floating windows,
106and right click to resize them. Unlike i3, this modifier may
107also be used to resize and move windows that are tiled.</p>
108
109<p style="margin-left:11%; margin-top: 1em"><b>focus</b>
110&lt;direction&gt;</p>
111
112<p style="margin-left:17%;">Direction may be one of
113<i>up</i>, <i>down</i>, <i>left</i>, <i>right</i>, or
114<i>parent</i>. The directional focus commands will move the
115focus in that direction. The parent focus command will
116change the focus to the parent of the currently focused
117container, which is useful, for example, to open a sibling
118of the parent container, or to move the entire container
119around.</p>
120
121<p style="margin-left:11%; margin-top: 1em"><b>focus</b>
122mode_toggle</p>
123
124<p style="margin-left:17%;">Toggles focus between floating
125view and tiled view.</p>
126
127
128<p style="margin-left:11%; margin-top: 1em"><b>focus_follows_mouse</b>
129&lt;yes|no&gt;</p>
130
131<p style="margin-left:17%;">If set to <i>yes</i>, the
132currently focused view will change as you move your mouse
133around the screen to the view that ends up underneath your
134mouse.</p>
135
136
137<p style="margin-left:11%; margin-top: 1em"><b>fullscreen</b></p>
138
139<p style="margin-left:17%;">Toggles fullscreen status for
140the focused view.</p>
141
142<p style="margin-left:11%; margin-top: 1em"><b>gaps</b>
143&lt;amount&gt;</p>
144
145<p style="margin-left:17%;">Adds <i>amount</i> pixels
146between each view, and around each output.</p>
147
148<p style="margin-left:11%; margin-top: 1em"><b>gaps</b>
149&lt;inner|outer&gt; &lt;amount&gt;</p>
150
151<p style="margin-left:17%;">Adds <i>amount</i> pixels as an
152<i>inner</i> or <i>outer</i> gap, where the former affects
153spacing between views and the latter affects the space
154around each output.</p>
155
156
157<p style="margin-left:11%; margin-top: 1em"><b>kill</b></p>
158
159<p style="margin-left:17%;">Closes the currently focused
160view.</p>
161
162<p style="margin-left:11%; margin-top: 1em"><b>layout</b>
163&lt;mode&gt;</p>
164
165<p style="margin-left:17%;">Sets the layout mode of the
166focused container. <i>mode</i> can be one of <i>splith</i>,
167<i>splitv</i>, or <i>toggle split</i>.</p>
168
169<p style="margin-left:11%; margin-top: 1em"><b>move</b>
170&lt;left|right|up|down&gt;</p>
171
172<p style="margin-left:17%;">Moves the focused container
173<i>left</i>, <i>right</i>, <i>up</i>, or <i>down</i>.</p>
174
175<p style="margin-left:11%; margin-top: 1em"><b>output</b>
176&lt;name&gt; &lt;resolution|res WIDTHxHEIGHT&gt;
177&lt;position|pos X,Y&gt;</p>
178
179<p style="margin-left:17%;">Configures the specified
180output. It will use the given resolution and be arranged at
181the given position in the layout tree. You may omit either
182of these parameters if you only want to set one of them.</p>
183
184
185<p style="margin-left:11%; margin-top: 1em"><b>reload</b></p>
186
187<p style="margin-left:17%;">Reloads the sway config file
188without restarting sway.</p>
189
190<p style="margin-left:11%; margin-top: 1em"><b>resize</b>
191&lt;shrink|grow&gt; &lt;width|height&gt; &lt;amount&gt;</p>
192
193<p style="margin-left:17%;">Resizes the currently focused
194container or view by <i>amount</i>. <i>amount</i> can be
195specified as &quot;n px&quot; or &quot;n ppt&quot; or
196&quot;n px or n ppt&quot;.</p>
197
198<p style="margin-left:11%; margin-top: 1em"><b>set</b>
199&lt;name&gt; &lt;value&gt;</p>
200
201<p style="margin-left:17%;">Creates a substitution for
202<i>value</i> that can be used with $<i>name</i> in other
203commands.</p>
204
205<p style="margin-left:11%; margin-top: 1em"><b>split</b>
206&lt;vertical|v|horizontal|h&gt;</p>
207
208<p style="margin-left:17%;">Splits the current container,
209vertically or horiziontally.</p>
210
211
212<p style="margin-left:11%; margin-top: 1em"><b>splith</b></p>
213
214<p style="margin-left:17%;">Equivalent to <b>split
215horizontal</b>.</p>
216
217
218<p style="margin-left:11%; margin-top: 1em"><b>splitv</b></p>
219
220<p style="margin-left:17%;">Equivalent to <b>split
221vertical</b>.</p>
222
223
224<p style="margin-left:11%; margin-top: 1em"><b>workspace</b>
225&lt;name&gt;</p>
226
227<p style="margin-left:17%;">Switches to the specified
228workspace.</p>
229
230
231<p style="margin-left:11%; margin-top: 1em"><b>workspace</b>
232&lt;prev_on_output|next_on_output&gt;</p>
233
234<p style="margin-left:17%;">Switches to the next workspace
235on the current output.</p>
236
237
238<p style="margin-left:11%; margin-top: 1em"><b>workspace</b>
239&lt;name&gt; output &lt;output&gt;</p>
240
241<p style="margin-left:17%;">Specifies that the workspace
242named <i>name</i> should appear on the specified
243<i>output</i>.</p>
244<hr>
245</body>
246</html>
generated by cgit v1.2.3-54-g00ecf (git 2.45.0) at 2024-05-04 22:36:29 +0000