Difference between revisions of "Wayland"

From ArchWiki
Jump to: navigation, search
m (Installation: Grammar fix)
(added more precise description to Motorcar compositor)
 
(261 intermediate revisions by 88 users not shown)
Line 1: Line 1:
[[Category:X Server]]
+
[[Category:X server]]
 +
[[es:Wayland]]
 +
[[fr: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].
+
[http://wayland.freedesktop.org/ Wayland] is a protocol for a [[wikipedia:Compositing window manager|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". [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.}}
+
{{Expansion|Link to bug report; does this really fit in the intro? This is the biggest issue according to whom?}}
 +
 
 +
The biggest issue is, in 2016, with screen recording, as applications do not see other applications contents any more.
  
 
== Requirements ==
 
== Requirements ==
Currently Wayland will only work with on a system that is utilizing [[KMS]].
 
  
== Installation ==
+
Wayland only works on systems using [[KMS]]. As Wayland is only a library, it is useless on its own: to replace the X Server you need a compositor such as [[#Weston]].
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 ==
+
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.
+
  
 
== 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:  
+
{{Style|Violates [[Help:Style#Keyboard keys]].}}
$ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so
+
if you have troubles with your hardware's driver.
+
  
Then at a TTY you can run the demos:
+
{| class="wikitable" style="float: right; width: 40%; margin-left: 1em"
 +
|+ '''''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.
 +
|}
  
 +
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
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
 
Runs glxgears on Wayland.
 
  
 +
To display images:
 
  $ weston-image image1.jpg image2.jpg...
 
  $ weston-image image1.jpg image2.jpg...
Displays images.
 
  
$ weston-view doc1.pdf doc2.pdf...
+
=== Configuration ===
Displays PDF files.
+
Example configuration file for keyboard layout, module selection and UI modifications. See {{man|5|weston.ini|url=}} for full details. The Weston outputs differ slightly from {{ic|xorg.conf}}'s Monitors:
  
== Qt ==
+
$ ls /sys/class/drm
 +
card0
 +
card0-VGA-1
 +
card1
 +
card1-DVI-I-1
 +
card1-HDMI-A-1
 +
card1-VGA-2
  
=== Installation ===
+
{{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}}.
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 ===
+
{{hc|~/.config/weston.ini|<nowiki>
At first, you need a working Wayland compositor, like the one from demo applications, or an experimental version of KWin.
+
[core]
 +
# xwayland support
 +
modules=xwayland.so
  
Then compile any qmake-based Qt project:
+
[libinput]
$ export PATH=/opt/qt-qpa/bin:$PATH
+
enable_tap=true
$ export LD_LIBRARY_PATH=/opt/qt-qpa/lib
+
$ qmake
+
$ make
+
  
And run it by executing the compiled binary:
+
[shell]
$ export LD_LIBRARY_PATH=/opt/qt-qpa/lib
+
background-image=/usr/share/backgrounds/gnome/Aqua.jpg
$ export QT_QPA_PLATFORM=waylandgl
+
background-color=0xff002244
$ ./binaryname
+
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
  
=== Qt Compositor ===
+
### tablet options ###
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.
+
#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
  
== Other GUI libraries ==
+
###  for Laptop displays  ###
([http://wayland.freedesktop.org/toolkits.html page from official website])
+
#[output]
 +
#name=LVDS1
 +
#mode=1680x1050
 +
#transform=90
  
===GTK+===
+
#[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
  
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:
+
#[output]
 +
#name=X1
 +
#mode=1024x768
 +
#transform=flipped-270
  
$ git clone git://git.gnome.org/gtk+
+
[input-method]
$ cd gtk+
+
#path=/usr/lib/weston/weston-keyboard
$ ./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>.
+
[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
  
{{Note|Alternatively, you can install {{AUR|gtk3-git}} from the [[AUR]].}}
+
[terminal]
 +
#font=DroidSansMono
 +
#font-size=14
  
===Clutter===
+
[launcher]
 +
icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png
 +
path=/usr/bin/weston-terminal
  
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.
+
[launcher]
 +
icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png
 +
path=/usr/bin/gnome-terminal
  
===SDL===
+
[launcher]
 +
icon=/usr/share/icons/hicolor/24x24/apps/firefox.png
 +
path=/usr/bin/firefox
  
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.
+
[launcher]
 +
icon=/usr/share/weston/icon_flower.png
 +
path=/usr/bin/weston-flower
  
===EFL===
+
[screensaver]
 +
# Uncomment path to disable screensaver
 +
path=/usr/libexec/weston-screensaver
 +
duration=600
 +
</nowiki>
 +
}}
  
EFL has complete Wayland support. Please see [http://trac.enlightenment.org/e/wiki/Wayland here] for details.
+
Minimal {{ic|weston.ini}} :
 +
{{hc|~/.config/weston.ini|<nowiki>
 +
[core]
 +
modules=xwayland.so
  
==Window managers and desktop shells==
+
[keyboard]
 +
keymap_layout=gb
  
===KDE===
+
[output]
 +
name=LVDS1
 +
mode=1680x1050
 +
transform=90
  
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.
+
[launcher]
 +
icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png
 +
path=/usr/bin/weston-terminal
  
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.
+
[launcher]
 +
icon=/usr/share/icons/hicolor/24x24/apps/firefox.png
 +
path=/usr/bin/firefox
  
===GNOME===
+
</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.
 +
 
 +
== Gnome ==
 +
 
 +
=== Install and test ===
 +
 
 +
If you run Gnome, install XWayland with the {{Pkg|xorg-server-xwayland}} package, then run it:
 +
 
 +
$ dbus-run-session -- gnome-shell --display-server --wayland
 +
 
 +
To test, install the {{Pkg|weston}} package and run one of its applications, for example:
 +
$ weston-stacking
 +
 
 +
This is still experimental (state 2016-11-18) and not everything will run as expected. Known issues:
 +
 
 +
* When launching without GDM, gnome-session needs to be started manual, no shutdown/restart buttons work ([https://bugzilla.gnome.org/show_bug.cgi?id=774774 gnome issue 774774])
 +
* Starting X11 on tty1, wayland on tty2: windows of gnome applications end up on tty2 no matter where started ([https://bugzilla.gnome.org/show_bug.cgi?id=774775 gnome issue 774775)]
 +
* Not all weston applications work, e.g. weston-terminal.
 +
 
 +
{{Expansion|Please add a link to easily keep this entry up to date.}}
 +
 
 +
* As of November 2016 there is an ongoing discussion how to implement screen recording. Currently the compositors implement at least basic functionality, so does gnome.
 +
 
 +
=== Autostart ===
 +
 
 +
To auto-start on login, only on virtual terminal 1, one can enter this into {{ic|.bash_profile}}:
 +
 
 +
<nowiki>[[ -z $DISPLAY && $XDG_VTNR -eq 1 ]] && dbus-run-session -- gnome-shell --display-server --wayland</nowiki>
 +
 
 +
More details on this way of starting are on [[Xinit#Autostart X at login]] (not using a display manager) and [[GNOME#Manually]] (resp via xinit in this case).
 +
 
 +
=== hints ===
 +
some practical settings. for nemo prevent that the desktop is created <ref>[https://github.com/linuxmint/nemo/issues/1343 nemo issue 1343]</ref>
 +
gsettings set org.nemo.desktop show-desktop-icons false
 +
 
 +
== GUI libraries ==
 +
 
 +
See details on the [http://wayland.freedesktop.org/toolkits.html official website].
 +
 
 +
=== GTK+ 3 ===
 +
 
 +
The {{Pkg|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: {{ic|GDK_BACKEND&#61;wayland}}.
 +
 
 +
=== 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]].
 +
 
 +
=== 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 {{ic|CLUTTER_BACKEND&#61;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 {{ic|SDL_VIDEODRIVER&#61;wayland}}.
 +
 
 +
=== GLFW ===
 +
 
 +
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.
 +
 
 +
=== 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 using Virtual Reality.
 +
|-
 +
| Way Cooler
 +
| Tiling
 +
|  {{AUR|way-cooler}} is a customizeable (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.
 +
|}
 +
 
 +
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
  
GNOME will be ported to Wayland in a future version.
+
=== Applications using dbus crashes on startup ===
 +
For a temporary solution, use {{ic|dbus-launch}} to run the application. For example, to launch {{Pkg|gnome-terminal}} inside a weston session, this command is sufficient.
  
===Unity===
+
  dbus-launch gnome-terminal
Ubuntu desktop shell Unity, using Compiz window manager, was [http://www.markshuttleworth.com/archives/551 announced] to be ported to Wayland.
+
  
==See also==
+
=== Slow motion, graphical glitches, and crashes ===
* [[Cursor Themes]]
+
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.
  
==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 04:09, 7 December 2016

Related articles

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.

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: Link to bug report; does this really fit in the intro? This is the biggest issue according to whom? (Discuss in Talk:Wayland#)

The biggest issue is, in 2016, with screen recording, as applications do not see other applications contents any more.

Requirements

Wayland only works on systems using KMS. As Wayland is only a library, it is useless on its own: to replace the X Server you need a compositor such as #Weston.

Weston

Weston is the reference implementation of a Wayland compositor.

Installation

Install the weston package.

Usage

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

Reason: Violates Help:Style#Keyboard keys. (Discuss in Talk:Wayland#)
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
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.

Gnome

Install and test

If you run Gnome, install XWayland with the xorg-server-xwayland package, then run it:

$ dbus-run-session -- gnome-shell --display-server --wayland

To test, install the weston package and run one of its applications, for example:

$ weston-stacking

This is still experimental (state 2016-11-18) and not everything will run as expected. Known issues:

  • When launching without GDM, gnome-session needs to be started manual, no shutdown/restart buttons work (gnome issue 774774)
  • Starting X11 on tty1, wayland on tty2: windows of gnome applications end up on tty2 no matter where started (gnome issue 774775)
  • Not all weston applications work, e.g. weston-terminal.

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: Please add a link to easily keep this entry up to date. (Discuss in Talk:Wayland#)
  • As of November 2016 there is an ongoing discussion how to implement screen recording. Currently the compositors implement at least basic functionality, so does gnome.

Autostart

To auto-start on login, only on virtual terminal 1, one can enter this into .bash_profile:

[[ -z $DISPLAY && $XDG_VTNR -eq 1 ]] && dbus-run-session -- gnome-shell --display-server --wayland

More details on this way of starting are on Xinit#Autostart X at login (not using a display manager) and GNOME#Manually (resp via xinit in this case).

hints

some practical settings. for nemo prevent that the desktop is created <ref>nemo issue 1343</ref>

gsettings set org.nemo.desktop show-desktop-icons false

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 using Virtual Reality.
Way Cooler Tiling way-coolerAUR is a customizeable (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

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

Applications using dbus crashes on startup

For a temporary solution, use dbus-launch to run the application. For example, to launch gnome-terminal inside a weston session, this command is sufficient.

 dbus-launch gnome-terminal

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.

See also