swayfx/README.md

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