i3-compatible Wayland compositor
Go to file
Drew DeVault e6a52ae387 Update stability notice in README 2018-09-21 08:51:50 -04:00
assets Recompressed PNG files 2017-01-05 21:49:28 -05:00
client Change _XOPEN_SOURCE defines to _POSIX_C_SOURCE 2018-09-03 09:08:49 +02:00
common swaybar: rewrite protocol determination 2018-09-18 11:36:33 +01:00
completions added untested files 2018-08-26 18:53:51 +03:00
contrib Move awesome config to contrib/ 2017-01-14 16:03:41 -05:00
include Merge pull request #2676 from ianyfan/ipc 2018-09-19 17:37:58 -04:00
protocols Update for swaywm/wlroots#1243 2018-09-14 19:21:44 +02:00
security.d delete references to swaygrab 2018-07-30 16:24:46 +01:00
sway Fix compilation against wlroots without X11 backend 2018-09-21 21:25:03 +10:00
swaybar swaybar: only free tokener when using i3bar protocol 2018-09-18 18:06:19 +01:00
swaybg Allow a fallback color to be specified for swaybg 2018-08-08 15:37:06 -04:00
swayidle delete references to swaygrab 2018-07-30 16:24:46 +01:00
swaylock Add FreeBSD-specific PAM configuration 2018-08-30 09:58:57 +02:00
swaymsg ipc: add tick event 2018-08-01 16:57:15 +01:00
swaynag Align titles to baseline 2018-09-08 16:25:07 +10:00
.build.yml Add scdoc to .build.yml 2018-05-11 21:40:52 -04:00
.clang-format Update .clang-format - not entirely usable yet 2017-01-10 23:30:34 -05:00
.editorconfig Create .editorconfig 2016-07-04 14:12:32 +02:00
.gitignore Add subprojects to gitignore 2018-03-28 12:22:28 -04:00
CONTRIBUTING.md Update for swaywm/wlroots#1126 2018-07-09 22:54:30 +01:00
HACKING.md Update for swaywm/wlroots#1126 2018-07-09 22:54:30 +01:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
README.bg.md spellcheck and help add. 2018-08-28 17:06:15 +03:00
README.de.md Remove setcap instructions 2018-08-08 11:40:33 -04:00
README.el.md Remove setcap instructions 2018-08-08 11:40:33 -04:00
README.fr.md Remove setcap instructions 2018-08-08 11:40:33 -04:00
README.it.md Remove setcap instructions 2018-08-08 11:40:33 -04:00
README.ja.md 私の日本語が上手じゃないですね 2018-08-08 11:53:11 -04:00
README.md Update stability notice in README 2018-09-21 08:51:50 -04:00
README.pt.md delete references to swaygrab 2018-07-30 16:24:46 +01:00
README.ru.md delete references to swaygrab 2018-07-30 16:24:46 +01:00
README.uk.md delete references to swaygrab 2018-07-30 16:24:46 +01:00
config.in config.in: nag user on exit 2018-08-02 15:42:43 +01:00
meson.build Merge remote-tracking branch 'upstream/master' into fix-freebsd-build 2018-09-03 08:57:17 +02:00
meson_options.txt fix window_type with disabled xwayland support 2018-09-03 11:17:07 +02:00
sway.desktop Add Wayland and Xorg session files 2015-08-20 23:12:34 +02:00

README.md

sway

English - 日本語 - Deutsch - Ελληνικά - Français - Українська - Italiano - Português - Русский - Български

"SirCmpwn's Wayland compositor" is a work in progress i3-compatible Wayland compositor. Read the FAQ. Join the IRC channel (#sway on irc.freenode.net).

Notice: work is well underway to port sway to wlroots. This is unstable and unsupported - we accept patches, but are not fond of bug reports. We are no longer accepting bugs for 0.15.

If you'd like to support sway development, please contribute to SirCmpwn's Patreon page.

Release Signatures

Releases are signed with B22DA89A and published on GitHub.

Status

Installation

From Packages

Sway is available in many distributions. Try installing the "sway" package for yours. If it's not available, check out this wiki page for information on installation for your distributions.

If you're interested in packaging sway for your distribution, stop by the IRC channel or shoot an email to sir@cmpwn.com for advice.

Compiling from Source

Install dependencies:

  • meson
  • wlroots
  • wayland
  • xwayland
  • libinput >= 1.6.0
  • libcap
  • pcre
  • json-c >= 0.13
  • pango
  • cairo
  • gdk-pixbuf2 *
  • pam **
  • dbus >= 1.10 ***
  • scdoc (required for man pages)

*Only required for swaybar, swaybg, and swaylock

**Only required for swaylock

***Only required for tray support

Run these commands:

meson build
ninja -C build
sudo ninja -C build install

On systems without logind, you need to suid the sway binary:

sudo chmod a+s /usr/local/bin/sway

Sway will drop root permissions shortly after startup.

Configuration

If you already use i3, then copy your i3 config to ~/.config/sway/config and it'll work out of the box. Otherwise, copy the sample configuration file to ~/.config/sway/config. It is usually located at /etc/sway/config. Run man 5 sway for information on the configuration.

Running

Run sway from a TTY. Some display managers may work but are not supported by sway (gdm is known to work fairly well).