sway/README.md

91 lines
3.2 KiB
Markdown
Raw Normal View History

# 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)
2015-08-09 01:39:55 +02:00
2016-11-10 04:26:14 +01:00
"**S**irCmpwn's **Way**land compositor" is a **work in progress**
i3-compatible [Wayland](http://wayland.freedesktop.org/) compositor.
2015-11-27 15:16:48 +01: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).
2015-08-09 01:39:55 +02:00
2016-08-02 14:50:03 +02:00
[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png)
2015-08-09 01:39:55 +02:00
2016-10-13 05:56:41 +02:00
[More screenshots](https://github.com/SirCmpwn/sway/wiki/Screenshots-of-Sway)
2016-03-24 19:24:43 +01:00
## Release Signatures
2015-08-09 01:39:55 +02:00
2016-03-25 16:21:21 +01:00
Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A)
2016-03-24 19:24:43 +01:00
and published [on GitHub](https://github.com/SirCmpwn/sway/releases).
2015-08-09 01:39:55 +02:00
## 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)
2015-08-09 01:39:55 +02:00
2015-08-16 16:21:04 +02:00
## Installation
2015-08-18 22:16:13 +02:00
### 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)
2015-08-16 16:21:04 +02:00
For other distros, [see this wiki page](https://github.com/SirCmpwn/sway/wiki/Install-from-packages#unofficial-packages).
2016-03-25 20:52:18 +01: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.
2015-08-18 22:16:13 +02:00
### Compiling from Source
2015-08-09 01:39:55 +02:00
2015-08-18 22:16:13 +02:00
Install dependencies:
2015-08-09 01:39:55 +02:00
* cmake
* [wlc](https://github.com/Cloudef/wlc)
* wayland
2015-08-16 16:04:51 +02:00
* xwayland
2016-12-17 19:25:25 +01:00
* libcap
2015-08-18 03:27:52 +02:00
* asciidoc
2015-09-01 10:15:09 +02:00
* 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_
2015-09-01 10:15:09 +02:00
2015-08-18 22:16:13 +02:00
Run these commands:
2015-08-16 16:07:56 +02:00
2015-12-01 20:14:27 +01:00
mkdir build
cd build
2015-12-27 17:09:28 +01:00
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_SYSCONFDIR=/etc ..
2015-08-09 01:39:55 +02:00
make
2015-08-18 22:16:13 +02:00
sudo make install
sudo setcap cap_sys_ptrace=eip /usr/local/bin/sway
2015-08-09 01:39:55 +02:00
2015-11-29 16:18:02 +01:00
On systems without logind, you need to suid the sway binary:
sudo chmod a+s /usr/local/bin/sway
2015-11-29 16:18:02 +01:00
2015-08-09 01:39:55 +02:00
## Configuration
2015-08-18 22:16:13 +02:00
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.
2015-08-09 01:39:55 +02:00
2016-05-29 18:13:15 +02: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.
2015-08-09 01:39:55 +02:00
## Running
2015-11-27 15:16:48 +01:00
Instead of running `startx`, run `sway`. You can run `sway` from within X as
well, which is useful for testing.