2018-03-05 08:37:48 +11:00
|
|
|
# sway
|
2015-08-09 09:39:55 +10:00
|
|
|
|
2020-12-18 21:31:04 +11:00
|
|
|
**[English][en]** - [日本語][ja] - [Français][fr] - [Українська][uk] - [Español][es] - [Polski][pl] - [中文-简体][zh-CN] - [Deutsch][de] - [Nederlands][nl] - [Русский][ru] - [中文-繁體][zh-TW] - [Português][pt] - [Danish][dk] - [한국어][ko] - [Română][ro]
|
2017-08-14 04:01:55 +10:00
|
|
|
|
2020-12-18 21:31:04 +11:00
|
|
|
sway is an [i3]-compatible [Wayland] compositor. Read the [FAQ]. Join the
|
|
|
|
|
[IRC channel] \(#sway on irc.freenode.net).
|
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
|
|
|
|
2020-12-18 21:31:04 +11:00
|
|
|
Releases are signed with [E88F5E48] and published [on GitHub][GitHub 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
|
2020-12-18 21:12:14 +11:00
|
|
|
yours.
|
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
|
|
|
|
2020-12-18 21:31:04 +11:00
|
|
|
Check out [this wiki page][Development setup] if you want to build the HEAD of
|
|
|
|
|
sway and wlroots for testing or development.
|
2020-06-04 23:27:49 +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 \*
|
2020-12-18 21:31:04 +11:00
|
|
|
* [wlroots]
|
2015-11-13 00:17:52 +11:00
|
|
|
* 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
|
2016-05-15 05:18:44 +10:00
|
|
|
* pango
|
|
|
|
|
* cairo
|
2019-04-26 01:23:37 +10:00
|
|
|
* gdk-pixbuf2 (optional: system tray)
|
2020-12-18 21:31:04 +11:00
|
|
|
* [scdoc] (optional: man pages) \*
|
2020-03-12 23:13:23 +11:00
|
|
|
* git (optional: version info) \*
|
2015-12-21 01:14:30 +11:00
|
|
|
|
2018-11-03 04:47:33 +11:00
|
|
|
_\*Compile-time dep_
|
2015-12-21 01:14:30 +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:
|
|
|
|
|
|
2015-12-14 08:40:14 +11:00
|
|
|
sudo chmod a+s /usr/local/bin/sway
|
2015-11-30 02:18:02 +11:00
|
|
|
|
2018-08-09 01:40:33 +10: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
|
2015-12-01 10:38:23 +11:00
|
|
|
it'll work out of the box. Otherwise, copy the sample configuration file to
|
2015-12-23 22:22:48 +11:00
|
|
|
`~/.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
|
|
|
|
|
|
2017-08-14 04:01:55 +10:00
|
|
|
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).
|
2020-12-18 21:31:04 +11:00
|
|
|
|
|
|
|
|
[en]: https://github.com/swaywm/sway#readme
|
|
|
|
|
[ja]: https://github.com/swaywm/sway/blob/master/README.ja.md
|
|
|
|
|
[fr]: https://github.com/swaywm/sway/blob/master/README.fr.md
|
|
|
|
|
[uk]: https://github.com/swaywm/sway/blob/master/README.uk.md
|
|
|
|
|
[es]: https://github.com/swaywm/sway/blob/master/README.es.md
|
|
|
|
|
[pl]: https://github.com/swaywm/sway/blob/master/README.pl.md
|
|
|
|
|
[zh-CN]: https://github.com/swaywm/sway/blob/master/README.zh-CN.md
|
|
|
|
|
[de]: https://github.com/swaywm/sway/blob/master/README.de.md
|
|
|
|
|
[nl]: https://github.com/swaywm/sway/blob/master/README.nl.md
|
|
|
|
|
[ru]: https://github.com/swaywm/sway/blob/master/README.ru.md
|
|
|
|
|
[zh-TW]: https://github.com/swaywm/sway/blob/master/README.zh-TW.md
|
|
|
|
|
[pt]: https://github.com/swaywm/sway/blob/master/README.pt.md
|
|
|
|
|
[dk]: https://github.com/swaywm/sway/blob/master/README.dk.md
|
|
|
|
|
[ko]: https://github.com/swaywm/sway/blob/master/README.ko.md
|
|
|
|
|
[ro]: https://github.com/swaywm/sway/blob/master/README.ro.md
|
|
|
|
|
[i3]: https://i3wm.org/
|
|
|
|
|
[Wayland]: http://wayland.freedesktop.org/
|
|
|
|
|
[FAQ]: https://github.com/swaywm/sway/wiki
|
|
|
|
|
[IRC channel]: http://webchat.freenode.net/?channels=sway&uio=d4
|
|
|
|
|
[SirCmpwn's Patreon page]: https://patreon.com/sircmpwn
|
|
|
|
|
[E88F5E48]: https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48
|
|
|
|
|
[GitHub releases]: https://github.com/swaywm/sway/releases
|
|
|
|
|
[Development setup]: https://github.com/swaywm/sway/wiki/Development-Setup
|
|
|
|
|
[wlroots]: https://github.com/swaywm/wlroots
|
|
|
|
|
[scdoc]: https://git.sr.ht/~sircmpwn/scdoc
|
