i3-compatible Wayland compositor
Go to file
Drew DeVault 78740b9785
Merge pull request #1801 from bobsaintcool/r0.15/man/scale_typo
<sway/man: In sway(5) treat scale as keyword for output command>
2018-04-12 11:06:49 -04:00
CMake Merge pull request #1438 from mariusor/explicit_json-c_version 2017-10-30 17:23:35 -04:00
assets Recompressed PNG files 2017-01-05 21:49:28 -05:00
common restore errno 2018-03-27 19:33:59 -07:00
completions/zsh Rework get_clipboard implementation 2017-07-07 21:51:34 +02:00
contrib Move awesome config to contrib/ 2017-01-14 16:03:41 -05:00
include swaybar: correctly render min_width for strings 2018-03-27 06:56:09 +00:00
protocols Implement KDE's server-side decoration protocol 2017-04-28 20:32:05 -04:00
security.d security: enabled ipc on freebsd 2017-07-24 18:38:04 +02:00
sway <sway/man: In sway(5) treat scale as keyword for output command> 2018-04-12 14:59:57 +00:00
swaybar swaybar: correctly render min_width for strings 2018-03-27 06:56:09 +00:00
swaybg Fix segfault if swaybg is run without Wayland 2018-02-19 15:04:51 -08:00
swaygrab Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
swaylock Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
swaymsg Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
wayland Fix typo in debug log 2017-08-03 13:00:06 +02:00
.build.yml Make asciidoc (and man pages) optional 2017-07-04 16:02:54 -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 remove archive from git, add *.a to gitignore 2015-12-03 15:52:21 +02:00
.travis.yml Enable docker service in travis 2018-03-03 16:36:25 +01:00
CMakeLists.txt Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
CONTRIBUTING.md Update README et al with new links 2017-10-02 22:26:37 -04:00
HACKING.md Add HACKING.md 2017-04-29 10:54:08 -04:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
README.de.md Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
README.el.md Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
README.fr.md Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
README.it.md Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
README.ja.md Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
README.md Merge remote-tracking branch 'remotes/origin/bugfix/iconsnotfound' into 0.15 2018-03-24 19:05:12 -04:00
README.pt.md Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
README.ru.md Merge remote-tracking branch 'remotes/origin/bugfix/iconsnotfound' into 0.15 2018-03-24 19:05:12 -04:00
README.uk.md Adaptions for API change in json-c v0.13 2017-12-17 15:53:22 -05:00
config.in Install wallpapers in DATADIR/backgrounds/sway 2017-06-14 22:30:42 -05:00
sway.desktop Add Wayland and Xorg session files 2015-08-20 23:12:34 +02:00

README.md

sway Donate with fosspay

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: Sway is currently frozen and no new features are being shipped until we finish integrating Sway and wlroots. Bug fixes are still going out. for more information, see this article. To follow wlroots integration status, see this ticket.

If you'd like to support Sway development, you can contribute to SirCmpwn's Patreon page or you can contribute to bounties for specific features. Anyone is welcome to claim a bounty and you can make a bounty for any feature you wish, and Patreon is more useful for supporting the overall health and maintenance of Sway.

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:

  • cmake
  • wlc
  • wayland
  • xwayland
  • libinput >= 1.6.0
  • libcap
  • asciidoc
  • pcre
  • json-c
  • pango
  • cairo
  • gdk-pixbuf2 *
  • pam **
  • dbus >= 1.10 ***
  • imagemagick (required for image capture with swaygrab)
  • ffmpeg (required for video capture with swaygrab)

*Only required for swaybar, swaybg, and swaylock

**Only required for swaylock

***Only required for tray support

Run these commands:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_SYSCONFDIR=/etc ..
make
sudo make 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).