summaryrefslogtreecommitdiffstats
path: root/sway-1.html
diff options
context:
space:
mode:
Diffstat (limited to 'sway-1.html')
-rw-r--r--sway-1.html169
1 files changed, 169 insertions, 0 deletions
diff --git a/sway-1.html b/sway-1.html
new file mode 100644
index 00000000..82a26a11
--- /dev/null
+++ b/sway-1.html
@@ -0,0 +1,169 @@
1<!-- Creator : groff version 1.22.3 -->
2<!-- CreationDate: Sun Aug 23 20:47:38 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="#SYNOPSIS">SYNOPSIS</a><br>
27<a href="#OPTIONS">OPTIONS</a><br>
28<a href="#DESCRIPTION">DESCRIPTION</a><br>
29<a href="#COMMANDS">COMMANDS</a><br>
30<a href="#CONFIGURATION">CONFIGURATION</a><br>
31<a href="#AUTHORS">AUTHORS</a><br>
32<a href="#SEE ALSO">SEE ALSO</a><br>
33
34<hr>
35
36
37<h2>NAME
38<a name="NAME"></a>
39</h2>
40
41
42<p style="margin-left:11%; margin-top: 1em">sway &minus;
43SirCmpwn's Wayland window manager</p>
44
45<h2>SYNOPSIS
46<a name="SYNOPSIS"></a>
47</h2>
48
49
50<p style="margin-left:11%; margin-top: 1em"><i>sway</i>
51[options] [command]</p>
52
53<h2>OPTIONS
54<a name="OPTIONS"></a>
55</h2>
56
57
58<p style="margin-left:11%; margin-top: 1em"><b>&minus;c,
59&minus;&minus;config</b> &lt;config&gt;</p>
60
61<p style="margin-left:17%;">Specifies a config file.</p>
62
63<p style="margin-left:11%; margin-top: 1em"><b>&minus;C,
64&minus;&minus;validate</b></p>
65
66<p style="margin-left:17%;">Check the validity of the
67config file, then exit.</p>
68
69<p style="margin-left:11%; margin-top: 1em"><b>&minus;d,
70&minus;&minus;debug</b></p>
71
72<p style="margin-left:17%;">Enables full logging, including
73debug information.</p>
74
75<p style="margin-left:11%; margin-top: 1em"><b>&minus;v,
76&minus;&minus;version</b></p>
77
78<p style="margin-left:17%;">Show the version number and
79quit.</p>
80
81<p style="margin-left:11%; margin-top: 1em"><b>&minus;V,
82&minus;&minus;verbose</b></p>
83
84<p style="margin-left:17%;">Enables more verbose
85logging.</p>
86
87
88<p style="margin-left:11%; margin-top: 1em"><b>&minus;&minus;get&minus;socketpath</b></p>
89
90<p style="margin-left:17%;">Gets the IPC socket path and
91prints it, then exits.</p>
92
93<h2>DESCRIPTION
94<a name="DESCRIPTION"></a>
95</h2>
96
97
98<p style="margin-left:11%; margin-top: 1em">sway was
99created to fill the need of an i3&minus;like window manager
100for Wayland. The upstream i3 developers have no intention of
101porting i3 to Wayland, and projects proposed by others ended
102up as vaporware. Many thanks to the i3 folks for providing
103such a great piece of software, so good that your users
104would rather write an entirely new window manager from
105scratch that behaved <i>exactly</i> like i3 rather than
106switch to something else.</p>
107
108<p style="margin-left:11%; margin-top: 1em">You may run
109sway from an ongoing x11 session to run it within x.
110Otherwise, you can run sway on a tty and it will use your
111outputs directly.</p>
112
113<p style="margin-left:11%; margin-top: 1em"><b>Important
114note for nvidia users</b>: The proprietary nvidia driver
115does <i>not</i> have support for Wayland as of
1162015&minus;08&minus;17. Use nouveau.</p>
117
118<h2>COMMANDS
119<a name="COMMANDS"></a>
120</h2>
121
122
123<p style="margin-left:11%; margin-top: 1em">If sway is
124currently running, you may run <i>sway [command]</i> to send
125<i>command</i> to the running instance of sway. The same
126commands you would use in the config file are valid here
127(see <b>sway</b>(5)). For compatability reasons, you may
128also issue commands with <b>sway&minus;msg</b>(1) or
129<b>i3&minus;msg</b>(1) (or even with <b>i3</b>(1),
130probably).</p>
131
132<h2>CONFIGURATION
133<a name="CONFIGURATION"></a>
134</h2>
135
136
137<p style="margin-left:11%; margin-top: 1em">If
138<i>&minus;c</i> is not specified, sway will look in several
139locations for your config file. The default one is provided
140at /etc/sway/config. The suggested location for your config
141file is ~/.config/sway/config. ~/.sway/config will also
142work, and the rest of the usual XDG config locations are
143supported. If no sway config is found, sway will attempt to
144load an i3 config from all the config locations i3 supports.
145If still nothing is found, you will receive an error.</p>
146
147<p style="margin-left:11%; margin-top: 1em">For information
148on the config file format, see <b>sway</b>(5).</p>
149
150<h2>AUTHORS
151<a name="AUTHORS"></a>
152</h2>
153
154
155<p style="margin-left:11%; margin-top: 1em">Maintained by
156Drew DeVault &lt;sir@cmpwn.com&gt;, who is assisted by other
157open source contributors. For more information about sway
158development, see https://github.com/SirCmpwn/sway.</p>
159
160<h2>SEE ALSO
161<a name="SEE ALSO"></a>
162</h2>
163
164
165
166<p style="margin-left:11%; margin-top: 1em"><b>sway</b>(5)</p>
167<hr>
168</body>
169</html>