sway/README.md

70 lines
3.1 KiB
Markdown
Raw Normal View History

2018-03-04 21:37:48 +00:00
# sway
2015-08-08 23:39:55 +00:00
2020-06-13 13:23:40 +00:00
[**English**](https://github.com/swaywm/sway/blob/master/README.md#sway--) - [日本語](https://github.com/swaywm/sway/blob/master/README.ja.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--) - [Español](https://github.com/swaywm/sway/blob/master/README.es.md#sway--) - [Polski](https://github.com/swaywm/sway/blob/master/README.pl.md#sway--) - [中文-简体](https://github.com/swaywm/sway/blob/master/README.zh-CN.md#sway--) - [Deutsch](https://github.com/swaywm/sway/blob/master/README.de.md#sway--) - [Nederlands](https://github.com/swaywm/sway/blob/master/README.nl.md#sway--) - [Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--)- [中文-繁體](https://github.com/swaywm/sway/blob/master/README.zh-TW.md#sway--) - [Português](https://github.com/swaywm/sway/blob/master/README.pt.md#sway--) - [Danish](https://github.com/swaywm/sway/blob/master/README.dk.md#sway--) - [한국어](https://github.com/swaywm/sway/blob/master/README.ko.md#sway--) - [Română](https://github.com/swaywm/sway/blob/master/README.ro.md#sway--)
sway is an [i3](https://i3wm.org/)-compatible [Wayland](http://wayland.freedesktop.org/) compositor.
2019-01-14 02:36:59 +00:00
Read the [FAQ](https://github.com/swaywm/sway/wiki). Join the [IRC
2019-01-05 18:14:10 +00:00
channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on
2015-11-27 14:16:48 +00:00
irc.freenode.net).
2015-08-08 23:39:55 +00:00
2018-04-13 00:22:27 +00:00
If you'd like to support sway development, please contribute to [SirCmpwn's
Patreon page](https://patreon.com/sircmpwn).
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
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
2018-04-13 00:22:27 +00:00
If you're interested in packaging sway for your distribution, stop by the IRC
2016-03-25 19:52:18 +00:00
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
2018-11-02 17:47:33 +00:00
* meson \*
2017-11-19 22:05:09 +00:00
* [wlroots](https://github.com/swaywm/wlroots)
* wayland
2018-11-02 17:47:33 +00:00
* wayland-protocols \*
2015-09-01 08:15:09 +00:00
* pcre
2018-11-02 17:47:33 +00:00
* json-c
* pango
* cairo
* gdk-pixbuf2 (optional: system tray)
* [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional: man pages) \*
2020-03-12 12:13:23 +00:00
* git (optional: version info) \*
2018-11-02 17:47:33 +00:00
_\*Compile-time dep_
2015-08-18 20:16:13 +00:00
Run these commands:
2015-08-16 14:07:56 +00:00
2017-12-01 10:21:03 +00:00
meson build
ninja -C build
sudo ninja -C build install
2017-03-28 11:45:16 +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
Sway will drop root permissions shortly after startup.
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
2018-04-13 00:22:27 +00:00
sway (gdm is known to work fairly well).