i3-compatible Wayland compositor
Go to file
Drew DeVault be138dab44 Update version to 1.2 2019-08-27 13:46:22 +09:00
.builds Remove rootston from build manifests 2019-08-09 09:59:44 +09:00
.github Create FUNDING.yml 2019-05-25 12:35:43 -04:00
assets Recompressed PNG files 2017-01-05 21:49:28 -05:00
client swaybg: split into standalone project 2019-04-25 18:44:28 +03:00
common ipc-client: remove useless free for failed malloc 2019-08-20 13:27:52 +09:00
completions Add missing swaymsg completions 2019-03-08 15:28:35 -05:00
contrib Further refinements to _incr_version script 2019-08-27 13:41:54 +09:00
include input/keyboard: send released only if pressed sent 2019-08-27 09:37:10 +09:00
protocols Replace meson generator with custom_target 2019-06-24 09:38:41 +03:00
security.d delete references to swaygrab 2018-07-30 16:24:46 +01:00
sway cmd_mode: don't reset to default after subcommand 2019-08-27 13:46:18 +09:00
swaybar Fix memory leaks 2019-08-20 13:27:52 +09:00
swaymsg swaymsg.1: add tip about two hyphens for commands 2019-08-20 13:27:52 +09:00
swaynag check for empty string before calling strtoul() and check errno 2019-06-05 14:40:29 -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
CONTRIBUTING.md CONTRIBUTING.md: mention tab width for line length 2019-01-14 19:46:54 +01:00
ISSUE_TEMPLATE.md Add Firefox note to ISSUE_TEMPALTE.md 2019-05-06 15:32:37 -04: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.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.md Added Dutch translation of README 2019-07-17 12:36:52 -04: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.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
config.in Make comment casing consistient 2019-05-21 08:12:49 -06:00
meson.build Update version to 1.2 2019-08-27 13:46:22 +09: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

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 *

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