2018-03-04 22:37:48 +01:00
|
|
|
# sway
|
2015-08-09 01:39:55 +02:00
|
|
|
|
2020-01-23 20:22:53 +01:00
|
|
|
[**English**](https://github.com/swaywm/sway/blob/master/README.md#sway--) - [日本語](https://github.com/swaywm/sway/blob/master/README.ja.md#sway--) - [Français](https://github.com/swaywm/sway/blob/master/README.fr.md#sway--) - [Українська](https://github.com/swaywm/sway/blob/master/README.uk.md#sway--) - [Español](https://github.com/swaywm/sway/blob/master/README.es.md#sway--) - [Polski](https://github.com/swaywm/sway/blob/master/README.pl.md#sway--) - [中文-简体](https://github.com/swaywm/sway/blob/master/README.zh-CN.md#sway--) - [Deutsch](https://github.com/swaywm/sway/blob/master/README.de.md#sway--) - [Nederlands](https://github.com/swaywm/sway/blob/master/README.nl.md#sway--) - [Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--) - [中文-繁體](https://github.com/swaywm/sway/blob/master/README.zh-TW.md#sway--) - [Português](https://github.com/swaywm/sway/blob/master/README.pt.md#sway--)
|
2017-08-13 20:01:55 +02:00
|
|
|
|
2019-04-28 01:07:48 +02:00
|
|
|
sway is an [i3](https://i3wm.org/)-compatible [Wayland](http://wayland.freedesktop.org/) compositor.
|
2019-01-14 03:36:59 +01:00
|
|
|
Read the [FAQ](https://github.com/swaywm/sway/wiki). Join the [IRC
|
2019-01-05 19:14:10 +01:00
|
|
|
channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on
|
2015-11-27 15:16:48 +01:00
|
|
|
irc.freenode.net).
|
2015-08-09 01:39:55 +02:00
|
|
|
|
2018-04-13 02:22:27 +02:00
|
|
|
If you'd like to support sway development, please contribute to [SirCmpwn's
|
|
|
|
|
Patreon page](https://patreon.com/sircmpwn).
|
2016-10-13 05:56:41 +02:00
|
|
|
|
2016-03-24 19:24:43 +01:00
|
|
|
## Release Signatures
|
2015-08-09 01:39:55 +02:00
|
|
|
|
2016-03-25 16:21:21 +01:00
|
|
|
Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A)
|
2017-10-03 04:26:37 +02:00
|
|
|
and published [on GitHub](https://github.com/swaywm/sway/releases).
|
2015-08-09 01:39:55 +02:00
|
|
|
|
2015-08-16 16:21:04 +02:00
|
|
|
## Installation
|
|
|
|
|
|
2015-08-18 22:16:13 +02:00
|
|
|
### From Packages
|
|
|
|
|
|
2017-02-23 14:33:24 +01:00
|
|
|
Sway is available in many distributions. Try installing the "sway" package for
|
2017-10-03 04:26:37 +02:00
|
|
|
yours. If it's not available, check out [this wiki page](https://github.com/swaywm/sway/wiki/Unsupported-packages)
|
2017-02-23 14:33:24 +01:00
|
|
|
for information on installation for your distributions.
|
2015-08-16 16:21:04 +02:00
|
|
|
|
2018-04-13 02:22:27 +02:00
|
|
|
If you're interested in packaging sway for your distribution, stop by the IRC
|
2016-03-25 20:52:18 +01:00
|
|
|
channel or shoot an email to sir@cmpwn.com for advice.
|
|
|
|
|
|
2015-08-18 22:16:13 +02:00
|
|
|
### Compiling from Source
|
2015-08-09 01:39:55 +02:00
|
|
|
|
2015-08-18 22:16:13 +02:00
|
|
|
Install dependencies:
|
2015-08-09 01:39:55 +02:00
|
|
|
|
2018-11-02 18:47:33 +01:00
|
|
|
* meson \*
|
2017-11-19 23:05:09 +01:00
|
|
|
* [wlroots](https://github.com/swaywm/wlroots)
|
2015-11-12 14:17:52 +01:00
|
|
|
* wayland
|
2018-11-02 18:47:33 +01:00
|
|
|
* wayland-protocols \*
|
2015-09-01 10:15:09 +02:00
|
|
|
* pcre
|
2018-11-02 18:47:33 +01:00
|
|
|
* json-c
|
2016-05-14 21:18:44 +02:00
|
|
|
* pango
|
|
|
|
|
* cairo
|
2019-04-25 17:23:37 +02:00
|
|
|
* gdk-pixbuf2 (optional: system tray)
|
2019-03-04 16:25:34 +01:00
|
|
|
* [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional: man pages) \*
|
2018-11-02 18:47:33 +01:00
|
|
|
* git \*
|
2015-12-20 15:14:30 +01:00
|
|
|
|
2018-11-02 18:47:33 +01:00
|
|
|
_\*Compile-time dep_
|
2015-12-20 15:14:30 +01:00
|
|
|
|
2015-08-18 22:16:13 +02:00
|
|
|
Run these commands:
|
2015-08-16 16:07:56 +02:00
|
|
|
|
2017-12-01 11:21:03 +01:00
|
|
|
meson build
|
|
|
|
|
ninja -C build
|
|
|
|
|
sudo ninja -C build install
|
2017-03-28 13:45:16 +02:00
|
|
|
|
2015-11-29 16:18:02 +01:00
|
|
|
On systems without logind, you need to suid the sway binary:
|
|
|
|
|
|
2015-12-13 22:40:14 +01:00
|
|
|
sudo chmod a+s /usr/local/bin/sway
|
2015-11-29 16:18:02 +01:00
|
|
|
|
2018-08-08 17:40:33 +02:00
|
|
|
Sway will drop root permissions shortly after startup.
|
|
|
|
|
|
2015-08-09 01:39:55 +02:00
|
|
|
## Configuration
|
|
|
|
|
|
2015-08-18 22:16:13 +02:00
|
|
|
If you already use i3, then copy your i3 config to `~/.config/sway/config` and
|
2015-12-01 00:38:23 +01:00
|
|
|
it'll work out of the box. Otherwise, copy the sample configuration file to
|
2015-12-23 12:22:48 +01:00
|
|
|
`~/.config/sway/config`. It is usually located at `/etc/sway/config`.
|
|
|
|
|
Run `man 5 sway` for information on the configuration.
|
2015-08-09 01:39:55 +02:00
|
|
|
|
|
|
|
|
## Running
|
|
|
|
|
|
2017-08-13 20:01:55 +02:00
|
|
|
Run `sway` from a TTY. Some display managers may work but are not supported by
|
2018-04-13 02:22:27 +02:00
|
|
|
sway (gdm is known to work fairly well).
|
