Wayland is a protocol for a compositor to talk to its clients, as well as a library implementing this protocol. All major Linux desktop systems like Gnome, KDE do support Wayland, and there is also a reference implementation for a compositor called "Weston". XWayland implements a compatibility layer to seamlessly run legacy X11 applications on Wayland.
- 1 Requirements
- 2 Weston
- 3 GUI libraries
- 4 Window managers and desktop shells
- 5 Troubleshooting
- 5.1 Running graphical applications as root
- 5.2 LLVM assertion failure
- 5.3 Slow motion, graphical glitches, and crashes
- 5.4 nemo
- 5.5 X11 on tty1, wayland on tty2
- 5.6 gnome wayland on tty1, weston on tty2
- 5.7 weston-terminal
- 5.8 liteide
- 5.9 screen recording
- 5.10 remote display
- 5.11 Input grabbing in games, remote desktop and VM windows
- 6 See also
Buffer API support
|Buffer API||GPU driver support||Wayland compositor support|
|GBM||All except NVIDIA||All|
|EGLStreams||NVIDIA||GNOME, Grefsen, Sway (will be removed)|
Weston is the reference implementation of a Wayland compositor.
||Zoom in/out of desktop|
||Rotate Window !|
||Change window opacity|
||Force Kill Active Window|
||Switch Prev/Next Workspace|
||Grab Current Window and Switch Workspace|
||Switch to Workspace n|
||Take a screenshot|
||Record a screencast.|
Now that Wayland and its requirements are installed you should be ready to test it out.
It is possible to run Weston inside a running X session:
Alternatively, to try to launch Weston natively, switch to a terminal and run:
Then at a TTY within Weston, you can run the demos. To launch a terminal emulator:
To move flowers around the screen:
To display images:
$ weston-image image1.jpg image2.jpg...
Example configuration file for keyboard layout, module selection and UI modifications. See
$ ls /sys/class/drm card0 card0-VGA-1 card1 card1-DVI-I-1 card1-HDMI-A-1 card1-VGA-2
card0 is the unused built-in video adapter. The add-on adapter
card1 is cabled to one HDMI and one DVI monitor, so the output names are
[core] # xwayland support xwayland=true [libinput] enable_tap=true [shell] background-image=/usr/share/backgrounds/gnome/Aqua.jpg background-color=0xff002244 panel-color=0x90ff0000 locking=true animation=zoom close-animation=fade focus-animation=dim-layer #binding-modifier=ctrl #num-workspaces=6 ### for cursor themes install xcursor-themes pkg from Extra. ### #cursor-theme=whiteglass #cursor-size=24 ### tablet options ### #lockscreen-icon=/usr/share/icons/gnome/256x256/actions/lock.png #lockscreen=/usr/share/backgrounds/gnome/Garden.jpg #homescreen=/usr/share/backgrounds/gnome/Blinds.jpg #animation=fade ### for Laptop displays ### #[output] #name=LVDS1 #mode=1680x1050 #transform=90 #[output] #name=VGA1 # The following sets the mode with a modeline, you can get modelines for your preffered resolutions using the cvt utility #mode=173.00 1920 2048 2248 2576 1080 1083 1088 1120 -hsync +vsync #transform=flipped #[output] #name=X1 #mode=1024x768 #transform=flipped-270 [input-method] #path=/usr/lib/weston/weston-keyboard [keyboard] keymap_rules=evdev #keymap_layout=gb,de #keymap_options=caps:ctrl_modifier,shift:both_capslock_cancel ### keymap_options from /usr/share/X11/xkb/rules/base.lst ### numlock-on=true [terminal] #font=DroidSansMono #font-size=14 [launcher] icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png path=/usr/bin/weston-terminal [launcher] icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png path=/usr/bin/gnome-terminal [launcher] icon=/usr/share/icons/hicolor/24x24/apps/firefox.png path=/usr/bin/firefox [launcher] icon=/usr/share/weston/icon_flower.png path=/usr/bin/weston-flower [screensaver] # Uncomment path to disable screensaver path=/usr/libexec/weston-screensaver duration=600
[core] xwayland=true [keyboard] keymap_layout=gb [output] name=LVDS1 mode=1680x1050 transform=90 [launcher] icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png path=/usr/bin/weston-terminal [launcher] icon=/usr/share/icons/hicolor/24x24/apps/firefox.png path=/usr/bin/firefox
Install the package.
When you want to run an X application from within Weston, it spins up Xwayland to service the request. The following configuration is shown above:
Weston has build-in screencast recording which can be started and stopped by pressing the
Super+r key combination. Screencasts are saved to the file
capture.wcap in the current working directory of Weston.
The WCAP format is a lossless video format specific to Weston, which only records the difference in frames. To be able to play the recorded screencast, the WCAP file will need to be converted to a format which a media player can understand. First, convert the capture to the YUV pixel format:
$ wcap-decode capture.wcap --yuv4mpeg2 > capture.y4m
The YUV file can then be transcoded to other formats using FFmpeg.
High DPI displays
[output] name=... scale=2
Weston uses the default sans-serif font for window title bars, clocks, etc. See Font configuration#Replace or set default fonts for instructions on how to change this font.
See details on the official website.
To enable Wayland support in Qt 5, install thepackage.
To run a Qt 5 app with the Wayland plugin, use
-platform wayland or set the
QT_QPA_PLATFORM=wayland-egl environment variable.
The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is enabled in thepackage.
To run a Clutter app on Wayland, set
To run a SDL2 application on Wayland, set
To use GLFW with the Wayland backend, install thepackage (instead of ).
EFL has complete Wayland support. To run a EFL application on Wayland, see Wayland project page.
Window managers and desktop shells
|GNOME||Stacking||See GNOME#Starting GNOME.|
|sway||Tiling||Sway is an i3-compatible window manager for Wayland. GitHub|
|KDE Plasma||Stacking||See KDE#Starting Plasma|
|Orbment||Tiling||orbment (previously loliwm) is a tiling WM for Wayland.|
|Velox||Tiling||Velox is a simple window manager based on swc. It is inspired by dwm and xmonad.|
|Orbital||Stacking||Orbital is a Wayland compositor and shell, using Qt5 and Weston. The goal of the project is to build a simple yet flexible and good looking Wayland desktop. It is not a full fledged DE but rather the analogue of a WM in the X11 world, such as Awesome or Fluxbox.|
|Liri Shell||Stacking||Liri Shell is the desktop shell for Liri, built using QtQuick and QtCompositor as a compositor for Wayland.|
|Maynard||(Unclear)||Maynard is a desktop shell client for Weston based on GTK. It was based on weston-gtk-shell, a project by Tiago Vignatti.|
|Motorcar||(Unclear)||Motorcar is a Wayland compositor to explore 3D windowing using virtual reality.|
|Way Cooler||Tiling||AUR is a customizable (Lua config files) Wayland compositor written in Rust. Inspired by i3 and awesome.|
|Maze Compositor||Floating 3D||Maze Compositor is a 3D Qt based Wayland compositor|
|Grefsen||Floating||Grefsen is a Qt/Wayland compositor providing a minimal desktop environment.|
Some of installed wayland desktop clients might store information in
/usr/share/wayland-sessions/*.desktop files about how to start them in wayland.
Running graphical applications as root
Trying to run a graphical application as root via su, sudo or pkexec in a Wayland session (e.g. GParted or Gedit), be it in a terminal emulator or from a graphical component, will fail with an error similar to this:
$ sudo gedit No protocol specified Unable to init server: Could not connect: Connection refused (gedit:2349): Gtk-WARNING **: cannot open display: :0
Before Wayland, running GUI applications with elevated privileges could be properly implemented by creating a Polkit policy, or more dangerously done by running the command in a terminal by prepending the command with
sudo; but under (X)Wayland this does not work anymore as the default has been made to only allow the user who started the X server to connect clients to it (see the bug report and the upstream commits it refers to).
The most straightforward workaround is to use xhost to temporarily allow the root user to access the local user's X session. To do so, execute the following command as the current (unprivileged) user:
To remove this access after the application has been closed:
LLVM assertion failure
If you get an LLVM assertion failure, you need to rebuildwithout Gallium LLVM until this problem is fixed.
This may imply disabling some drivers which require LLVM. You may also try exporting the following, if having problems with hardware drivers:
$ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so
Slow motion, graphical glitches, and crashes
Gnome-shell users may experience display issues when they switch to Wayland from X. One of the root cause might be the
CLUTTER_PAINT=disable-clipped-redraws:disable-culling set by yourself for Xorg-based gnome-shell. Just try to remove it from
/etc/environment or other rc files to see if everything goes back to normal.
(20161229) prevent that the desktop is created <ref>nemo issue 1343</ref>
gsettings set org.nemo.desktop show-desktop-icons false
X11 on tty1, wayland on tty2
(20161209) windows of gnome applications end up on tty2 no matter where started (gnome issue 774775)
gnome wayland on tty1, weston on tty2
(20170106) apps started on gnome with WAYLAND_DISPLAY set to westen make it not respond any more (wayland issue 99489)
(20161229) core dump when started on gnome
(20161229) core dump] on gnome and weston.
Currently onlyAUR supports screen recording on Wayland (requires a GNOME session).
(20161229) there was a merge of FreeRDP into weston in 2013, enabled via compile time switch. The arch linux weston package currently has it not enabled.
Input grabbing in games, remote desktop and VM windows
In contrast to Xorg, Wayland does not allow exclusive input device grabbing, also known as active or explicit grab (e.g. keyboard, mouse), instead, it depends on the Wayland compositor to pass keyboard shortcuts and confine the pointer device to the application window.
This change in input grabbing breaks current applications' behavior, meaning:
- Hotkey combinations and modifiers will be caught by the compositor and won't be sent to remote desktop and virtual machine windows.
- The mouse pointer will not be restricted to the application's window which might cause a parallax effect where the location of the mouse pointer inside the window of the virtual machine or remote desktop is displaced from the host's mouse pointer.
Wayland solves this by adding protocol extensions for Wayland and XWayland. Support for these extensions is needed to be added to Wayland compositors, XWayland and in the case of native Wayland clients to widget toolkits (e.g GTK, QT) and probably also to the applications themselves. ATM there is no Wayland compositor which support all of these extensions.
The related extensions are:
- XWayland keyboard grabbing protocol, added in wayland-protocols 1.9, XWayland support already been added to xorg-server 1.20 development tree.
- Compositor shortcuts inhibit protocol (native Wayland only), added in wayland-protocols 1.9
- Relative pointer protocol, added in wayland-protocols 1.1, XWayland support already been added in xorg-server 1.19
- Pointer constraints protocol, added in wayland-protocols 1.1, XWayland support already been added in xorg-server 1.19