sway/README.md

# sway [![](https://api.travis-ci.org/SirCmpwn/sway.svg)](https://travis-ci.org/SirCmpwn/sway) [![Donate with fosspay](https://drewdevault.com/donate/static/donate-with-fosspay.png)](https://drewdevault.com/donate?project=4)

"**S**irCmpwn's **Way**land compositor" is a **work in progress**
i3-compatible [Wayland](http://wayland.freedesktop.org/) compositor.
Read the [FAQ](https://github.com/SirCmpwn/sway/wiki). Join the
[IRC channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on
irc.freenode.net).

[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png)

[More screenshots](https://github.com/SirCmpwn/sway/wiki/Screenshots-of-Sway)

## Release Signatures

Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A)
and published [on GitHub](https://github.com/SirCmpwn/sway/releases).

## Status

- [i3 feature support](https://github.com/SirCmpwn/sway/issues/2)
- [IPC feature support](https://github.com/SirCmpwn/sway/issues/98)
- [i3bar feature support](https://github.com/SirCmpwn/sway/issues/343)
- [i3-gaps feature support](https://github.com/SirCmpwn/sway/issues/307)
- [security features](https://github.com/SirCmpwn/sway/issues/984)

## Installation

### From Packages

* [Arch Linux](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#arch)
* [Fedora](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#fedora)
* [Gentoo](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#gentoo)
* [NixOS](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#nixos)
* [openSUSE Tumbleweed](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#opensuse)

For other distros, [see this wiki page](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#unofficial-packages).
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](https://github.com/Cloudef/wlc)
* wayland
* xwayland
* 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
    sudo setcap cap_sys_ptrace=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.

My own dotfiles are available [here](https://gogs.sr.ht/SirCmpwn/dotfiles) if
you want some inspiration, and definitely check out the
[wiki](https://github.com/SirCmpwn/sway/wiki) as well.

## Running

Instead of running `startx`, run `sway`. You can run `sway` from within X as
well, which is useful for testing.
Revert "Remove build badge (Travis is broken, not sway)" This reverts commit 297d8b3f02a97c8b23fedd4185016e785f7e2fda. 2015-12-03 12:35:21 +00:00			`# sway [![](https://api.travis-ci.org/SirCmpwn/sway.svg)](https://travis-ci.org/SirCmpwn/sway) [![Donate with fosspay](https://drewdevault.com/donate/static/donate-with-fosspay.png)](https://drewdevault.com/donate?project=4)`
Add readme 2015-08-08 23:39:55 +00:00
Minor README.md improvements 2016-11-10 03:26:14 +00:00			`"SirCmpwn's Wayland compositor" is a work in progress`
			`i3-compatible [Wayland](http://wayland.freedesktop.org/) compositor.`
Write down style guidelines 2015-11-27 14:16:48 +00:00			`Read the [FAQ](https://github.com/SirCmpwn/sway/wiki). Join the`
			`[IRC channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on`
			`irc.freenode.net).`
Add readme 2015-08-08 23:39:55 +00:00
Update README.md screenshot 2016-08-02 12:50:03 +00:00			`[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png)`
Add readme 2015-08-08 23:39:55 +00:00
Add screenshots wiki page to readme 2016-10-13 03:56:41 +00:00			`[More screenshots](https://github.com/SirCmpwn/sway/wiki/Screenshots-of-Sway)`

Update README 2016-03-24 18:24:43 +00:00			`## Release Signatures`
Add readme 2015-08-08 23:39:55 +00:00
Fix link to PGP key 2016-03-25 15:21:21 +00:00			`Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A)`
Update README 2016-03-24 18:24:43 +00:00			`and published [on GitHub](https://github.com/SirCmpwn/sway/releases).`
Add readme 2015-08-08 23:39:55 +00:00
			`## Status`

Add references to other feature support issues to README 2015-12-24 03:49:05 +00:00			`- [i3 feature support](https://github.com/SirCmpwn/sway/issues/2)`
			`- [IPC feature support](https://github.com/SirCmpwn/sway/issues/98)`
			`- [i3bar feature support](https://github.com/SirCmpwn/sway/issues/343)`
			`- [i3-gaps feature support](https://github.com/SirCmpwn/sway/issues/307)`
Add link to security features issue in readme 2016-12-04 14:52:38 +00:00			`- [security features](https://github.com/SirCmpwn/sway/issues/984)`
Add readme 2015-08-08 23:39:55 +00:00
Mention aur package in readme 2015-08-16 14:21:04 +00:00			`## Installation`

Improve README 2015-08-18 20:16:13 +00:00			`### From Packages`

Packages link to the wiki page with instructions I wanted to make sure that NixOS users get the warning without polluting the README. Turns out the "Install other distros" had plenty to say about supported packages, so I slightly restructured the page. Now the README links to the wiki page. 2016-07-18 05:00:17 +00:00			`* [Arch Linux](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#arch)`
Add Fedora official packages mention :) 2016-09-01 06:40:26 +00:00			`* [Fedora](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#fedora)`
Packages link to the wiki page with instructions I wanted to make sure that NixOS users get the warning without polluting the README. Turns out the "Install other distros" had plenty to say about supported packages, so I slightly restructured the page. Now the README links to the wiki page. 2016-07-18 05:00:17 +00:00			`* [Gentoo](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#gentoo)`
			`* [NixOS](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#nixos)`
			`* [openSUSE Tumbleweed](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#opensuse)`
Mention aur package in readme 2015-08-16 14:21:04 +00:00
Packages link to the wiki page with instructions I wanted to make sure that NixOS users get the warning without polluting the README. Turns out the "Install other distros" had plenty to say about supported packages, so I slightly restructured the page. Now the README links to the wiki page. 2016-07-18 05:00:17 +00:00			`For other distros, [see this wiki page](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#unofficial-packages).`
Update README.md packaging info 2016-03-25 19:52:18 +00:00			`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.`

Improve README 2015-08-18 20:16:13 +00:00			`### Compiling from Source`
Add readme 2015-08-08 23:39:55 +00:00
Improve README 2015-08-18 20:16:13 +00:00			`Install dependencies:`
Add readme 2015-08-08 23:39:55 +00:00
			`* cmake`
			`* [wlc](https://github.com/Cloudef/wlc)`
Add new dependencies for wayland clients Cairo for rendering shit, Pango for text rendering, and wayland client stuff. Thanks @Cloudef, blatantly ripping off his cmake files for this 2015-11-12 13:17:52 +00:00			`* wayland`
Improve readme 2015-08-16 14:04:51 +00:00			`* xwayland`
Document asciidoc dependency 2015-08-18 01:27:52 +00:00			`* asciidoc`
Updated readme dependency list 2015-09-01 08:15:09 +00:00			`* pcre`
			`* json-c`
Set Cairo and Pango as required dependencies 2016-05-14 19:18:44 +00:00			`* pango`
			`* cairo`
Make some dependencies optional Closes #368 2015-12-20 14:14:30 +00:00			`* gdk-pixbuf2 *`
			`* pam **`
Add ffmpeg/imagemagick to depenency list 2016-01-17 19:04:15 +00:00			`* imagemagick (required for image capture with swaygrab)`
			`* ffmpeg (required for video capture with swaygrab)`
Make some dependencies optional Closes #368 2015-12-20 14:14:30 +00:00
			`_\*Only required for swaybar, swaybg, and swaylock_`

			`_\\Only required for swaylock_`
Updated readme dependency list 2015-09-01 08:15:09 +00:00
Improve README 2015-08-18 20:16:13 +00:00			`Run these commands:`
Improve readme 2015-08-16 14:07:56 +00:00
cmake: use out-of-source build 2015-12-01 19:14:27 +00:00			`mkdir build`
			`cd build`
Update README 2015-12-27 16:09:28 +00:00			`cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_SYSCONFDIR=/etc ..`
Add readme 2015-08-08 23:39:55 +00:00			`make`
Improve README 2015-08-18 20:16:13 +00:00			`sudo make install`
Mention setcap in manual install instructions 2016-12-04 14:59:25 +00:00			`sudo setcap cap_sys_ptrace=eip /usr/local/bin/sway`
Add readme 2015-08-08 23:39:55 +00:00
Add suid instructions to readme 2015-11-29 15:18:02 +00:00			`On systems without logind, you need to suid the sway binary:`

Fix wrong path to sway executable Fixed path to sway in chmod (line 58) 2015-12-13 21:40:14 +00:00			`sudo chmod a+s /usr/local/bin/sway`
Add suid instructions to readme 2015-11-29 15:18:02 +00:00
Add readme 2015-08-08 23:39:55 +00:00			`## Configuration`

Improve README 2015-08-18 20:16:13 +00:00			If you already use i3, then copy your i3 config to `~/.config/sway/config` and
Can customize config fallback directory CMake takes a `FALLBACK_CONFIG_DIR` flag which is the directory where the standard configuration file `config` is copied at installation. If loading from typical configuration directories fails, sway loads FALLBACK_CONFIG_DIR/config (/etc/sway/config by default). 2015-11-30 23:38:23 +00:00			`it'll work out of the box. Otherwise, copy the sample configuration file to`
Use SYSCONFDIR as recommended - swaylock config path not hardcoded anymore - the unusual and weird FALLBACK_CONFIG_DIR is no more 2015-12-23 11:22:48 +00:00			`~/.config/sway/config`. It is usually located at `/etc/sway/config`.
			Run `man 5 sway` for information on the configuration.
Add readme 2015-08-08 23:39:55 +00:00
Update configuration info in readme 2016-05-29 16:13:15 +00:00			`My own dotfiles are available [here](https://gogs.sr.ht/SirCmpwn/dotfiles) if`
			`you want some inspiration, and definitely check out the`
			`[wiki](https://github.com/SirCmpwn/sway/wiki) as well.`

Add readme 2015-08-08 23:39:55 +00:00			`## Running`

Write down style guidelines 2015-11-27 14:16:48 +00:00			Instead of running `startx`, run `sway`. You can run `sway` from within X as
			`well, which is useful for testing.`