sway/README.md

106 lines
4.2 KiB
Markdown
Raw Normal View History

2017-10-03 02:26:37 +00:00
# sway [![](https://api.travis-ci.org/swaywm/sway.svg)](https://travis-ci.org/swaywm/sway) [![Donate with fosspay](https://drewdevault.com/donate/static/donate-with-fosspay.png)](https://drewdevault.com/donate?project=4)
2015-08-08 23:39:55 +00:00
[**English**](https://github.com/swaywm/sway/blob/master/README.md#sway--) - [日本語](https://github.com/swaywm/sway/blob/master/README.ja.md#sway--) - [Deutsch](https://github.com/swaywm/sway/blob/master/README.de.md#sway--) - [Ελληνικά](https://github.com/swaywm/sway/blob/master/README.el.md#sway--) - [Français](https://github.com/swaywm/sway/blob/master/README.fr.md#sway--) - [Українська](https://github.com/swaywm/sway/blob/master/README.uk.md#sway--) - [Italiano](https://github.com/swaywm/sway/blob/master/README.it.md#sway--) - [Português](https://github.com/swaywm/sway/blob/master/README.pt.md#sway--) -
2017-10-03 02:26:37 +00:00
[Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--)
2016-11-10 03:26:14 +00:00
"**S**irCmpwn's **Way**land compositor" is a **work in progress**
i3-compatible [Wayland](http://wayland.freedesktop.org/) compositor.
2017-10-03 02:26:37 +00:00
Read the [FAQ](https://github.com/swaywm/sway/wiki). Join the
2015-11-27 14:16:48 +00:00
[IRC channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on
irc.freenode.net).
2015-08-08 23:39:55 +00:00
2017-10-17 01:12:18 +00:00
**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](https://drewdevault.com/2017/10/09/Future-of-sway.html). To follow
wlroots integration status, [see this
ticket](https://github.com/swaywm/sway/issues/1390).
2016-08-02 12:50:03 +00:00
[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png)
2015-08-08 23:39:55 +00:00
2017-08-14 15:56:58 +00:00
If you'd like to support Sway development, you can contribute to [SirCmpwn's
Patreon page](https://patreon.com/sircmpwn) or you can contribute to
2017-10-03 02:26:37 +00:00
[bounties](https://github.com/swaywm/sway/issues/986) 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.
2016-10-13 03:56:41 +00:00
2016-03-24 18:24:43 +00:00
## Release Signatures
2015-08-08 23:39:55 +00:00
2016-03-25 15:21:21 +00:00
Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A)
2017-10-03 02:26:37 +00:00
and published [on GitHub](https://github.com/swaywm/sway/releases).
2015-08-08 23:39:55 +00:00
## Status
2017-10-03 02:26:37 +00:00
- [i3 feature support](https://github.com/swaywm/sway/issues/2)
- [IPC feature support](https://github.com/swaywm/sway/issues/98)
- [i3bar feature support](https://github.com/swaywm/sway/issues/343)
- [i3-gaps feature support](https://github.com/swaywm/sway/issues/307)
- [security features](https://github.com/swaywm/sway/issues/984)
2015-08-08 23:39:55 +00:00
2015-08-16 14:21:04 +00:00
## Installation
2015-08-18 20:16:13 +00:00
### From Packages
2017-02-23 13:33:24 +00:00
Sway is available in many distributions. Try installing the "sway" package for
2017-10-03 02:26:37 +00:00
yours. If it's not available, check out [this wiki page](https://github.com/swaywm/sway/wiki/Unsupported-packages)
2017-02-23 13:33:24 +00:00
for information on installation for your distributions.
2015-08-16 14:21:04 +00:00
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.
2015-08-18 20:16:13 +00:00
### Compiling from Source
2015-08-08 23:39:55 +00:00
2015-08-18 20:16:13 +00:00
Install dependencies:
2015-08-08 23:39:55 +00:00
* cmake
2017-11-19 22:05:09 +00:00
* [wlroots](https://github.com/swaywm/wlroots)
* wayland
2015-08-16 14:04:51 +00:00
* xwayland
2017-04-12 17:13:22 +00:00
* libinput >= 1.6.0
2016-12-17 18:25:25 +00:00
* libcap
2015-08-18 01:27:52 +00:00
* asciidoc
2015-09-01 08:15:09 +00:00
* pcre
* json-c <= 0.12.1
* pango
* cairo
* gdk-pixbuf2 *
* pam **
2017-11-05 19:24:57 +00:00
* 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_
2015-09-01 08:15:09 +00:00
2017-11-05 19:24:57 +00:00
_\*\*\*Only required for tray support_
2015-08-18 20:16:13 +00:00
Run these commands:
2015-08-16 14:07:56 +00:00
2015-12-01 19:14:27 +00:00
mkdir build
cd build
2015-12-27 16:09:28 +00:00
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_SYSCONFDIR=/etc ..
2015-08-08 23:39:55 +00:00
make
2015-08-18 20:16:13 +00:00
sudo make install
2017-03-28 11:45:16 +00:00
On systems with logind, you need to set a few caps on the binary:
2017-10-30 09:02:18 +00:00
sudo setcap "cap_sys_ptrace,cap_sys_tty_config=eip" /usr/local/bin/sway
2015-08-08 23:39:55 +00:00
2015-11-29 15:18:02 +00:00
On systems without logind, you need to suid the sway binary:
sudo chmod a+s /usr/local/bin/sway
2015-11-29 15:18:02 +00:00
2015-08-08 23:39:55 +00:00
## Configuration
2015-08-18 20:16:13 +00: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-08 23:39:55 +00:00
## Running
Run `sway` from a TTY. Some display managers may work but are not supported by
Sway (gdm is known to work fairly well).