i3-compatible Wayland compositor
Go to file
Pedro Côrte-Real 075845ceb2 Use wlroots 0.12.0 for v1.5 CI
While inside the v1.5 branch make sure we stay on wlroots 0.12.0 so that
the build doesn't fail.
2021-05-19 11:48:08 +02:00
.builds Use wlroots 0.12.0 for v1.5 CI 2021-05-19 11:48:08 +02:00
.github Update .github/FUNDING.yml 2019-10-11 19:36:58 -04:00
assets License wallpapers as CC-0 2019-12-16 14:35:58 -05:00
client Rename symbol set_cloexec to sway_set_cloexec, remove duplicates. 2019-11-01 12:41:08 -04:00
common common/util: fix `get_current_time_msec` returning microseconds 2020-06-06 13:38:41 +02:00
completions i3-compat: add GET_BINDING_STATE IPC command 2020-06-14 00:55:14 -04:00
contrib Add check for empty GEOM variable 2020-07-15 19:27:13 +02:00
include config/output: don't change output state before commit 2020-07-15 19:27:12 +02:00
protocols protocols: sync wlr-layer-shell-unstable-v1 with wlroots 2020-07-15 19:27:12 +02:00
sway view: Set parent for view_child subsurfaces on init 2021-05-19 11:48:08 +02:00
swaybar swaybar: ensure correct init order for status_line 2020-06-12 14:45:40 +02:00
swaymsg Add note on quoting to swaymsg manpage 2020-07-15 19:27:13 +02:00
swaynag swaynag: sway_abort on failure to properly register 2020-06-10 15:50:31 +02: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 Allocate minimum size necessary in pango text functions. (#3473) 2019-01-20 15:03:30 +01:00
CONTRIBUTING.md CONTRIBUTING.md: mention tab width for line length 2019-01-14 19:46:54 +01:00
ISSUE_TEMPLATE.md ISSUE_TEMPLATE: note debug logs should be from TTY 2020-04-29 08:33:20 +02:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
README.de.md Add link to i3 in first mention of README 2019-04-27 17:28:24 -06:00
README.dk.md add danish README 2020-01-27 11:31:41 -07:00
README.es.md Add link to i3 in first mention of README 2019-04-27 17:28:24 -06:00
README.fr.md Add link to i3 in first mention of README 2019-04-27 17:28:24 -06:00
README.ja.md Add link to i3 in first mention of README 2019-04-27 17:28:24 -06:00
README.ko.md Add Korean README.md 2020-05-01 11:45:11 +02:00
README.md Add Romanian translation 2020-06-23 22:59:27 +02:00
README.nl.md Added Dutch translation of README 2019-07-17 12:36:52 -04:00
README.pl.md Add link to i3 in first mention of README 2019-04-27 17:28:24 -06:00
README.pt.md fix typo 2020-02-04 19:02:27 +01:00
README.ro.md Add Romanian translation 2020-06-23 22:59:27 +02:00
README.ru.md Add Russian translation of the README 2019-09-09 19:09:57 +03:00
README.uk.md Add link to i3 in first mention of README 2019-04-27 17:28:24 -06:00
README.zh-CN.md Add link to i3 in first mention of README 2019-04-27 17:28:24 -06:00
README.zh-TW.md Add Chinese (zh-TW) translation of README 2019-12-30 09:45:06 +01:00
config.in rephrase swayidle-timout example to improve readability 2020-07-15 19:27:13 +02:00
meson.build build: bump version to 1.5.1 2020-11-10 17:47:31 +01:00
meson_options.txt Set version in project file 2019-02-05 14:32:05 +01:00
sway.desktop Update language in sway.desktop & sway(1) 2019-03-10 15:09:52 -04:00

README.md

sway

English - 日本語 - Français - Українська - Español - Polski - 中文-简体 - Deutsch - Nederlands - Русский- 中文-繁體 - Português - Danish - 한국어 - Română

sway is an 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
  • wayland-protocols *
  • pcre
  • json-c
  • pango
  • cairo
  • gdk-pixbuf2 (optional: system tray)
  • scdoc (optional: man pages) *
  • git (optional: version info) *

*Compile-time dep

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