mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2024-12-28 07:56:31 +01:00
Code Issues Projects Releases Packages Wiki Activity
i3-compatible Wayland compositor
2358 commits 11 branches 96 tags 49 MiB
C 98.4%
Meson 1.2%
Shell 0.4%
Find a file
Drew DeVault c1582f981a Merge pull request #1324 from Hummer12007/patch-5 
Raise max ipc message size limit to 256 MB
2017-08-14 13:48:51 -04:00
assets Recompressed PNG files 2017-01-05 21:49:28 -05:00
CMake Make asciidoc (and man pages) optional 2017-07-04 16:02:54 -04:00
common FreeBSD fixes 2017-06-06 09:45:50 +02:00
completions/zsh Fix zsh completion for _swaylock 2017-07-03 21:30:13 +02:00
contrib Move awesome config to contrib/ 2017-01-14 16:03:41 -05:00
include Allow swaylock indicator size to be configurable 2017-07-31 19:49:01 +02: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 Raise max ipc message size limit to 256 MB 2017-08-14 20:43:37 +03:00
swaybar Prevent crash if DBus connection is NULL 2017-08-12 12:52:31 +02:00
swaybg swaybg: check that background can be loaded 2017-07-03 22:02:49 +01:00
swaygrab Make asciidoc (and man pages) optional 2017-07-04 16:02:54 -04:00
swaylock Clean up fallthrough issues 2017-08-09 18:34:51 -04:00
swaymsg Make asciidoc (and man pages) optional 2017-07-04 16:02:54 -04: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 Make asciidoc (and man pages) optional 2017-07-04 16:02:54 -04:00
CMakeLists.txt Re-enable implicit fallthrough warnings 2017-08-09 18:43:25 -04:00
config.in Install wallpapers in DATADIR/backgrounds/sway 2017-06-14 22:30:42 -05:00
CONTRIBUTING.md Fix broken link in CONTRIBUTING.md 2017-01-05 15:56:40 -07: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 Update READMEs 2017-08-14 11:56:58 -04:00
README.ja.md Translate README to Japanese / READMEを日本語訳す 2017-08-13 14:16:55 -04:00
README.md Update READMEs 2017-08-14 11:56:58 -04: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

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

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 **
  • 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

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=eip /usr/local/bin/sway
sudo setcap 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).