Difference between revisions of "Wayland"

From ArchWiki
Jump to: navigation, search
m (Installation: Grammar fix)
(Troubleshooting: Remove Nemo section, issue was fixed with https://github.com/linuxmint/nemo/pull/1355)
 
(382 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
[[Category:X Server]]
+
[[Category:Graphical user interfaces]]
[[zh-CN:Wayland]]
+
[[es:Wayland]]
{{Article summary start}}
+
[[fr:Wayland]]
{{Article summary text|A guide to installing and running the Wayland display server.}}
+
[[ja:Wayland]]
{{Article summary heading|Related}}
+
[[ru:Wayland]]
{{Article summary wiki|KMS}}
+
[[zh-hans:Wayland]]
{{Article summary wiki|Xorg}}
+
{{Related articles start}}
{{Article summary end}}
+
{{Related|KMS}}
 +
{{Related|Xorg}}
 +
{{Related articles end}}
  
'''Wayland''' is a new windowing protocol for Linux. Utilization of Wayland requires changes to and re-installation of parts of your system's software. For more information on Wayland see its [http://wayland.freedesktop.org/ homepage].
+
[http://wayland.freedesktop.org/ Wayland] is a protocol for a [[wikipedia:Compositing window manager|compositing window manager]] to talk to its clients, as well as a library implementing the protocol. Many major Linux desktop environments, like [[GNOME]] and [[KDE]], support Wayland. There is also a compositor reference implementation called Weston. [https://wayland.freedesktop.org/xserver.html XWayland] implements a compatibility layer to seamlessly run legacy [[X11]] applications on Wayland.
  
{{Warning|Wayland is under heavy development.  Support can not be guaranteed and it may not function as you expect.}}
+
== Requirements ==
  
== Requirements ==
+
Most Wayland compositors only work on systems using [[Kernel mode setting]].
Currently Wayland will only work with on a system that is utilizing [[KMS]].
+
 
 +
Wayland by itself does not provide a graphical environment; for this you also need a compositor such as [[#Weston]] or [[Sway]], or a desktop environment that includes a compositor like [[GNOME]] or [[KDE]].
 +
 
 +
=== Buffer API support ===
  
== Installation ==
+
For the GPU driver and Wayland compositor to be compatible they must support the same buffer API. There are two main APIs: [[Wikipedia:Generic Buffer Management|GBM]] and [http://www.phoronix.com/scan.php?page=news_item&px=XDC2016-Device-Memory-API EGLStreams].
You need to build and install {{AUR|wayland-git}} and {{AUR|mesa-full-wayland}} from the [[AUR]]. Replacement of the Mesa stack is required because the stock one does not support Wayland.
 
  
== Usage ==
+
{| class="wikitable"
As Wayland is only a library, it is useless on its own. To use it, you need a compositor (like Weston), Weston demo applications, Qt5 (or Qt4 with QPA enabled) with Wayland plugin, and/or GTK+ with Wayland support.
+
|-
 +
! Buffer API !! GPU driver support !! Wayland compositor support
 +
|-
 +
| GBM || All except [[NVIDIA]] || All
 +
|-
 +
| EGLStreams || [[NVIDIA]] || [[GNOME]], Grefsen, [[Sway]] ([https://sircmpwn.github.io/2017/10/26/Fuck-you-nvidia.html will be removed])
 +
|-
 +
|}
  
 
== Weston ==
 
== Weston ==
 +
 +
Weston is the reference implementation of a Wayland compositor.
 +
 
=== Installation ===
 
=== Installation ===
You need to build and install {{AUR|weston-git}} from the [[AUR]].
+
 
 +
[[Install]] the {{Pkg|weston}} package.
  
 
=== Usage ===
 
=== Usage ===
Now that Wayland and its requirements are installed you should be ready to test it out. Try switching to a terminal and running:
 
$ weston-launch
 
Note I was having trouble with keyboard & mouse not working unless this was run as root
 
  
You can also try:
+
{| class="wikitable"
$ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so
+
|+ '''''Keyboard Shortcuts''' (super = windows key - can be changed, see weston.ini)'' {{Ic|Ctrl-b}}
if you have troubles with your hardware's driver.
+
!Cmd
 +
!Action
 +
|-
 +
|{{ic|Ctrl+Alt+Backspace}}
 +
|Quit Weston
 +
|-
 +
|{{ic|Super+Scroll}} (or {{ic|PageUp}}/{{ic|PageDown}})
 +
|Zoom in/out of desktop
 +
|-
 +
|{{ic|Super+Tab}}
 +
|Switch windows
 +
|-
 +
|{{ic|Super+LMB}}
 +
|Move Window
 +
|-
 +
|{{ic|Super+MMB}}
 +
|Rotate Window !
 +
|-
 +
|{{ic|Super+RMB}}
 +
|Resize Window
 +
|-
 +
|{{ic|Super+Alt+Scroll}}
 +
|Change window opacity
 +
|-
 +
|{{ic|Super+K}}
 +
|Force Kill Active Window
 +
|-
 +
|{{ic|Super+KeyUp/KeyDown}}
 +
|Switch Prev/Next Workspace
 +
|-
 +
|{{ic|Super+Shift+KeyUp/KeyDown}}
 +
|Grab Current Window and Switch Workspace
 +
|-
 +
|{{ic|Super+F'''''n'''''}}
 +
|Switch to Workspace '''''n'''''
 +
|-
 +
|{{ic|Super+S}}
 +
|Take a screenshot
 +
|-
 +
|{{ic|Super+R}}
 +
|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:
 +
$ weston
  
Then at a TTY you can run the demos:
+
Alternatively, to try to launch Weston natively, switch to a terminal and run:
 +
$ weston-launch
  
 +
Then at a TTY within Weston, you can run the demos. To launch a terminal emulator:
 
  $ weston-terminal
 
  $ weston-terminal
Should launch a terminal emulator.
 
  
 +
To move flowers around the screen:
 
  $ weston-flower  
 
  $ weston-flower  
Moves a flower around the screen.  This tests the frame protocol.
 
  
  $ weston-gears
+
To display images:
Runs glxgears on Wayland.
+
  $ weston-image image1.jpg image2.jpg...
  
  $ weston-image image1.jpg image2.jpg...
+
=== Configuration ===
Displays images.
+
Example configuration file for keyboard layout, module selection and UI modifications. See {{man|5|weston.ini}} for full details. The Weston outputs differ slightly from {{ic|xorg.conf}}'s Monitors:
 +
 
 +
  $ ls /sys/class/drm
 +
card0
 +
card0-VGA-1
 +
card1
 +
card1-DVI-I-1
 +
card1-HDMI-A-1
 +
card1-VGA-2
 +
 
 +
{{ic|card0}} is the unused built-in video adapter. The add-on adapter {{ic|card1}} is cabled to one HDMI and one DVI monitor, so the output names are {{ic|HDMI-A-1}} and {{ic|DVI-I-1}}.
 +
 
 +
{{hc|~/.config/weston.ini|<nowiki>
 +
[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
 +
</nowiki>
 +
}}
 +
 
 +
Minimal {{ic|weston.ini}} :
 +
{{hc|~/.config/weston.ini|<nowiki>
 +
[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
 +
 
 +
</nowiki>
 +
}}
 +
 
 +
==== XWayland ====
 +
[[Install]] the {{Pkg|xorg-server-xwayland}} 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:
 +
 
 +
{{hc|~/.config/weston.ini|
 +
<nowiki>[core]
 +
modules=xwayland.so</nowiki>
 +
}}
 +
{{Note| if X is not already configured you may need to configure a keymap: [[Keyboard configuration in Xorg]]}}
 +
 
 +
==== Screencast recording ====
 +
Weston has build-in screencast recording which can be started and stopped by pressing the {{ic|Super+r}} key combination. Screencasts are saved to the file {{ic|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 ====
 +
 
 +
For [[wikipedia:Retina_Display|Retina]] or [[HiDPI]] displays, use:
 +
 
 +
{{hc|~/.config/weston.ini|
 +
<nowiki>[output]
 +
name=...
 +
scale=2</nowiki>
 +
}}
 +
 
 +
==== Shell font ====
 +
 
 +
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.
 +
 
 +
== GUI libraries ==
 +
 
 +
See details on the [http://wayland.freedesktop.org/toolkits.html official website].
 +
 
 +
=== GTK+ 3 ===
 +
 
 +
The {{Pkg|gtk3}} package has the Wayland backend enabled. GTK+ will default to the Wayland backend, but it is possible to override it to Xwayland by modifying an environment variable: {{ic|GDK_BACKEND&#61;x11}}.
 +
 
 +
=== Qt 5 ===
 +
To enable Wayland support in Qt 5, install the {{Pkg|qt5-wayland}} package.
 +
 
 +
To run a Qt 5 app with the Wayland plugin, use {{ic|1=-platform wayland}} or set the {{ic|1=QT_QPA_PLATFORM=wayland-egl}} [[environment variable]].
 +
 
 +
=== Clutter ===
 +
 
 +
The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is enabled in the {{Pkg|clutter}} package.
 +
 
 +
To run a Clutter app on Wayland, set {{ic|CLUTTER_BACKEND&#61;wayland}}.
 +
 
 +
=== SDL2 ===
 +
 
 +
To run a SDL2 application on Wayland, set {{ic|SDL_VIDEODRIVER&#61;wayland}}.
 +
 
 +
=== GLFW ===
 +
 
 +
To use GLFW with the Wayland backend, install the {{Pkg|glfw-wayland}} package (instead of {{Pkg|glfw-x11}}).
 +
 
 +
=== GLEW ===
 +
 
 +
To use GLEW with the Wayland backend, install the {{Pkg|glew-wayland}} package (instead of {{Pkg|glew}}).
 +
 
 +
=== EFL ===
 +
 
 +
EFL has complete Wayland support.  
 +
To run a EFL application on Wayland, see Wayland [http://wayland.freedesktop.org/efl.html project page].
  
$ weston-view doc1.pdf doc2.pdf...
+
== Compositors ==
Displays PDF files.
 
  
== Qt ==
+
{| class="wikitable sortable"
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| GNOME
 +
| Stacking
 +
| See [[GNOME#Starting]].
 +
|-
 +
| sway
 +
| Tiling
 +
| [[Sway]] is an i3-compatible window manager for Wayland. [https://github.com/SirCmpwn/sway GitHub]
 +
|-
 +
| Enlightenment
 +
| Stacking
 +
| [https://www.enlightenment.org/about-wayland More Info]
 +
|-
 +
| KDE Plasma
 +
| Stacking
 +
| See [[KDE#Starting Plasma]]
 +
|-
 +
| Orbment
 +
| Tiling
 +
| [https://github.com/Cloudef/orbment orbment] (previously loliwm) is an abandonned tiling WM for Wayland.
 +
|-
 +
| Velox
 +
| Tiling
 +
| [[Velox]] is a simple window manager based on swc. It is inspired by [[dwm]] and [[xmonad]].
 +
|-
 +
| Orbital
 +
| Stacking
 +
| [https://github.com/giucam/orbital 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
 +
| [https://github.com/lirios/shell Liri Shell] is the desktop shell for [[Liri]], built using QtQuick and QtCompositor as a compositor for Wayland.
 +
|-
 +
| Maynard
 +
| ''(Unclear)''
 +
| [https://github.com/raspberrypi/maynard 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)''
 +
| [https://github.com/evil0sheep/motorcar Motorcar] is a Wayland compositor to explore 3D windowing using virtual reality.
 +
|-
 +
| Way Cooler
 +
| Tiling
 +
|  {{AUR|way-cooler}} is a customizable (Lua config files) Wayland compositor written in Rust. Inspired by i3 and awesome.
 +
|-
 +
| Maze Compositor
 +
| Floating 3D
 +
| [https://github.com/capisce/mazecompositor Maze Compositor] is a 3D Qt based Wayland compositor
 +
|-
 +
| Grefsen
 +
| Floating
 +
| [https://github.com/ec1oud/grefsen Grefsen] is a Qt/Wayland compositor providing a minimal desktop environment.
 +
|}
  
=== Installation ===
+
Some of installed wayland desktop clients might store information in {{ic|/usr/share/wayland-sessions/*.desktop}} files about how to start them in wayland.
You need to build and install {{AUR|qt-qpa}} from [[AUR]]. It contains a development version of Qt 4.8 compiled with QPA (Lighthouse) support. It installs into /opt/qt-qpa because it's binary incompatible with non-QPA versions of Qt (like the stock one).
 
  
=== Usage ===
+
==Troubleshooting==
At first, you need a working Wayland compositor, like the one from demo applications, or an experimental version of KWin.
 
  
Then compile any qmake-based Qt project:
 
$ export PATH=/opt/qt-qpa/bin:$PATH
 
$ export LD_LIBRARY_PATH=/opt/qt-qpa/lib
 
$ qmake
 
$ make
 
  
And run it by executing the compiled binary:
+
=== Running graphical applications as root ===
$ export LD_LIBRARY_PATH=/opt/qt-qpa/lib
 
$ export QT_QPA_PLATFORM=waylandgl
 
$ ./binaryname
 
  
=== Qt Compositor ===
+
See [[Running GUI apps as root]].
There is ongoing work to make [http://labs.qt.nokia.com/2011/03/18/multi-process-lighthouse/ Qt-Compositor], a base layer to make custom Qt compositors on top of Wayland.
 
  
== Other GUI libraries ==
+
{{Style|Many of these subsections should go into a "Known issues" section (i.e., there is no solution currently). Additionally prepending a date is not needed.}}
([http://wayland.freedesktop.org/toolkits.html page from official website])
 
  
===GTK+===
+
=== LLVM assertion failure ===
 +
If you get an LLVM assertion failure, you need to rebuild {{Pkg|mesa}} without Gallium LLVM until this problem is fixed.
  
With GTK+ 3.0, GTK+ gained support for multiple backends at runtime and can switch between backends in the same way Qt can with lighthouse. The Wayland support is on the upstream GTK+ master branch but disabled by default. To try GTK+ on Wayland, check out gtk+ and pass <code>--enable-wayland</code> to configure:
+
This may imply disabling some drivers which require LLVM.
 +
You may also try exporting the following, if having problems with hardware drivers:  
  
  $ git clone git://git.gnome.org/gtk+
+
  $ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so
$ cd gtk+
 
$ ./configure --prefix=/usr --enable-x11-backend --enable-wayland-backend --enable-debug=yes
 
$ make
 
  
When both Wayland and X backends are enabled, GTK+ will default to the X11 backend, but this can be overridden by setting the <code>GDK_BACKEND</code> environment variable to <code>wayland</code>.
+
=== 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 {{ic|1=CLUTTER_PAINT=disable-clipped-redraws:disable-culling}} set by yourself for Xorg-based gnome-shell. Just try to remove it from {{ic|/etc/environment}} or other rc files to see if everything goes back to normal.
  
{{Note|Alternatively, you can install {{AUR|gtk3-git}} from the [[AUR]].}}
+
=== X11 on tty1, Wayland on tty2 ===
 +
(20161209) windows of GNOME applications end up on tty2 no matter where started ([https://bugzilla.gnome.org/show_bug.cgi?id=774775 GNOME issue 774775)]
  
===Clutter===
+
=== GNOME Wayland on tty1, Weston on tty2 ===
 +
(20170106) apps started on GNOME with WAYLAND_DISPLAY set to weston make it not respond any more ([https://bugs.freedesktop.org/show_bug.cgi?id=99489 Wayland issue 99489])
  
The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is in the master branch of the [http://git.gnome.org/browse/clutter main repo] and can be activated by passing <code>--with-flavour=wayland</code> to the configure script.
+
=== weston-terminal ===
 +
(20161229) core dump when started on gnome
  
===SDL===
+
=== liteide ===
 +
(20161229) [https://github.com/visualfc/liteide/issues/734 core dump]] on GNOME and Weston.
  
Benjamin Franzke is working on a port of SDL to Wayland, it's available in his [http://cgit.freedesktop.org/~bnf/sdl-wayland/ sdl-wayland repo] on freedesktop.org. Further development upon Benjamins work was done by Andre Heider in his [https://github.com/dhewg/libsdl/tree/wl wayland branch] of libsdl.
+
=== screen recording ===
 +
Currently only {{AUR|green-recorder}} supports screen recording on Wayland (requires a GNOME session).
  
===EFL===
+
=== remote display ===
  
EFL has complete Wayland support. Please see [http://trac.enlightenment.org/e/wiki/Wayland here] for details.
+
* (20180401) mutter has now remote desktop enabled at compile time, see https://wiki.gnome.org/Projects/Mutter/RemoteDesktop and {{AUR|gnome-remote-desktop}} for details.
 +
* (20161229) there was a merge of FreeRDP into Weston in 2013, enabled via a compile flag. The {{Pkg|weston}} package does not have it enabled.
  
==Window managers and desktop shells==
+
=== Input grabbing in games, remote desktop and VM windows  ===
  
===KDE===
+
In contrast to Xorg, Wayland does not allow exclusive input device grabbing, also known as active or explicit grab (e.g. [https://tronche.com/gui/x/xlib/input/XGrabKeyboard.html keyboard], [https://tronche.com/gui/x/xlib/input/XGrabPointer.html mouse]), instead, it depends on the Wayland compositor to pass keyboard shortcuts and confine the pointer device to the application window.
  
The KDE Wayland support is expected to come in three phases, with the first two phases expected to be completed this year during the KDE SC 4.8 and 4.9 development cycles. Please see [http://community.kde.org/KWin/Wayland here] for details.
+
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.
  
Also, there is [http://blog.martin-graesslin.com/blog/2011/03/kwin-at-gsoc-2011/ early work] to make it possible to run KWin (KDE's window manager) on Wayland.
+
Wayland solves this by adding protocol extensions for Wayland and XWayland. Support for these extensions is needed to be added to the Wayland compositors. In the case of native Wayland clients, the used widget toolkits (e.g GTK, QT) needs to support these extensions or the applications themselves if no widget toolkit is being used. In the case of Xorg applications, no changes in the applications or widget toolkits are needed as the XWayland support is enough.
  
===GNOME===
+
These extensions are already included in {{pkg|wayland-protocols}}, and supported by {{pkg|xorg-server-xwayland}} 1.20.
  
GNOME will be ported to Wayland in a future version.
+
The related extensions are:
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml XWayland keyboard grabbing protocol]
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml Compositor shortcuts inhibit protocol]
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/relative-pointer/relative-pointer-unstable-v1.xml Relative pointer protocol]
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/pointer-constraints/pointer-constraints-unstable-v1.xml Pointer constraints protocol]
  
===Unity===
+
Supporting Wayland compositors:
Ubuntu desktop shell Unity, using Compiz window manager, was [http://www.markshuttleworth.com/archives/551 announced] to be ported to Wayland.
+
* Mutter, [[GNOME]]'s compositor [https://bugzilla.gnome.org/show_bug.cgi?id=783342 since release 3.28].
  
==See also==
+
Supporting widget toolkits:
* [[Cursor Themes]]
+
* GTK since release 3.22.18.
  
==External links==
+
== See also ==
 +
* [https://fedoraproject.org/wiki/How_to_debug_Wayland_problems Article about Wayland debugging on Fedora Wiki]
 +
* [[Cursor themes]]
 
* [https://bbs.archlinux.org/viewtopic.php?id=107499 Arch Linux forum discussion]
 
* [https://bbs.archlinux.org/viewtopic.php?id=107499 Arch Linux forum discussion]
 
* [http://wayland.freedesktop.org/docs/html/ Wayland documentation online]
 
* [http://wayland.freedesktop.org/docs/html/ Wayland documentation online]

Latest revision as of 16:07, 12 May 2018

Wayland is a protocol for a compositing window manager to talk to its clients, as well as a library implementing the protocol. Many major Linux desktop environments, like GNOME and KDE, support Wayland. There is also a compositor reference implementation called Weston. XWayland implements a compatibility layer to seamlessly run legacy X11 applications on Wayland.

Requirements

Most Wayland compositors only work on systems using Kernel mode setting.

Wayland by itself does not provide a graphical environment; for this you also need a compositor such as #Weston or Sway, or a desktop environment that includes a compositor like GNOME or KDE.

Buffer API support

For the GPU driver and Wayland compositor to be compatible they must support the same buffer API. There are two main APIs: GBM and EGLStreams.

Buffer API GPU driver support Wayland compositor support
GBM All except NVIDIA All
EGLStreams NVIDIA GNOME, Grefsen, Sway (will be removed)

Weston

Weston is the reference implementation of a Wayland compositor.

Installation

Install the weston package.

Usage

Keyboard Shortcuts (super = windows key - can be changed, see weston.ini) Ctrl-b
Cmd Action
Ctrl+Alt+Backspace Quit Weston
Super+Scroll (or PageUp/PageDown) Zoom in/out of desktop
Super+Tab Switch windows
Super+LMB Move Window
Super+MMB Rotate Window !
Super+RMB Resize Window
Super+Alt+Scroll Change window opacity
Super+K Force Kill Active Window
Super+KeyUp/KeyDown Switch Prev/Next Workspace
Super+Shift+KeyUp/KeyDown Grab Current Window and Switch Workspace
Super+Fn Switch to Workspace n
Super+S Take a screenshot
Super+R 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:

$ weston

Alternatively, to try to launch Weston natively, switch to a terminal and run:

$ weston-launch

Then at a TTY within Weston, you can run the demos. To launch a terminal emulator:

$ weston-terminal

To move flowers around the screen:

$ weston-flower 

To display images:

$ weston-image image1.jpg image2.jpg...

Configuration

Example configuration file for keyboard layout, module selection and UI modifications. See weston.ini(5) for full details. The Weston outputs differ slightly from xorg.conf's Monitors:

$ 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 HDMI-A-1 and DVI-I-1.

~/.config/weston.ini
[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

Minimal weston.ini :

~/.config/weston.ini
[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


XWayland

Install the xorg-server-xwayland 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:

~/.config/weston.ini
[core]
modules=xwayland.so
Note: if X is not already configured you may need to configure a keymap: Keyboard configuration in Xorg

Screencast recording

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

For Retina or HiDPI displays, use:

~/.config/weston.ini
[output]
name=...
scale=2

Shell font

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.

GUI libraries

See details on the official website.

GTK+ 3

The gtk3 package has the Wayland backend enabled. GTK+ will default to the Wayland backend, but it is possible to override it to Xwayland by modifying an environment variable: GDK_BACKEND=x11.

Qt 5

To enable Wayland support in Qt 5, install the qt5-wayland package.

To run a Qt 5 app with the Wayland plugin, use -platform wayland or set the QT_QPA_PLATFORM=wayland-egl environment variable.

Clutter

The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is enabled in the clutter package.

To run a Clutter app on Wayland, set CLUTTER_BACKEND=wayland.

SDL2

To run a SDL2 application on Wayland, set SDL_VIDEODRIVER=wayland.

GLFW

To use GLFW with the Wayland backend, install the glfw-wayland package (instead of glfw-x11).

GLEW

To use GLEW with the Wayland backend, install the glew-wayland package (instead of glew).

EFL

EFL has complete Wayland support. To run a EFL application on Wayland, see Wayland project page.

Compositors

Name Type Description
GNOME Stacking See GNOME#Starting.
sway Tiling Sway is an i3-compatible window manager for Wayland. GitHub
Enlightenment Stacking More Info
KDE Plasma Stacking See KDE#Starting Plasma
Orbment Tiling orbment (previously loliwm) is an abandonned 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 way-coolerAUR 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.

Troubleshooting

Running graphical applications as root

See Running GUI apps as root.

Tango-edit-clear.pngThis article or section needs language, wiki syntax or style improvements.Tango-edit-clear.png

Reason: Many of these subsections should go into a "Known issues" section (i.e., there is no solution currently). Additionally prepending a date is not needed. (Discuss in Talk:Wayland#)

LLVM assertion failure

If you get an LLVM assertion failure, you need to rebuild mesa without 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.

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 weston make it not respond any more (Wayland issue 99489)

weston-terminal

(20161229) core dump when started on gnome

liteide

(20161229) core dump] on GNOME and Weston.

screen recording

Currently only green-recorderAUR supports screen recording on Wayland (requires a GNOME session).

remote display

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 the Wayland compositors. In the case of native Wayland clients, the used widget toolkits (e.g GTK, QT) needs to support these extensions or the applications themselves if no widget toolkit is being used. In the case of Xorg applications, no changes in the applications or widget toolkits are needed as the XWayland support is enough.

These extensions are already included in wayland-protocols, and supported by xorg-server-xwayland 1.20.

The related extensions are:

Supporting Wayland compositors:

Supporting widget toolkits:

  • GTK since release 3.22.18.

See also