sway/README.md

104 lines
4.0 KiB
Markdown
Raw Normal View History

2018-03-04 22:37:48 +01:00
# sway
2015-08-09 01:39:55 +02: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 04:26:37 +02:00
[Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--)
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.
2017-10-03 04:26:37 +02:00
Read the [FAQ](https://github.com/swaywm/sway/wiki). Join the
2015-11-27 15:16:48 +01:00
[IRC channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on
irc.freenode.net).
2015-08-09 01:39:55 +02:00
2017-10-17 03:12:18 +02: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 14:50:03 +02:00
[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png)
2015-08-09 01:39:55 +02:00
2017-08-14 17:56:58 +02: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 04:26:37 +02: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 05:56:41 +02:00
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)
2017-10-03 04:26:37 +02:00
and published [on GitHub](https://github.com/swaywm/sway/releases).
2015-08-09 01:39:55 +02:00
## Status
2017-10-03 04:26:37 +02: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-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
2017-02-23 14:33:24 +01:00
Sway is available in many distributions. Try installing the "sway" package for
2017-10-03 04:26:37 +02:00
yours. If it's not available, check out [this wiki page](https://github.com/swaywm/sway/wiki/Unsupported-packages)
2017-02-23 14:33:24 +01:00
for information on installation for your distributions.
2015-08-16 16:21:04 +02:00
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
2017-12-01 11:21:03 +01:00
* meson
2017-11-19 23:05:09 +01:00
* [wlroots](https://github.com/swaywm/wlroots)
* wayland
2015-08-16 16:04:51 +02:00
* xwayland
2017-04-12 19:13:22 +02:00
* libinput >= 1.6.0
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 <= 0.12.1
* pango
* cairo
* gdk-pixbuf2 *
* pam **
2017-11-05 20:24:57 +01: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 10:15:09 +02:00
2017-11-05 20:24:57 +01:00
_\*\*\*Only required for tray support_
2015-08-18 22:16:13 +02:00
Run these commands:
2015-08-16 16:07:56 +02:00
2017-12-01 11:21:03 +01:00
meson build
ninja -C build
sudo ninja -C build install
2017-03-28 13:45:16 +02:00
On systems with logind, you need to set a few caps on the binary:
2017-10-30 10:02:18 +01:00
sudo setcap "cap_sys_ptrace,cap_sys_tty_config=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
## Running
Run `sway` from a TTY. Some display managers may work but are not supported by
Sway (gdm is known to work fairly well).