i3-compatible Wayland compositor
Go to file
Rouven Czerwinski 30afb6c14a ISSUE_TEMPLATE: the wiki is community maintained
Mention that the github wiki may contain outdated information scripts
and old workarounds and that sway the sway project does not provide
support for it.
2020-12-18 11:21:35 +01:00
.builds ci: fix archlinux builds 2020-12-14 10:15:55 +01:00
.github ISSUE_TEMPLATE: the wiki is community maintained 2020-12-18 11:21:35 +01: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/log: write log importance 2020-12-10 09:26:02 +01:00
completions i3-compat: add GET_BINDING_STATE IPC command 2020-06-14 00:55:14 -04:00
contrib contrib/_incr_version: Disallow the "v"-prefixed version format 2020-07-17 05:44:24 -06:00
include Fix swaybar tray for non-systemd 2020-12-16 21:19:20 +01:00
protocols protocols: sync wlr-layer-shell-unstable-v1 with wlroots 2020-07-05 09:58:39 +02:00
sway Route wlroots logs into Sway logging infrastructure 2020-12-09 23:57:12 -05:00
swaybar build: introduce sd-bus-provider option 2020-12-09 17:39:20 -05:00
swaymsg swaymsg.1: expand tip for multi-word strings. 2020-09-04 12:37:12 +02:00
swaynag swaynag: add details background option 2020-09-14 22:13:01 -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 Allocate minimum size necessary in pango text functions. (#3473) 2019-01-20 15:03:30 +01:00
config.in rephrase swayidle-timout example to improve readability 2020-07-12 14:29:49 +02:00
CONTRIBUTING.md CONTRIBUTING.md: mention tab width for line length 2019-01-14 19:46:54 +01:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
meson_options.txt build: add basu as sd-bus provider 2020-12-09 17:39:20 -05:00
meson.build build: add basu as sd-bus provider 2020-12-09 17:39:20 -05:00
README.de.md Fix minor typos in German README 2020-09-15 09:55:48 +02: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 Small wording change to README.ja.md 2020-11-16 14:08:59 -05:00
README.ko.md Add Korean README.md 2020-05-01 11:45:11 +02:00
README.md readme: remove link to non-existing wiki page 2020-12-18 11:12:14 +01: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-11-05 08:36:59 +01:00
README.ro.md Minor wording changes in Romanian README.md translation 2020-07-01 21:30:18 +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
sway.desktop Update language in sway.desktop & sway(1) 2019-03-10 15:09:52 -04:00

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 E88F5E48 and published on GitHub.

Installation

From Packages

Sway is available in many distributions. Try installing the "sway" package for yours.

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

Check out this wiki page if you want to build the HEAD of sway and wlroots for testing or development.

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