i3-compatible Wayland compositor
Go to file
Drew DeVault bec982bba6
Merge pull request #2289 from frsfnrrg/memory-fixes
Fix memory leaks and reference to uninitialized
2018-07-17 08:46:53 -07:00
assets Recompressed PNG files 2017-01-05 21:49:28 -05:00
client Set pool_buffers busy when handing them out 2018-06-17 17:34:12 -04:00
common Move floating windows to front when focused 2018-07-11 19:50:02 +10:00
completions/zsh Remove `clipboard` command and `get_clipboard` message 2018-07-10 22:09:21 +01:00
contrib Move awesome config to contrib/ 2017-01-14 16:03:41 -05:00
include Implement default_floating_border command and adjust CSD behaviour 2018-07-17 10:14:33 +10:00
protocols Swaylock: Allow per-output images 2018-05-20 22:54:09 +10:00
security.d Revert "security.d: Update install paths for swaybar and swaybg" 2018-05-06 00:19:12 +01:00
sway Fix memory leak in sway/desktop/idle_inhibit_v1.c 2018-07-17 11:35:24 -04:00
swaybar swaybar: Read urgent colors from IPC 2018-07-17 08:29:43 +10:00
swaybg swaybar/bg: Fix crash on DPMS off 2018-07-14 00:04:02 +02:00
swayidle swayidle: cleanup 2018-07-16 22:20:53 +01:00
swaylock Switch to using getopt_long for config flag 2018-07-16 12:17:40 -04:00
swaymsg Remove `clipboard` command and `get_clipboard` message 2018-07-10 22:09:21 +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 Update for swaywm/wlroots#1126 2018-07-09 22:54:30 +01:00
HACKING.md Update for swaywm/wlroots#1126 2018-07-09 22:54:30 +01:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
README.de.md Update README.md + README.*.md 2018-05-11 22:57:47 -04:00
README.el.md Update README.md + README.*.md 2018-05-11 22:57:47 -04:00
README.fr.md Fix typos 2018-05-12 08:58:48 -04:00
README.it.md Update README.md + README.*.md 2018-05-11 22:57:47 -04:00
README.ja.md Update README.md + README.*.md 2018-05-11 22:57:47 -04:00
README.md Update README.md + README.*.md 2018-05-11 22:57:47 -04:00
README.pt.md Update README.md + README.*.md 2018-05-11 22:57:47 -04:00
README.ru.md Update README.md + README.*.md 2018-05-11 22:57:47 -04:00
README.uk.md Update README.md + README.*.md 2018-05-11 22:57:47 -04:00
config.in Idle handling for dpms/lockscreen et al 2018-05-13 00:30:09 +02:00
meson.build Automatically float xwayland windows 2018-06-18 22:52:10 +01:00
meson_options.txt Revert "Make the LIBDIR path configurable" 2018-05-06 00:19:52 +01: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).

Notice: You are viewing the unstable and unsupported master branch of sway, where work is ongoing to port it to wlroots. The supported branch is the 0.15 branch, and end users are encouraged to use the stable releases cut from it.

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.

Status

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 ***
  • imagemagick (required for image capture with swaygrab)
  • ffmpeg (required for video capture with swaygrab)
  • 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 with logind, you need to set a few caps on the binary:

sudo setcap "cap_sys_ptrace,cap_sys_tty_config=eip" /usr/local/bin/sway

On systems without logind, you need to suid the sway binary:

sudo chmod a+s /usr/local/bin/sway

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