sway README

The project's README from github.com/swaywm/sway. As one markdown file: README.md.

sway

English - عربي - Azərbaycanca - Česky - Deutsch - Dansk - Español - Français - ქართული - Ελληνικά - हिन्दी - Magyar - فارسی - Italiano - 日本語 - 한국어 - Nederlands - Norsk - Polski - Português - Română - Русский - Српски - Svenska - Türkçe - Українська - 中文-简体 - 中文-繁體

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.

Installation

From Packages

Sway is available in many distributions. Try installing the "sway" package for yours.

Compiling from Source

Check out this wiki page if you want to build the HEAD of sway and wlroots for testing or development.

Install dependencies:

* Compile-time dep

Run these commands:

meson setup build/
ninja -C build/
sudo ninja -C build/ install

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 or from a display manager.

sway (swaywm/sway)

Searching Database…

17.4K ·GitHub
What is this?Sway is an i3-compatible Wayland compositor: the program that draws and arranges your windows on Linux, tiling them automatically like the i3 window manager.
What does 'i3-compatible' mean — is this basically i3 on Wayland?Yes: Sway reproduces how the i3 tiling window manager behaves and is configured, but it runs as a native Wayland compositor instead of an X11 window manager, so you get the i3 workflow on the newer display protocol.
What do I need to compile it from source?The meson and ninja build tools, plus the wlroots, wayland, wayland-protocols, pcre2, json-c, pango, cairo and gdk-pixbuf2 libraries. swaybg for wallpapers, scdoc for man pages and git are optional extras.
What is wlroots?It is the library for building Wayland compositors that Sway is built on. It is a required compile-time dependency, and the development setup wiki covers building sway and wlroots together from source.
Can it show a wallpaper and a system tray?Yes — the optional swaybg companion draws wallpapers, and system tray support comes via gdk-pixbuf2, with optional extra image-format libraries for more tray formats.
Are the GitHub releases signed?Yes — releases are signed with the key E88F5E48 and published on GitHub, so you can verify what you download before installing.
Creator
swaywm
Size
30.1 MB
Stars
17.4K
Age
11y
Commits · 90 Days