Difference between revisions of "Wayland"

From ArchWiki
Jump to: navigation, search
(→‎XWayland: move introduction to beginning of parent section)
(Grefsen can run on eglstreams)
 
(236 intermediate revisions by 80 users not shown)
Line 1: Line 1:
−
[[Category:X Server]]
+
[[Category:X server]]
 +
[[es:Wayland]]
 
[[fr:Wayland]]
 
[[fr:Wayland]]
 
[[ja:Wayland]]
 
[[ja:Wayland]]
−
[[zh-CN:Wayland]]
+
[[ru:Wayland]]
−
{{Article summary start}}
+
[[zh-hans:Wayland]]
−
{{Article summary text|A guide to installing and running the Wayland display server.}}
+
{{Related articles start}}
−
{{Article summary heading|Related}}
+
{{Related|KMS}}
−
{{Article summary wiki|KMS}}
+
{{Related|Xorg}}
−
{{Article summary wiki|Xorg}}
+
{{Related|Mir}}
−
{{Article summary wiki|Mir}}
+
{{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].
 
  
−
{{Warning|Wayland is under heavy development. Support can not be guaranteed and it may not function as you expect.}}
+
[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.
  
 
== Requirements ==
 
== Requirements ==
  
−
Currently Wayland will only work on a system that is utilizing [[KMS]].
+
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]].
  
−
== Installation ==
+
=== Buffer API support ===
  
−
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  the [[official repositories]].
+
For the GPU driver and Wayland composer 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].
  
−
== Usage ==
+
{| class="wikitable"
 +
|-
 +
! Buffer API !! GPU driver support !! Wayland compositor support
 +
|-
 +
| GBM || All except [[NVIDIA]] || All
 +
|-
 +
| EGLStreams || [[NVIDIA]] || [[GNOME]], [[Sway]], [[Grefsen]]
 +
|-
 +
|}
  
−
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.
+
== Weston ==
  
−
== Weston ==
+
Weston is the reference implementation of a Wayland compositor.
  
 
=== Installation ===
 
=== Installation ===
  
−
You need to install {{Pkg|weston}} from the official repositories.
+
Install the {{Pkg|weston}} package.
  
 
=== Usage ===
 
=== Usage ===
  
−
{| style="float:right;border:1px #cccccc solid;margin:5px;padding:5px;width:200px;"
+
{| class="wikitable" style="float: right; width: 40%; margin-left: 1em"
 
|+ '''''Keyboard Shortcuts''' (super = windows key - can be changed, see weston.ini)'' {{Ic|Ctrl-b}}
 
|+ '''''Keyboard Shortcuts''' (super = windows key - can be changed, see weston.ini)'' {{Ic|Ctrl-b}}
 
!Cmd
 
!Cmd
 
!Action
 
!Action
 
|-
 
|-
−
|Ctrl + Alt + Backspace
+
|{{ic|Ctrl+Alt+Backspace}}
 
|Quit Weston
 
|Quit Weston
 
|-
 
|-
−
|Super + Scroll (or PageUp/PageDown)
+
|{{ic|Super+Scroll}} (or {{ic|PageUp}}/{{ic|PageDown}})
 
|Zoom in/out of desktop
 
|Zoom in/out of desktop
 
|-
 
|-
−
|Super + Tab
+
|{{ic|Super+Tab}}
 
|Switch windows
 
|Switch windows
 
|-
 
|-
−
|Super + LMB
+
|{{ic|Super+LMB}}
 
|Move Window
 
|Move Window
 
|-
 
|-
−
|Super + MMB
+
|{{ic|Super+MMB}}
−
|Resize Window
+
|Rotate Window !
 
|-
 
|-
−
|Super + RMB
+
|{{ic|Super+RMB}}
−
|Rotate Window !
+
|Resize Window  
 
|-
 
|-
−
|Super + Tab
+
|{{ic|Super+Alt+Scroll}}
−
|Switch windows
+
|Change window opacity
 
|-
 
|-
−
|Super + K
+
|{{ic|Super+K}}
 
|Force Kill Active Window
 
|Force Kill Active Window
 
|-
 
|-
−
|Super + KeyUp/KeyDown
+
|{{ic|Super+KeyUp/KeyDown}}
 
|Switch Prev/Next Workspace
 
|Switch Prev/Next Workspace
 
|-
 
|-
−
|Super + Shift + KeyUp/KeyDown
+
|{{ic|Super+Shift+KeyUp/KeyDown}}
 
|Grab Current Window and Switch Workspace
 
|Grab Current Window and Switch Workspace
 
|-
 
|-
−
|Super + F'''''n'''''
+
|{{ic|Super+F'''''n'''''}}
 
|Switch to Workspace '''''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.  
 
Now that Wayland and its requirements are installed you should be ready to test it out.  
−
 
−
{{Note|
 
−
You need to be in the video group for Weston to start; this command is not supposed to be run as root and doing so may freeze your VT !
 
−
}}
 
  
 
It is possible to run Weston inside a running X session:
 
It is possible to run Weston inside a running X session:
 
  $ weston
 
  $ weston
  
−
Alternatively, to launch Weston natively, try switching to a terminal and running:
+
Alternatively, to try to launch Weston natively, switch to a terminal and run:
 
  $ weston-launch
 
  $ weston-launch
  
Line 91: Line 99:
 
To move flowers around the screen:
 
To move flowers around the screen:
 
  $ weston-flower  
 
  $ weston-flower  
−
 
−
To test the frame protocol (runs {{ic|glxgears}}):
 
−
$ weston-gears
 
  
 
To display images:
 
To display images:
 
  $ 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 {{man|5|weston.ini|url=}} 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
 +
modules=xwayland.so
  
−
=== Configuration ===
+
[libinput]
−
Example configuration file for keyboard layout, module selection and UI modifications. See {{ic|man weston.ini}} for full details:
+
enable_tap=true
−
{{hc|~/.config/weston.ini|
 
−
<nowiki>[core]
 
−
### uncomment this line for xwayland support ###
 
−
#modules=desktop-shell.so,xwayland.so
 
  
 
[shell]
 
[shell]
Line 114: Line 130:
 
locking=true
 
locking=true
 
animation=zoom
 
animation=zoom
 +
close-animation=fade
 +
focus-animation=dim-layer
 
#binding-modifier=ctrl
 
#binding-modifier=ctrl
 
#num-workspaces=6
 
#num-workspaces=6
Line 125: Line 143:
 
#homescreen=/usr/share/backgrounds/gnome/Blinds.jpg
 
#homescreen=/usr/share/backgrounds/gnome/Blinds.jpg
 
#animation=fade
 
#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]
 
[keyboard]
 
keymap_rules=evdev
 
keymap_rules=evdev
−
#keymap_layout=gb
+
#keymap_layout=gb,de
 
#keymap_options=caps:ctrl_modifier,shift:both_capslock_cancel
 
#keymap_options=caps:ctrl_modifier,shift:both_capslock_cancel
 
### keymap_options from /usr/share/X11/xkb/rules/base.lst ###
 
### keymap_options from /usr/share/X11/xkb/rules/base.lst ###
−
 
+
numlock-on=true
  
 
[terminal]
 
[terminal]
 
#font=DroidSansMono
 
#font=DroidSansMono
 
#font-size=14
 
#font-size=14
−
 
−
 
  
 
[launcher]
 
[launcher]
 
icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png
 
icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png
−
path=/usr/bin/gnome-terminal
+
path=/usr/bin/weston-terminal
  
 
[launcher]
 
[launcher]
 
icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png
 
icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png
−
path=/usr/bin/weston-terminal
+
path=/usr/bin/gnome-terminal
  
 
[launcher]
 
[launcher]
−
icon=/usr/share/icons/hicolor/24x24/apps/google-chrome.png
+
icon=/usr/share/icons/hicolor/24x24/apps/firefox.png
−
path=/usr/bin/google-chrome
+
path=/usr/bin/firefox
  
 
[launcher]
 
[launcher]
−
icon=/usr/share/icons/gnome/24x24/apps/arts.png
+
icon=/usr/share/weston/icon_flower.png
−
path=./clients/flower
+
path=/usr/bin/weston-flower
  
 
[screensaver]
 
[screensaver]
Line 159: Line 195:
 
path=/usr/libexec/weston-screensaver
 
path=/usr/libexec/weston-screensaver
 
duration=600
 
duration=600
−
 
+
</nowiki>
−
[input-method]
 
−
path=/usr/libexec/weston-keyboard
 
−
 
 
−
###  for Laptop displays  ###
 
−
#[output]
 
−
#name=LVDS1
 
−
#mode=1680x1050
 
−
#transform=90
 
−
 
 
−
#[output]
 
−
#name=VGA1
 
−
#modeline=173.00 1920 2048 2248 2576 1080 1083 1088 1120 -hsync +vsync
 
−
#transform=flipped
 
−
 
 
−
#[output]
 
−
#name=X1
 
−
#mode=1024x768
 
−
#transform=flipped-270</nowiki>
 
 
}}
 
}}
  
 
Minimal {{ic|weston.ini}} :
 
Minimal {{ic|weston.ini}} :
−
{{hc|~/.config/weston.ini|
+
{{hc|~/.config/weston.ini|<nowiki>
−
<nowiki>[core]
+
[core]
−
modules=desktop-shell.so,xwayland.so
+
modules=xwayland.so
  
 
[keyboard]
 
[keyboard]
 
keymap_layout=gb
 
keymap_layout=gb
 +
 +
[output]
 +
name=LVDS1
 +
mode=1680x1050
 +
transform=90
  
 
[launcher]
 
[launcher]
Line 193: Line 216:
  
 
[launcher]
 
[launcher]
−
icon=/usr/share/icons/hicolor/24x24/apps/google-chrome.png
+
icon=/usr/share/icons/hicolor/24x24/apps/firefox.png
−
path=/usr/bin/google-chrome
+
path=/usr/bin/firefox
−
 
 
  
−
[output]
+
</nowiki>
−
name=LVDS1
 
−
mode=1680x1050
 
−
transform=90</nowiki>
 
 
}}
 
}}
  
 
==== XWayland ====
 
==== XWayland ====
−
XWayland ''is'' an XOrg server and compiles as a drop in replacement. The only difference is that it is sourced from the Wayland branch of the xorg-server repository and as such has the Wayland extensions. These extensions allow it to run as a client of Weston.
+
[[Install]] the {{Pkg|xorg-server-xwayland}} package.
  
−
When you want to run an X application from within Weston, it spins up this modified X server to service the request.
+
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:
  
−
{{Warning|The steps in this section set out ''to replace your graphics stack''. An incomplete installation could result in a broken graphical environment.}}
 
−
 
−
If you plan to run native X-applications inside Wayland, then you have to install {{AUR|xorg-server-xwayland}} and either patched graphic drivers according to your system, e.g. {{AUR|xf86-video-intel-xwayland-git}}, or the generic wlglamor fallback found at {{AUR|xf86-video-wlglamor-git}}. After that, create or modify following configuration file:
 
 
{{hc|~/.config/weston.ini|
 
{{hc|~/.config/weston.ini|
 
<nowiki>[core]
 
<nowiki>[core]
−
modules=xwayland.so,desktop-shell.so</nowiki>
+
modules=xwayland.so</nowiki>
 
}}
 
}}
−
Now you can also run X applications in some kind of "compatibility mode". Final XWayland support should be available with the version 1.16 X-server release which is not due to land until [http://www.phoronix.com/scan.php?page=news_item&px=MTQ1NzM mid 2014].
 
  
−
The AUR packages may require some modification in order to compile successfully though ([https://bbs.archlinux.org/viewtopic.php?pid=1328812#p1328812 see this thread]). An alternative is to compile directly from source. This can be done in 3 steps (it is assumed you already have the {{ic|base-devel}} group installed).
+
==== 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.  
  
−
First install the standard XOrg packages and the appropriate video driver, this will pull in the required dependencies.
+
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:
  
−
{{Note|Unless you are on a fresh installation, you likely already have these. Just ensure you have the latest versions and if using [[ATI]] or [[NVIDIA]] that you are using the ''open source'' drivers.
+
$ wcap-decode capture.wcap --yuv4mpeg2 > capture.y4m
−
Wayland graphics hardware support seems to go Intel > ATI > NVidia so YMMV on non-Intel hardware. However the new {{ic|xf86-video-wlshm}} driver has been produced with the purpose of having high compatibility across all hardware stacks. }}
 
  
−
# pacman -S xorg-server xorg-server-utils xorg-xinit mesa
+
The YUV file can then be transcoded to other formats using [[FFmpeg]].
−
# pacman -S xf86-video-''yourdriver''
 
  
−
Second, checkout and compile the XWayland xorg server.
+
==== High DPI displays ====
  
−
{{Note|If you have 3GB of RAM or more, performing these operations in memory (e.g. {{ic|/tmp}}) is probably a good idea.}}
+
For [[wikipedia:Retina_Display|Retina]] or [[HiDPI]] displays, use:
  
−
{{bc|<nowiki>
+
{{hc|~/.config/weston.ini|
−
$ git clone git://anongit.freedesktop.org/xorg/xserver -b xwayland
+
<nowiki>[output]
−
$ cd xserver
+
name=...
−
$ ./autogen.sh --prefix=/usr/  --enable-xorg --enable-wayland
+
scale=2</nowiki>
−
$ make
+
}}
−
 
 
−
# make install
 
−
</nowiki>}}
 
−
 
 
−
Third, checkout and compile your video driver. The repos can be found on [http://wayland.freedesktop.org/xserver.html the official Wayland website]. As noted above, {{ic|xf86-video-wlshm}} is likely a good option for non-Intel graphics.
 
−
Following are the instructions for Intel hardware.
 
  
−
{{bc|<nowiki>
+
==== Shell font ====
−
$ git clone git://anongit.freedesktop.org/xorg/driver/xf86-video-intel -b xwayland
 
−
$ cd xf86-video-intel
 
−
$ ./autogen.sh --prefix=/usr/ --enable-dri --disable-xaa --with-default-accel=sna
 
−
$ make
 
  
−
# make install
+
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.
−
</nowiki>}}
 
−
 
 
−
If your Intel graphics are pre-Sandybridge use {{ic|<nowiki>--with-default-accel=uxa</nowiki>}} instead.  
 
−
 
 
−
Now that you have replaced your xorg-server and graphics driver with the XWayland patched versions you should be able to run XWayland.
 
−
To test, check that you have a small X application like {{ic|xterm}} or {{ic|xclock}} in your path, fire up Weston using {{ic|weston-launch}}, open weston-terminal and run the X application.
 
  
 
== GUI libraries ==
 
== GUI libraries ==
  
−
(See details on the [http://wayland.freedesktop.org/toolkits.html official website])
+
See details on the [http://wayland.freedesktop.org/toolkits.html official website].
−
 
 
−
=== GTK+ ===
 
−
 
 
−
You need to install {{Pkg|gtk3}} from the official repositories, which now has the Wayland backend enabled.
 
−
 
 
−
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.
 
  
−
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}}.
+
=== GTK+ 3 ===
  
−
=== Qt5 ===
+
The {{Pkg|gtk3}} package has the Wayland backend enabled. GTK+ will default to the X11 backend, but this can be overridden by modifying an environment variable: {{ic|GDK_BACKEND&#61;wayland}}.
  
−
You need to install {{Pkg|qt5-base}} and the wayland plugin {{AUR|qtwayland-git}}.
+
=== Qt 5 ===
 +
To enable Wayland support in Qt 5, install the {{Pkg|qt5-wayland}} package.
  
−
To run a Qt5 app with the Wayland plugin, set {{ic|QT_QPA_PLATFORM&#61;wayland-egl}}.
+
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 ===
 
=== 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.
+
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}}.
 
To run a Clutter app on Wayland, set {{ic|CLUTTER_BACKEND&#61;wayland}}.
  
−
=== SDL ===
+
=== SDL2 ===
 +
 
 +
To run a SDL2 application on Wayland, set {{ic|SDL_VIDEODRIVER&#61;wayland}}.
  
−
Benjamin Franzke is working on a port of SDL to Wayland, it is 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. Scott Moreau picked up where others left and fixed the library to work with 1.0 protocol. You can find his work in [https://github.com/soreau/SDL/tree/wayland wayland branch] of SDL repository.
+
=== GLFW ===
  
−
To run a SDL application on Wayland, set {{ic|SDL_VIDEODRIVER&#61;wayland}}.
+
To use GLFW with the Wayland backend, install the {{Pkg|glfw-wayland}} package (instead of {{Pkg|glfw-x11}}).
  
 
=== EFL ===
 
=== EFL ===
Line 294: Line 289:
 
== Window managers and desktop shells ==
 
== Window managers and desktop shells ==
  
−
=== KDE ===
+
{| class="wikitable sortable"
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| GNOME
 +
| Stacking
 +
| See [[GNOME#Starting GNOME]].
 +
|-
 +
| 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 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
 +
| [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.
 +
|}
  
−
KDE 4.11 beta supports starting [http://blog.martin-graesslin.com/blog/2013/06/starting-a-full-kde-plasma-session-in-wayland/ KWin under Wayland system compositor]. There is currently no support for using KWin as a session compositor.
+
Some of installed wayland desktop clients might store information in {{ic|/usr/share/wayland-sessions/*.desktop}} files about how to start them in wayland.
  
−
=== GNOME ===
+
==Troubleshooting==
−
Since version 3.10, Gnome has experimental Wayland support but you have to install {{AUR|xwayland-git}} and a equivalent patched graphics driver, e.g. {{AUR|xf86-video-intel-xwayland-git}} to get ''Mutter'' to work. For details look into the [https://live.gnome.org/Wayland GNOME wiki].
 
−
{{bc|<nowiki>gnome-session --session=gnome-wayland</nowiki>}}
 
  
−
=== i3 ===
 
  
−
Some developers from i3 have [http://www.i3way.org/ sprouted a completely new project] for implementing a shell plugin for Weston to implement the same features and style of i3.
+
=== Running graphical applications as root ===
  
−
=== Pure Wayland ===
+
Trying to run a graphical application as root via [[su]], [[sudo]] or [[polkit|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:
  
−
{{Warning|Some really quick notes on installing a pure (no X11) Wayland system on Arch Linux. This is from source and installed into {{ic|/usr/local}}. May break your system. You have been warned.}}
+
{{bc|$ sudo gedit
 +
No protocol specified
 +
Unable to init server: Could not connect: Connection refused
  
−
First install a base Arch Linux install with base and base-devel. Do not install xorg or any of its libraries.
+
(gedit:2349): Gtk-WARNING **: cannot open display: :0
 +
}}
  
−
==== Wayland, DRM, Pixman, libxkbcommon ====
+
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 {{ic|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 [https://bugzilla.redhat.com/show_bug.cgi?id=1266771 bug report] and [https://cgit.freedesktop.org/xorg/xserver/commit/?id=c4534a3 the] [https://cgit.freedesktop.org/xorg/xserver/commit/?id=4b4b908 upstream] [https://cgit.freedesktop.org/xorg/xserver/commit/?id=76636ac commits] it refers to).
  
−
$ pacman -S wayland libdrm pixman libxkbcommon
+
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[https://bugzilla.redhat.com/show_bug.cgi?id=1274451#c64]:
 +
  xhost si:localuser:root
  
−
==== Mesa ====
+
To remove this access after the application has been closed:
 +
  xhost -si:localuser:root
  
−
$ sudo pacman -S python2 libxml2 llvm
+
{{Note|1=This [https://bugzilla.gnome.org//show_bug.cgi?id=772875 GNOME bug report] suggests two other workarounds, with one specific to editing text files.}}
−
$ git clone git://anongit.freedesktop.org/mesa/mesa
 
−
$ cd mesa
 
−
$ CFLAGS=-DMESA_EGL_NO_X11_HEADERS ./autogen.sh --prefix=/usr/local --enable-gles2 --disable-gallium-egl --with-egl-platforms=wayland,drm --enable-gbm --enable-shared-glapi --with-gallium-drivers=r300,r600,swrast,nouveau --disable-glx --disable-xlib
 
−
$ make
 
−
$ sudo make install
 
  
−
==== cairo ====
+
{{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.}}
−
 
 
−
Note - no glx/gl or xcb - EGL only.
 
−
 
 
−
$ pacman -S libpng
 
−
$ git clone git://anongit.freedesktop.org/cairo
 
−
$ cd cairo
 
−
$ CFLAGS=-DMESA_EGL_NO_X11_HEADERS ./autogen.sh --prefix=/usr/local/  --disable-xcb  --enable-glesv2
 
−
$ make
 
−
$ sudo make install
 
−
 
 
−
==== weston ====
 
−
$ sudo pacman -S gegl mtdev
 
−
''(choose mesa-gl from options for libgl)''
 
−
$ git clone git://anongit.freedesktop.org/wayland/weston
 
−
$ cd weston/
 
−
$ CFLAGS="-DMESA_EGL_NO_X11_HEADERS" ./autogen.sh --prefix=/usr/local/ --with-cairo-glesv2 --disable-xwayland --disable-x11-compositor --disable-xwayland-test
 
−
$ make
 
−
$ sudo make install
 
−
 
 
−
==Troubleshooting==
 
  
 
=== LLVM assertion failure ===
 
=== LLVM assertion failure ===
Line 354: Line 382:
  
 
  $ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so
 
  $ 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 {{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.
 +
 +
=== nemo ===
 +
(20161229) 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
 +
 +
=== 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)]
 +
 +
=== gnome wayland on tty1, weston on tty2 ===
 +
(20170106) apps started on gnome with WAYLAND_DISPLAY set to westen make it not respond any more ([https://bugs.freedesktop.org/show_bug.cgi?id=99489 wayland issue 99489])
 +
 +
=== weston-terminal ===
 +
(20161229) core dump when started on gnome
 +
 +
=== liteide ===
 +
(20161229) [https://github.com/visualfc/liteide/issues/734 core dump]] on gnome and weston.
 +
 +
=== screen recording ===
 +
(20161229) As of November 2016 there is an ongoing discussion how to implement screen recording. Currently the compositors implement at least basic functionality.
 +
 +
=== remote display ===
 +
(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 (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.
 +
 +
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:
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml XWayland keyboard grabbing protocol], added in [https://lists.freedesktop.org/archives/wayland-devel/2017-July/034459.html wayland-protocols 1.9], there's [https://lists.x.org/archives/xorg-devel/2017-July/054078.html a suggested patch for XWayland] (probably will be included in xorg-server 1.20)
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml Compositor shortcuts inhibit protocol] (native Wayland only), added in [https://lists.freedesktop.org/archives/wayland-devel/2017-July/034459.html wayland-protocols 1.9]
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/relative-pointer/relative-pointer-unstable-v1.xml Relative pointer protocol], added in [https://lists.freedesktop.org/archives/wayland-devel/2016-February/027029.html wayland-protocols 1.1], XWayland support [https://lists.x.org/archives/xorg-devel/2016-September/050975.html already been added] in [https://lists.x.org/archives/xorg-announce/2016-October/002734.html xorg-server 1.19]
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/pointer-constraints/pointer-constraints-unstable-v1.xml Pointer constraints protocol], added in [https://lists.freedesktop.org/archives/wayland-devel/2016-February/027029.html wayland-protocols 1.1], XWayland support [https://lists.x.org/archives/xorg-devel/2016-September/050975.html already been added] in [https://lists.x.org/archives/xorg-announce/2016-October/002734.html xorg-server 1.19]
  
 
== See also ==
 
== See also ==
−
* [[Cursor Themes]]
+
* [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]
−
* [http://www.chaosreigns.com/wiki/Wayland_State Wayland usability wiki]
 

Latest revision as of 09:12, 18 July 2017

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.

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.

Buffer API support

For the GPU driver and Wayland composer 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, Sway, Grefsen

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
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 has the Wayland backend enabled. GTK+ will default to the X11 backend, but this can be overridden by modifying an environment variable: GDK_BACKEND=wayland.

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

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 Stacking See GNOME#Starting GNOME.
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 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 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

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[1]: 

 xhost si:localuser:root

To remove this access after the application has been closed: 

 xhost -si:localuser:root
Note: This GNOME bug report suggests two other workarounds, with one specific to editing text files.

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.

nemo

(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)

weston-terminal

(20161229) core dump when started on gnome

liteide

(20161229) core dump] on gnome and weston.

screen recording

(20161229) As of November 2016 there is an ongoing discussion how to implement screen recording. Currently the compositors implement at least basic functionality.

remote display

(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 (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:

See also

Retrieved from "https://wiki.archlinux.org/index.php?title=Wayland&oldid=482243"