sway/README.md
2022-02-07 11:03:03 +01:00

93 lines
3.5 KiB
Markdown

# sway
**[English][en]** - [Deutsch][de] - [Dansk][dk] - [Español][es] - [Français][fr] - [Ελληνικά][gr] - [Magyar][hu] - [ﻑﺍﺮﺳی][ir] - [Italiano][it] - [日本語][ja] - [한국어][ko] - [Nederlands][nl] - [Polski][pl] - [Português][pt] - [Română][ro] - [Русский][ru] - [Türkçe][tr] - [Українська][uk] - [中文-简体][zh-CN] - [中文-繁體][zh-TW]
sway is an [i3]-compatible [Wayland] compositor. Read the [FAQ]. Join the
[IRC channel] \(#sway on irc.libera.chat).
## Release Signatures
Releases are signed with [E88F5E48] and published [on GitHub][GitHub releases].
## Installation
### From Packages
Sway is available in many distributions. Try installing the "sway" package for
yours.
### Compiling from Source
Check out [this wiki page][Development setup] if you want to build the HEAD of
sway and wlroots for testing or development.
Install dependencies:
* meson \*
* [wlroots]
* wayland
* wayland-protocols \*
* pcre
* json-c
* pango
* cairo
* gdk-pixbuf2 (optional: system tray)
* [scdoc] (optional: man pages) \*
* git (optional: version info) \*
_\* Compile-time dep_
Run these commands:
meson build/
ninja -C build/
sudo ninja -C build/ install
On systems without logind nor seatd, you need to suid the sway binary:
sudo chmod a+s /usr/local/bin/sway
Sway will drop root permissions shortly after startup.
## Configuration
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.
## Running
Run `sway` from a TTY. Some display managers may work but are not supported by
sway (gdm is known to work fairly well).
[en]: https://github.com/swaywm/sway#readme
[de]: https://github.com/swaywm/sway/blob/master/README.de.md
[dk]: https://github.com/swaywm/sway/blob/master/README.dk.md
[es]: https://github.com/swaywm/sway/blob/master/README.es.md
[fr]: https://github.com/swaywm/sway/blob/master/README.fr.md
[gr]: https://github.com/swaywm/sway/blob/master/README.gr.md
[hu]: https://github.com/swaywm/sway/blob/master/README.hu.md
[ir]: https://github.com/swaywm/sway/blob/master/README.ir.md
[it]: https://github.com/swaywm/sway/blob/master/README.it.md
[ja]: https://github.com/swaywm/sway/blob/master/README.ja.md
[ko]: https://github.com/swaywm/sway/blob/master/README.ko.md
[nl]: https://github.com/swaywm/sway/blob/master/README.nl.md
[pl]: https://github.com/swaywm/sway/blob/master/README.pl.md
[pt]: https://github.com/swaywm/sway/blob/master/README.pt.md
[ro]: https://github.com/swaywm/sway/blob/master/README.ro.md
[ru]: https://github.com/swaywm/sway/blob/master/README.ru.md
[tr]: https://github.com/swaywm/sway/blob/master/README.tr.md
[uk]: https://github.com/swaywm/sway/blob/master/README.uk.md
[zh-CN]: https://github.com/swaywm/sway/blob/master/README.zh-CN.md
[zh-TW]: https://github.com/swaywm/sway/blob/master/README.zh-TW.md
[i3]: https://i3wm.org/
[Wayland]: http://wayland.freedesktop.org/
[FAQ]: https://github.com/swaywm/sway/wiki
[IRC channel]: https://web.libera.chat/gamja/?channels=#sway
[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://gitlab.freedesktop.org/wlroots/wlroots
[scdoc]: https://git.sr.ht/~sircmpwn/scdoc