Difference between revisions of "Wayland"

From ArchWiki
Jump to: navigation, search
(Unity won't work on Wayland.)
(Window managers and desktop shells: wikitable sortable)
 
(170 intermediate revisions by 72 users not shown)
Line 1: Line 1:
[[Category:X Server]]
+
[[Category:X server]]
 +
[[es:Wayland]]
 
[[fr:Wayland]]
 
[[fr:Wayland]]
 
[[ja:Wayland]]
 
[[ja:Wayland]]
 +
[[ru:Wayland]]
 
[[zh-CN:Wayland]]
 
[[zh-CN:Wayland]]
{{Article summary start}}
+
{{Related articles start}}
{{Article summary text|A guide to installing and running the Wayland display server.}}
+
{{Related|KMS}}
{{Article summary heading|Related}}
+
{{Related|Xorg}}
{{Article summary wiki|KMS}}
+
{{Related|Mir}}
{{Article summary wiki|Xorg}}
+
{{Related articles end}}
{{Article summary 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].
 
'''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].
 
{{Warning|Wayland is under heavy development.  Support can not be guaranteed and it may not function as you expect.}}
 
  
 
== Requirements ==
 
== Requirements ==
Currently Wayland will only work with on a system that is utilizing [[KMS]].
+
 
 +
Currently Wayland will only work on systems utilizing [[KMS]].
  
 
== Installation ==
 
== Installation ==
Wayland is most probably installed on your system already as it is an indirect dependency of {{pkg|gtk2}} and {{pkg|gtk3}}. If it is not installed, you will find the {{pkg|wayland}} package in extra.
+
{{Note|Wayland is most likely installed on your system already, since it is an indirect dependency of {{Pkg|gtk2}} and {{Pkg|gtk3}}.}}
 +
 
 +
[[Install]] the {{Pkg|wayland}} package.
  
 
== Usage ==
 
== Usage ==
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 with Wayland plugin, and/or GTK+ with Wayland support.
+
 
 +
As Wayland is only a library, it is useless on its own. To replace X Server, you need a compositor (like [[#Weston]]).
  
 
== Weston ==
 
== Weston ==
 +
 
=== Installation ===
 
=== Installation ===
You need to install {{pkg|weston}} from community.
+
 
{{Note|If you get the following error: "Failed to create XKB context", install {{Pkg|xkeyboard-config}}: {{ic|# pacman -S xkeyboard-config}} }}
+
[[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|There may be some trouble with keyboard & mouse not working unless this is ran as root.}}
 
  
You may also try exporting the following, if having problems with hardware drivers:  
+
{| class="wikitable" style="float: right; width: 200px;"
$ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so
+
|+ '''''Keyboard Shortcuts''' (super = windows key - can be changed, see weston.ini)'' {{Ic|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 + F'''''n'''''
 +
|Switch to Workspace '''''n'''''
 +
|-
 +
|Super + S
 +
|Take a screenshot
 +
|-
 +
|Super + R
 +
|Record a screencast.
 +
|}
  
Then at a TTY you can run the demos. To launch a terminal emulator:
+
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
 
  $ weston-terminal
  
Line 48: Line 98:
 
  $ weston-image image1.jpg image2.jpg...
 
  $ weston-image image1.jpg image2.jpg...
  
To display PDF Files:
+
=== Configuration ===
  $ weston-view doc1.pdf doc2.pdf...
+
Example configuration file for keyboard layout, module selection and UI modifications. See {{ic|man weston.ini}} for full details:
 +
 
 +
{{hc|~/.config/weston.ini|<nowiki>
 +
[core]
 +
# xwayland support
 +
modules=xwayland.so
 +
 
 +
 
 +
[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]
 +
modules=xwayland.so
 +
 
 +
[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>
 +
}}
 +
 
 +
==== 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 ==
 
== GUI libraries ==
([http://wayland.freedesktop.org/toolkits.html page from official website])
 
  
===GTK+===
+
See details on the [http://wayland.freedesktop.org/toolkits.html official website].
  
You need to install {{pkg|gtk3}} from extra, which now has the Wayland backend enabled.
+
=== GTK+ 3 ===
  
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 {{Pkg|gtk3}} package from the official repositories now has the Wayland backend enabled.
  
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>.
+
GTK+ 3 gained support for multiple backends at runtime and can switch between backends in the same way Qt can with lighthouse.
  
Remove {{pkg|libcanberra}} if you get segmentation faults when running gtk applications. A [http://git.0pointer.de/?p=libcanberra.git;a=commit;h=c0620e432650e81062c1967cc669829dbd29b310 fix] for these segfaults has been committed as of 9 Nov 2012, so presumably as soon as 0.31.0 comes out, this should not be necessary anymore.
+
When both Wayland and X backends are enabled, GTK+ will default to the X11 backend, but this can be overridden by modifying an environment variable: {{ic|GDK_BACKEND&#61;wayland}}.
  
===Qt5===
+
=== Qt 5 ===
 +
The {{Grp|qt5}} package from the repositories has the Wayland support if {{Pkg|qt5-wayland}} is installed.
 +
To run a Qt 5 app with the Wayland plugin, set the {{ic|1=QT_QPA_PLATFORM=wayland-egl}} [[environment variable]].
  
You need to install {{pkg|qt5-base}} and the wayland plugin - {{aur|qt5-qtwayland-git}}.
+
=== Clutter ===
  
To run a Qt5 app with the Wayland plugin, set QT_QPA_PLATFORM=wayland-egl.
+
The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is enabled in the official package in extra.
  
===Clutter===
+
To run a Clutter app on Wayland, set {{ic|CLUTTER_BACKEND&#61;wayland}}.
  
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.
+
=== SDL ===
  
===SDL===
+
Experimental wayland support is now in SDL 2.0.2 and enabled by default on Arch Linux.
  
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.
+
To run a SDL application on Wayland, set {{ic|SDL_VIDEODRIVER&#61;wayland}}.
  
===EFL===
+
=== GLFW ===
  
EFL has complete Wayland support. Please see [http://trac.enlightenment.org/e/wiki/Wayland here] for details.
+
Experimental wayland support is now in GLFW 3.1 and can be enabled with the {{ic|-DGLFW_USE_WAYLAND&#61;ON}} CMake option at compile time. You can also install the package {{AUR|glfw-wayland-git}} from the AUR.
  
==Window managers and desktop shells==
+
=== EFL ===
 +
 
 +
EFL has complete Wayland support.
 +
To run a EFL application on Wayland, see Wayland [http://wayland.freedesktop.org/efl.html project page].
 +
 
 +
== Window managers and desktop shells ==
 +
 
 +
{| class="wikitable sortable"
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| GNOME
 +
| Compositing
 +
| See [[GNOME#Starting GNOME]].
 +
|-
 +
| Hawaii
 +
| ''(Unclear)''
 +
| See [[Hawaii]].
 +
|-
 +
| sway
 +
| Tiling
 +
| [[Sway]] is an i3-compatible window manager for Wayland. [https://github.com/SirCmpwn/sway Github]
 +
|-
 +
| Enlightenment
 +
| ''(Unclear)''
 +
| Long running minimal Window Manager-turned Wayland compositor. E19 originally had Wayland support but this was removed and now only E20+ Wayland is considered stable enough for regular use. [https://www.enlightenment.org/about-wayland More Info]
 +
|-
 +
| KDE Plasma
 +
| Compositing
 +
| See [[KDE#Starting Plasma]]
 +
|-
 +
| Orbment
 +
| Tiling
 +
| [https://github.com/Cloudef/orbment 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
 +
| Compositing
 +
| [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]].
 +
|-
 +
| Papyros Shell
 +
| ''(Unclear)''
 +
| [https://github.com/papyros/papyros-shell Papyros Shell] is the desktop shell for [[Papyros]], 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.
 +
|-
 +
| Way Cooler
 +
| Tiling
 +
|  {{AUR|way-cooler}} is a customizeable (lua config files) Wayland compositor written in Rust. Inspired by i3 and awesome.
 +
|}
 +
 
 +
Some of installed wayland desktop clients might store information in {{ic|/usr/share/wayland-sessions/*.desktop}} files about how to start them in wayland.
 +
 
 +
==Troubleshooting==
 +
 
 +
=== LLVM assertion failure ===
 +
If you get an LLVM assertion failure, you need to rebuild {{Pkg|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
  
===KDE===
+
=== Weston fails to launch after update to 1.7 ===
 +
This is possibly caused by the {{ic|desktop-shell.so}} module being loaded by your {{ic|weston.ini}}. This used to be required, but is not anymore.
  
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.
+
Remove it from the {{ic|[core]}} section:
  
===GNOME===
+
{{hc|~/.config/weston.ini|
 +
<nowiki>[core]
 +
modules=xwayland.so,desktop-shell.so</nowiki>
 +
}}
  
GNOME will be ported to Wayland in a future version.
+
So that you end up with:
  
==See also==
+
{{hc|~/.config/weston.ini|
* [[Cursor Themes]]
+
<nowiki>[core]
 +
modules=xwayland.so</nowiki>
 +
}}
  
==External links==
+
== See also ==
 +
* [[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 23:04, 22 August 2016

Related articles

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 homepage.

Requirements

Currently Wayland will only work on systems utilizing KMS.

Installation

Note: Wayland is most likely installed on your system already, since it is an indirect dependency of gtk2 and gtk3.

Install the wayland package.

Usage

As Wayland is only a library, it is useless on its own. To replace X Server, you need a compositor (like #Weston).

Weston

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 test the frame protocol (runs glxgears):

$ weston-gears

To display images:

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

Configuration

Example configuration file for keyboard layout, module selection and UI modifications. See man weston.ini for full details:

~/.config/weston.ini
[core]
# xwayland support
modules=xwayland.so


[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]
modules=xwayland.so

[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

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 from the official repositories now has the Wayland backend enabled.

GTK+ 3 gained support for multiple backends at runtime and can switch between backends in the same way Qt can with lighthouse.

When both Wayland and X backends are enabled, GTK+ will default to the X11 backend, but this can be overridden by modifying an environment variable: GDK_BACKEND=wayland.

Qt 5

The qt5 package from the repositories has the Wayland support if qt5-wayland is installed. To run a Qt 5 app with the Wayland plugin, 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 official package in extra.

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

SDL

Experimental wayland support is now in SDL 2.0.2 and enabled by default on Arch Linux.

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

GLFW

Experimental wayland support is now in GLFW 3.1 and can be enabled with the -DGLFW_USE_WAYLAND=ON CMake option at compile time. You can also install the package glfw-wayland-gitAUR from the AUR.

EFL

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

Window managers and desktop shells

Name Type Description
GNOME Compositing See GNOME#Starting GNOME.
Hawaii (Unclear) See Hawaii.
sway Tiling Sway is an i3-compatible window manager for Wayland. Github
Enlightenment (Unclear) Long running minimal Window Manager-turned Wayland compositor. E19 originally had Wayland support but this was removed and now only E20+ Wayland is considered stable enough for regular use. More Info
KDE Plasma Compositing 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 Compositing 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.
Papyros Shell (Unclear) Papyros Shell is the desktop shell for Papyros, 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.
Way Cooler Tiling way-coolerAUR is a customizeable (lua config files) Wayland compositor written in Rust. Inspired by i3 and awesome.

Some of installed wayland desktop clients might store information in /usr/share/wayland-sessions/*.desktop files about how to start them in wayland.

Troubleshooting

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

Weston fails to launch after update to 1.7

This is possibly caused by the desktop-shell.so module being loaded by your weston.ini. This used to be required, but is not anymore.

Remove it from the [core] section:

~/.config/weston.ini
[core]
modules=xwayland.so,desktop-shell.so

So that you end up with:

~/.config/weston.ini
[core]
modules=xwayland.so

See also