swayfx/README.md

75 lines
2.8 KiB
Markdown
Raw Normal View History

2018-03-05 08:37:48 +11:00
# sway
2015-08-09 09:39:55 +10: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--) -
2018-08-29 00:12:38 +10:00
[Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--) - [Български](https://github.com/swaywm/sway/blob/master/README.bg.md#sway--)
2019-01-06 05:14:10 +11:00
sway is a **work in progress** i3-compatible
[Wayland](http://wayland.freedesktop.org/) compositor. Read the
[FAQ](https://github.com/swaywm/sway/wiki). Join the [IRC
channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on
2015-11-28 01:16:48 +11:00
irc.freenode.net).
2015-08-09 09:39:55 +10:00
2018-04-13 10:22:27 +10:00
If you'd like to support sway development, please contribute to [SirCmpwn's
Patreon page](https://patreon.com/sircmpwn).
2016-10-13 14:56:41 +11: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)
2017-10-03 13:26:37 +11:00
and published [on GitHub](https://github.com/swaywm/sway/releases).
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
2017-02-24 00:33:24 +11:00
Sway is available in many distributions. Try installing the "sway" package for
2017-10-03 13:26:37 +11:00
yours. If it's not available, check out [this wiki page](https://github.com/swaywm/sway/wiki/Unsupported-packages)
2017-02-24 00:33:24 +11:00
for information on installation for your distributions.
2015-08-17 00:21:04 +10:00
2018-04-13 10:22:27 +10:00
If you're interested in packaging sway for your distribution, stop by the IRC
2016-03-26 06:52:18 +11:00
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
2018-11-03 04:47:33 +11:00
* meson \*
2017-11-20 09:05:09 +11:00
* [wlroots](https://github.com/swaywm/wlroots)
* wayland
2018-11-03 04:47:33 +11:00
* wayland-protocols \*
2015-09-01 18:15:09 +10:00
* pcre
2018-11-03 04:47:33 +11:00
* json-c
* pango
* cairo
2018-11-03 04:47:33 +11:00
* gdk-pixbuf2 \*\*
2018-11-03 04:48:25 +11:00
* pam (optional: PAM support for swaylock)
2018-11-03 04:47:33 +11:00
* [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional: man pages) \*
* git \*
2018-11-03 04:47:33 +11:00
_\*Compile-time dep_
2018-11-03 04:47:33 +11:00
_\*\*optional: required for swaybg and swaylock_
2017-11-06 06:24:57 +11:00
2015-08-19 06:16:13 +10:00
Run these commands:
2015-08-17 00:07:56 +10:00
2017-12-01 21:21:03 +11:00
meson build
ninja -C build
sudo ninja -C build install
2017-03-28 22:45:16 +11: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
Sway will drop root permissions shortly after startup.
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
Run `sway` from a TTY. Some display managers may work but are not supported by
2018-04-13 10:22:27 +10:00
sway (gdm is known to work fairly well).