i3-compatible Wayland compositor
Go to file
Drew DeVault 135f0fc7e7 Update README.MD (and README.*.md) 2018-10-14 10:33:38 -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 swaybg: fix increasingly smaller bg on hotplug 2018-09-23 15:17:36 -04:00
completions added untested files 2018-08-26 18:53:51 +03:00
include swaybar: send signal to status when hiding or showing bar 2018-10-14 13:33:12 +01: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 Document `border csd` 2018-10-14 10:23:40 -04:00
swaybar swaybar: when hiding bar, save old height to be restored upon reshow 2018-10-14 13:33:12 +01:00
swaybg Add support for installing binaries with DT_RPATH 2018-09-30 15:37:01 +03:00
swayidle Add support for installing binaries with DT_RPATH 2018-09-30 15:37:01 +03:00
swaylock swaylock: fix clear_password_buffer 2018-10-14 07:40:33 +03:00
swaymsg Fix program name in version strings 2018-10-10 18:34:50 +10:00
swaynag swaynag: s/Toggle Details/Toggle details/ 2018-10-07 14:37:53 -04: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 CONTRIBUTING.md 2018-10-06 11:52:28 -04:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
README.bg.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.de.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.el.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.fr.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.it.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.ja.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.pt.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.ru.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
README.uk.md Update README.MD (and README.*.md) 2018-10-14 10:33:38 -04:00
config.in Add example status_command to default config 2018-10-08 22:23:55 +10:00
meson.build Fix swaylock w/shadow on glibc, improve security 2018-10-06 12:20:12 -04:00
meson_options.txt Add support for installing binaries with DT_RPATH 2018-09-30 15:37:01 +03: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).

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.

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).