i3-compatible Wayland compositor
Go to file
Drew DeVault 5a0c4234b8
Merge pull request #3447 from emersion/remove-swaylock-includes
Remove swaylock headers and unicode.c
2019-01-17 08:13:19 -05: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 Remove unicode.c 2019-01-17 12:45:41 +01:00
completions Split swaylock into separate project 2019-01-13 21:40:26 -05:00
contrib A script to make inactive windows transparent 2018-10-20 21:58:00 +03:00
include Remove unicode.c 2019-01-17 12:45:41 +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 Don't use sh when spawning swaybg 2019-01-17 11:20:08 +01:00
swaybar Fixes for small existing bugs. 2019-01-16 13:02:26 +01:00
swaybg swaybg: use wl_surface_damage_buffer 2019-01-17 11:14:36 +01:00
swaymsg get_inputs: add libinput send events mode 2019-01-09 23:17:27 -05:00
swaynag Fixes for small existing bugs. 2019-01-16 13:02:26 +01: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 CONTRIBUTING.md: mention tab width for line length 2019-01-14 19:46:54 +01:00
ISSUE_TEMPLATE.md issue template: add instructions for stack traces 2018-12-17 18:38:15 +01:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
README.bg.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.de.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.el.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.fr.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.it.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.ja.md Merge pull request #3417 from swaywm/remove-swaylock 2019-01-14 08:57:20 +01:00
README.md Merge pull request #3417 from swaywm/remove-swaylock 2019-01-14 08:57:20 +01:00
README.pt.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.ru.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.uk.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
config.in config.in: update swayidle/swaylock example 2019-01-14 18:08:13 +01:00
meson.build Remove usage of VLAs. 2019-01-16 13:02:26 +01:00
meson_options.txt swaybar: add tray interface 2018-12-31 20:40:18 +00: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 - Русский - Български

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 **
  • scdoc (optional: man pages) *
  • git *

*Compile-time dep

**optional: required for swaybg

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