Difference between revisions of "Wayland"
(→XWayland: move introduction to beginning of parent section) |
(wikilink GNOME and KDE) |
||
(265 intermediate revisions by 92 users not shown) | |||
Line 1: | Line 1: | ||
− | [[Category: | + | [[Category:Graphical user interfaces]] |
+ | [[es:Wayland]] | ||
[[fr:Wayland]] | [[fr:Wayland]] | ||
[[ja:Wayland]] | [[ja:Wayland]] | ||
− | [[zh- | + | [[ru:Wayland]] |
− | {{ | + | [[zh-hans:Wayland]] |
− | {{ | + | {{Related articles start}} |
− | + | {{Related|KMS}} | |
− | + | {{Related|Xorg}} | |
− | {{ | + | {{Related articles end}} |
− | {{ | ||
− | |||
− | |||
− | + | [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. Many major Linux desktop environments, like [[GNOME]] and [[KDE]], support Wayland. There is also a compositor reference implementation called "Weston". [https://wayland.freedesktop.org/xserver.html XWayland] implements a compatibility layer to seamlessly run legacy X11 applications on Wayland. | |
== Requirements == | == Requirements == | ||
− | + | Most Wayland compositors only work on systems using [[KMS]]. | |
− | + | Wayland by itself does not provide a graphical environment; for this you also need a compositor such as [[#Weston]] or [[Sway]], or a desktop environment that includes a compositor such as [[GNOME]] or [[KDE]]. | |
− | + | === Buffer API support === | |
− | == | + | For the GPU driver and Wayland compositor to be compatible they must support the same buffer API. There are two main APIs: [[Wikipedia:Generic Buffer Management|GBM]] and [http://www.phoronix.com/scan.php?page=news_item&px=XDC2016-Device-Memory-API EGLStreams]. |
− | + | {| class="wikitable" | |
+ | |- | ||
+ | ! Buffer API !! GPU driver support !! Wayland compositor support | ||
+ | |- | ||
+ | | GBM || All except [[NVIDIA]] || All | ||
+ | |- | ||
+ | | EGLStreams || [[NVIDIA]] || [[GNOME]], [[Grefsen]], [[Sway]] ([https://sircmpwn.github.io/2017/10/26/Fuck-you-nvidia.html will be removed]) | ||
+ | |- | ||
+ | |} | ||
== Weston == | == Weston == | ||
+ | |||
+ | Weston is the reference implementation of a Wayland compositor. | ||
=== Installation === | === Installation === | ||
− | + | Install the {{Pkg|weston}} package. | |
=== Usage === | === Usage === | ||
− | {| style="float:right; | + | {| 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}} |
− | | | + | |Rotate Window ! |
|- | |- | ||
− | |Super + RMB | + | |{{ic|Super+RMB}} |
− | | | + | |Resize Window |
|- | |- | ||
− | |Super + | + | |{{ic|Super+Alt+Scroll}} |
− | | | + | |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. | ||
− | |||
− | |||
− | |||
− | |||
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, | + | Alternatively, to try to launch Weston natively, switch to a terminal and run: |
$ weston-launch | $ weston-launch | ||
Line 91: | Line 100: | ||
To move flowers around the screen: | To move flowers around the screen: | ||
$ weston-flower | $ weston-flower | ||
− | |||
− | |||
− | |||
To display images: | To display images: | ||
$ weston-image image1.jpg image2.jpg... | $ weston-image image1.jpg image2.jpg... | ||
− | + | === Configuration === | |
− | $ | + | Example configuration file for keyboard layout, module selection and UI modifications. See {{man|5|weston.ini}} for full details. The Weston outputs differ slightly from {{ic|xorg.conf}}'s Monitors: |
+ | |||
+ | $ ls /sys/class/drm | ||
+ | card0 | ||
+ | card0-VGA-1 | ||
+ | card1 | ||
+ | card1-DVI-I-1 | ||
+ | card1-HDMI-A-1 | ||
+ | card1-VGA-2 | ||
+ | |||
+ | {{ic|card0}} is the unused built-in video adapter. The add-on adapter {{ic|card1}} is cabled to one HDMI and one DVI monitor, so the output names are {{ic|HDMI-A-1}} and {{ic|DVI-I-1}}. | ||
+ | |||
+ | {{hc|~/.config/weston.ini|<nowiki> | ||
+ | [core] | ||
+ | # xwayland support | ||
+ | xwayland=true | ||
− | + | [libinput] | |
− | + | enable_tap=true | |
− | |||
− | |||
− | |||
− | |||
[shell] | [shell] | ||
Line 114: | Line 131: | ||
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 144: | ||
#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/ | + | 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/ | + | path=/usr/bin/gnome-terminal |
[launcher] | [launcher] | ||
− | icon=/usr/share/icons/hicolor/24x24/apps/ | + | icon=/usr/share/icons/hicolor/24x24/apps/firefox.png |
− | path=/usr/bin/ | + | path=/usr/bin/firefox |
[launcher] | [launcher] | ||
− | icon=/usr/share/ | + | icon=/usr/share/weston/icon_flower.png |
− | path= | + | path=/usr/bin/weston-flower |
[screensaver] | [screensaver] | ||
Line 159: | Line 196: | ||
path=/usr/libexec/weston-screensaver | path=/usr/libexec/weston-screensaver | ||
duration=600 | duration=600 | ||
− | + | </nowiki> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
Minimal {{ic|weston.ini}} : | Minimal {{ic|weston.ini}} : | ||
− | {{hc|~/.config/weston.ini| | + | {{hc|~/.config/weston.ini|<nowiki> |
− | <nowiki>[core] | + | [core] |
− | + | xwayland=true | |
[keyboard] | [keyboard] | ||
keymap_layout=gb | keymap_layout=gb | ||
+ | |||
+ | [output] | ||
+ | name=LVDS1 | ||
+ | mode=1680x1050 | ||
+ | transform=90 | ||
[launcher] | [launcher] | ||
Line 193: | Line 217: | ||
[launcher] | [launcher] | ||
− | icon=/usr/share/icons/hicolor/24x24/apps/ | + | icon=/usr/share/icons/hicolor/24x24/apps/firefox.png |
− | path=/usr/bin/ | + | path=/usr/bin/firefox |
− | + | </nowiki> | |
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
==== XWayland ==== | ==== XWayland ==== | ||
− | + | [[Install]] the {{Pkg|xorg-server-xwayland}} package. | |
− | When you want to run an X application from within Weston, it spins up | + | 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| | {{hc|~/.config/weston.ini| | ||
<nowiki>[core] | <nowiki>[core] | ||
− | modules=xwayland | + | modules=xwayland.so</nowiki> |
}} | }} | ||
− | + | {{Note| if X is not already configured you may need to configure a keymap: [[Keyboard configuration in Xorg]]}} | |
− | + | ==== Screencast recording ==== | |
+ | Weston has build-in screencast recording which can be started and stopped by pressing the {{ic|Super+r}} key combination. Screencasts are saved to the file {{ic|capture.wcap}} in the current working directory of Weston. | ||
− | + | The WCAP format is a lossless video format specific to Weston, which only records the difference in frames. To be able to play the recorded screencast, the WCAP file will need to be converted to a format which a media player can understand. First, convert the capture to the YUV pixel format: | |
− | + | $ wcap-decode capture.wcap --yuv4mpeg2 > capture.y4m | |
− | |||
− | + | The YUV file can then be transcoded to other formats using [[FFmpeg]]. | |
− | |||
− | + | ==== High DPI displays ==== | |
− | + | For [[wikipedia:Retina_Display|Retina]] or [[HiDPI]] displays, use: | |
− | {{ | + | {{hc|~/.config/weston.ini| |
− | + | <nowiki>[output] | |
− | + | name=... | |
− | + | scale=2</nowiki> | |
− | + | }} | |
− | |||
− | |||
− | < | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | </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 == | ||
− | + | See details on the [http://wayland.freedesktop.org/toolkits.html official website]. | |
− | === GTK+ === | + | === GTK+ 3 === |
− | + | The {{Pkg|gtk3}} package has the Wayland backend enabled. GTK+ will default to the Wayland backend, but it is possible to override it to Xwayland by modifying an environment variable: {{ic|GDK_BACKEND=x11}}. | |
− | + | === Qt 5 === | |
+ | To enable Wayland support in Qt 5, install the {{Pkg|qt5-wayland}} package. | ||
− | + | To run a Qt 5 app with the Wayland plugin, use {{ic|1=-platform wayland}} or set the {{ic|1=QT_QPA_PLATFORM=wayland-egl}} [[environment variable]]. | |
− | === | + | === Clutter === |
− | + | The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is enabled in the {{Pkg|clutter}} package. | |
− | To run a | + | To run a Clutter app on Wayland, set {{ic|CLUTTER_BACKEND=wayland}}. |
− | === | + | === SDL2 === |
− | + | To run a SDL2 application on Wayland, set {{ic|SDL_VIDEODRIVER=wayland}}. | |
− | + | === GLFW === | |
− | + | To use GLFW with the Wayland backend, install the {{Pkg|glfw-wayland}} package (instead of {{Pkg|glfw-x11}}). | |
− | + | === GLEW === | |
− | To | + | To use GLEW with the Wayland backend, install the {{Pkg|glew-wayland}} package (instead of {{Pkg|glew}}). |
=== EFL === | === EFL === | ||
Line 292: | Line 293: | ||
To run a EFL application on Wayland, see Wayland [http://wayland.freedesktop.org/efl.html project page]. | To run a EFL application on Wayland, see Wayland [http://wayland.freedesktop.org/efl.html project page]. | ||
− | == | + | == Compositors == |
− | = | + | {| 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 an abandonned tiling WM for Wayland. | ||
+ | |- | ||
+ | | Velox | ||
+ | | Tiling | ||
+ | | [[Velox]] is a simple window manager based on swc. It is inspired by [[dwm]] and [[xmonad]]. | ||
+ | |- | ||
+ | | Orbital | ||
+ | | Stacking | ||
+ | | [https://github.com/giucam/orbital Orbital] is a Wayland compositor and shell, using Qt5 and Weston. The goal of the project is to build a simple yet flexible and good looking Wayland desktop. It is not a full fledged DE but rather the analogue of a WM in the X11 world, such as [[Awesome]] or [[Fluxbox]]. | ||
+ | |- | ||
+ | | Liri Shell | ||
+ | | Stacking | ||
+ | | [https://github.com/lirios/shell Liri Shell] is the desktop shell for [[Liri]], built using QtQuick and QtCompositor as a compositor for Wayland. | ||
+ | |- | ||
+ | | Maynard | ||
+ | | ''(Unclear)'' | ||
+ | | [https://github.com/raspberrypi/maynard Maynard] is a desktop shell client for Weston based on GTK. It was based on weston-gtk-shell, a project by Tiago Vignatti. | ||
+ | |- | ||
+ | | Motorcar | ||
+ | | ''(Unclear)'' | ||
+ | | [https://github.com/evil0sheep/motorcar Motorcar] is a Wayland compositor to explore 3D windowing using virtual reality. | ||
+ | |- | ||
+ | | Way Cooler | ||
+ | | Tiling | ||
+ | | {{AUR|way-cooler}} is a customizable (Lua config files) Wayland compositor written in Rust. Inspired by i3 and awesome. | ||
+ | |- | ||
+ | | Maze Compositor | ||
+ | | Floating 3D | ||
+ | | [https://github.com/capisce/mazecompositor Maze Compositor] is a 3D Qt based Wayland compositor | ||
+ | |- | ||
+ | | Grefsen | ||
+ | | Floating | ||
+ | | [https://github.com/ec1oud/grefsen Grefsen] is a Qt/Wayland compositor providing a minimal desktop environment. | ||
+ | |} | ||
− | + | 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== |
− | |||
− | |||
− | |||
− | + | === Running graphical applications as root === | |
− | + | 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: | |
− | {{ | + | {{bc|$ 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 {{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). | |
− | + | 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 | ||
− | + | To remove this access after the application has been closed: | |
+ | xhost -si:localuser:root | ||
− | + | {{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.}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | {{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.}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
=== LLVM assertion failure === | === LLVM assertion failure === | ||
Line 354: | Line 388: | ||
$ 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 === | ||
+ | Currently only {{AUR|green-recorder}} supports screen recording on Wayland (requires a GNOME session). | ||
+ | |||
+ | === remote display === | ||
+ | (20180401) mutter has now remote desktop enabled at compile time, see https://wiki.gnome.org/Projects/Mutter/RemoteDesktop and https://aur.archlinux.org/packages/gnome-remote-desktop/ for details. | ||
+ | (20161229) there was a merge of FreeRDP into weston in 2013, enabled via compile time switch. The arch linux weston package currently has it not enabled. | ||
+ | |||
+ | === Input grabbing in games, remote desktop and VM windows === | ||
+ | |||
+ | In contrast to Xorg, Wayland does not allow exclusive input device grabbing, also known as active or explicit grab (e.g. [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 the Wayland compositors. In the case of native Wayland clients, the used widget toolkits (e.g GTK, QT) needs to support these extensions or the applications themselves if no widget toolkit is being used. In the case of Xorg applications, no changes in the applications or widget toolkits are needed as the XWayland support is enough. | ||
+ | |||
+ | These extensions are already included in the latest stable release of {{pkg|wayland-protocols}}, and supported by the latest release candidate of {{pkg|xorg-server-xwayland}} 1.20. | ||
+ | |||
+ | The related extensions are: | ||
+ | * [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml XWayland keyboard grabbing protocol] | ||
+ | * [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml Compositor shortcuts inhibit protocol] | ||
+ | * [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/relative-pointer/relative-pointer-unstable-v1.xml Relative pointer protocol] | ||
+ | * [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/pointer-constraints/pointer-constraints-unstable-v1.xml Pointer constraints protocol] | ||
+ | |||
+ | Supporting Wayland compositors: | ||
+ | * Mutter, [[GNOME|GNOME's]] compositor [https://bugzilla.gnome.org/show_bug.cgi?id=783342 since release 3.28]. | ||
+ | |||
+ | Supporting widget toolkits: | ||
+ | * GTK since release 3.22.18. | ||
== See also == | == See also == | ||
− | * [[Cursor | + | * [https://fedoraproject.org/wiki/How_to_debug_Wayland_problems Article about Wayland debugging on Fedora Wiki] |
+ | * [[Cursor themes]] | ||
* [https://bbs.archlinux.org/viewtopic.php?id=107499 Arch Linux forum discussion] | * [https://bbs.archlinux.org/viewtopic.php?id=107499 Arch Linux forum discussion] | ||
* [http://wayland.freedesktop.org/docs/html/ Wayland documentation online] | * [http://wayland.freedesktop.org/docs/html/ Wayland documentation online] | ||
− |
Latest revision as of 15:17, 12 April 2018
Wayland is a protocol for a compositor to talk to its clients, as well as a library implementing this protocol. Many major Linux desktop environments, like GNOME and KDE, support Wayland. There is also a compositor reference implementation called "Weston". XWayland implements a compatibility layer to seamlessly run legacy X11 applications on Wayland.
Contents
- 1 Requirements
- 2 Weston
- 3 GUI libraries
- 4 Compositors
- 5 Troubleshooting
- 5.1 Running graphical applications as root
- 5.2 LLVM assertion failure
- 5.3 Slow motion, graphical glitches, and crashes
- 5.4 nemo
- 5.5 X11 on tty1, wayland on tty2
- 5.6 gnome wayland on tty1, weston on tty2
- 5.7 weston-terminal
- 5.8 liteide
- 5.9 screen recording
- 5.10 remote display
- 5.11 Input grabbing in games, remote desktop and VM windows
- 6 See also
Requirements
Most Wayland compositors only work on systems using KMS.
Wayland by itself does not provide a graphical environment; for this you also need a compositor such as #Weston or Sway, or a desktop environment that includes a compositor such as GNOME or KDE.
Buffer API support
For the GPU driver and Wayland compositor to be compatible they must support the same buffer API. There are two main APIs: GBM and EGLStreams.
Buffer API | GPU driver support | Wayland compositor support |
---|---|---|
GBM | All except NVIDIA | All |
EGLStreams | NVIDIA | GNOME, Grefsen, Sway (will be removed) |
Weston
Weston is the reference implementation of a Wayland compositor.
Installation
Install the weston package.
Usage
Cmd | Action |
---|---|
Ctrl+Alt+Backspace
|
Quit Weston |
Super+Scroll (or PageUp /PageDown )
|
Zoom in/out of desktop |
Super+Tab
|
Switch windows |
Super+LMB
|
Move Window |
Super+MMB
|
Rotate Window ! |
Super+RMB
|
Resize Window |
Super+Alt+Scroll
|
Change window opacity |
Super+K
|
Force Kill Active Window |
Super+KeyUp/KeyDown
|
Switch Prev/Next Workspace |
Super+Shift+KeyUp/KeyDown
|
Grab Current Window and Switch Workspace |
Super+Fn
|
Switch to Workspace n |
Super+S
|
Take a screenshot |
Super+R
|
Record a screencast. |
Now that Wayland and its requirements are installed you should be ready to test it out.
It is possible to run Weston inside a running X session:
$ weston
Alternatively, to try to launch Weston natively, switch to a terminal and run:
$ weston-launch
Then at a TTY within Weston, you can run the demos. To launch a terminal emulator:
$ weston-terminal
To move flowers around the screen:
$ weston-flower
To display images:
$ weston-image image1.jpg image2.jpg...
Configuration
Example configuration file for keyboard layout, module selection and UI modifications. See weston.ini(5) for full details. The Weston outputs differ slightly from xorg.conf
's Monitors:
$ ls /sys/class/drm card0 card0-VGA-1 card1 card1-DVI-I-1 card1-HDMI-A-1 card1-VGA-2
card0
is the unused built-in video adapter. The add-on adapter card1
is cabled to one HDMI and one DVI monitor, so the output names are HDMI-A-1
and DVI-I-1
.
~/.config/weston.ini
[core] # xwayland support xwayland=true [libinput] enable_tap=true [shell] background-image=/usr/share/backgrounds/gnome/Aqua.jpg background-color=0xff002244 panel-color=0x90ff0000 locking=true animation=zoom close-animation=fade focus-animation=dim-layer #binding-modifier=ctrl #num-workspaces=6 ### for cursor themes install xcursor-themes pkg from Extra. ### #cursor-theme=whiteglass #cursor-size=24 ### tablet options ### #lockscreen-icon=/usr/share/icons/gnome/256x256/actions/lock.png #lockscreen=/usr/share/backgrounds/gnome/Garden.jpg #homescreen=/usr/share/backgrounds/gnome/Blinds.jpg #animation=fade ### for Laptop displays ### #[output] #name=LVDS1 #mode=1680x1050 #transform=90 #[output] #name=VGA1 # The following sets the mode with a modeline, you can get modelines for your preffered resolutions using the cvt utility #mode=173.00 1920 2048 2248 2576 1080 1083 1088 1120 -hsync +vsync #transform=flipped #[output] #name=X1 #mode=1024x768 #transform=flipped-270 [input-method] #path=/usr/lib/weston/weston-keyboard [keyboard] keymap_rules=evdev #keymap_layout=gb,de #keymap_options=caps:ctrl_modifier,shift:both_capslock_cancel ### keymap_options from /usr/share/X11/xkb/rules/base.lst ### numlock-on=true [terminal] #font=DroidSansMono #font-size=14 [launcher] icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png path=/usr/bin/weston-terminal [launcher] icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png path=/usr/bin/gnome-terminal [launcher] icon=/usr/share/icons/hicolor/24x24/apps/firefox.png path=/usr/bin/firefox [launcher] icon=/usr/share/weston/icon_flower.png path=/usr/bin/weston-flower [screensaver] # Uncomment path to disable screensaver path=/usr/libexec/weston-screensaver duration=600
Minimal weston.ini
:
~/.config/weston.ini
[core] xwayland=true [keyboard] keymap_layout=gb [output] name=LVDS1 mode=1680x1050 transform=90 [launcher] icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png path=/usr/bin/weston-terminal [launcher] icon=/usr/share/icons/hicolor/24x24/apps/firefox.png path=/usr/bin/firefox
XWayland
Install the xorg-server-xwayland package.
When you want to run an X application from within Weston, it spins up Xwayland to service the request. The following configuration is shown above:
~/.config/weston.ini
[core] modules=xwayland.so
Screencast recording
Weston has build-in screencast recording which can be started and stopped by pressing the Super+r
key combination. Screencasts are saved to the file capture.wcap
in the current working directory of Weston.
The WCAP format is a lossless video format specific to Weston, which only records the difference in frames. To be able to play the recorded screencast, the WCAP file will need to be converted to a format which a media player can understand. First, convert the capture to the YUV pixel format:
$ wcap-decode capture.wcap --yuv4mpeg2 > capture.y4m
The YUV file can then be transcoded to other formats using FFmpeg.
High DPI displays
For Retina or HiDPI displays, use:
~/.config/weston.ini
[output] name=... scale=2
Shell font
Weston uses the default sans-serif font for window title bars, clocks, etc. See Font configuration#Replace or set default fonts for instructions on how to change this font.
GUI libraries
See details on the official website.
GTK+ 3
The gtk3 package has the Wayland backend enabled. GTK+ will default to the Wayland backend, but it is possible to override it to Xwayland by modifying an environment variable: GDK_BACKEND=x11
.
Qt 5
To enable Wayland support in Qt 5, install the qt5-wayland package.
To run a Qt 5 app with the Wayland plugin, use -platform wayland
or set the QT_QPA_PLATFORM=wayland-egl
environment variable.
Clutter
The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is enabled in the clutter package.
To run a Clutter app on Wayland, set CLUTTER_BACKEND=wayland
.
SDL2
To run a SDL2 application on Wayland, set SDL_VIDEODRIVER=wayland
.
GLFW
To use GLFW with the Wayland backend, install the glfw-wayland package (instead of glfw-x11).
GLEW
To use GLEW with the Wayland backend, install the glew-wayland package (instead of glew).
EFL
EFL has complete Wayland support. To run a EFL application on Wayland, see Wayland project page.
Compositors
Name | Type | Description |
---|---|---|
GNOME | Stacking | See GNOME#Starting 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 an abandonned tiling WM for Wayland. |
Velox | Tiling | Velox is a simple window manager based on swc. It is inspired by dwm and xmonad. |
Orbital | Stacking | Orbital is a Wayland compositor and shell, using Qt5 and Weston. The goal of the project is to build a simple yet flexible and good looking Wayland desktop. It is not a full fledged DE but rather the analogue of a WM in the X11 world, such as Awesome or Fluxbox. |
Liri Shell | Stacking | Liri Shell is the desktop shell for Liri, built using QtQuick and QtCompositor as a compositor for Wayland. |
Maynard | (Unclear) | Maynard is a desktop shell client for Weston based on GTK. It was based on weston-gtk-shell, a project by Tiago Vignatti. |
Motorcar | (Unclear) | Motorcar is a Wayland compositor to explore 3D windowing using virtual reality. |
Way Cooler | Tiling | way-coolerAUR is a customizable (Lua config files) Wayland compositor written in Rust. Inspired by i3 and awesome. |
Maze Compositor | Floating 3D | Maze Compositor is a 3D Qt based Wayland compositor |
Grefsen | Floating | Grefsen is a Qt/Wayland compositor providing a minimal desktop environment. |
Some of installed wayland desktop clients might store information in /usr/share/wayland-sessions/*.desktop
files about how to start them in wayland.
Troubleshooting
Running graphical applications as root
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
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
Currently only green-recorderAUR supports screen recording on Wayland (requires a GNOME session).
remote display
(20180401) mutter has now remote desktop enabled at compile time, see https://wiki.gnome.org/Projects/Mutter/RemoteDesktop and https://aur.archlinux.org/packages/gnome-remote-desktop/ for details. (20161229) there was a merge of FreeRDP into weston in 2013, enabled via compile time switch. The arch linux weston package currently has it not enabled.
Input grabbing in games, remote desktop and VM windows
In contrast to Xorg, Wayland does not allow exclusive input device grabbing, also known as active or explicit grab (e.g. keyboard, mouse), instead, it depends on the Wayland compositor to pass keyboard shortcuts and confine the pointer device to the application window.
This change in input grabbing breaks current applications' behavior, meaning:
- Hotkey combinations and modifiers will be caught by the compositor and won't be sent to remote desktop and virtual machine windows.
- The mouse pointer will not be restricted to the application's window which might cause a parallax effect where the location of the mouse pointer inside the window of the virtual machine or remote desktop is displaced from the host's mouse pointer.
Wayland solves this by adding protocol extensions for Wayland and XWayland. Support for these extensions is needed to be added to the Wayland compositors. In the case of native Wayland clients, the used widget toolkits (e.g GTK, QT) needs to support these extensions or the applications themselves if no widget toolkit is being used. In the case of Xorg applications, no changes in the applications or widget toolkits are needed as the XWayland support is enough.
These extensions are already included in the latest stable release of wayland-protocols, and supported by the latest release candidate of xorg-server-xwayland 1.20.
The related extensions are:
- XWayland keyboard grabbing protocol
- Compositor shortcuts inhibit protocol
- Relative pointer protocol
- Pointer constraints protocol
Supporting Wayland compositors:
- Mutter, GNOME's compositor since release 3.28.
Supporting widget toolkits:
- GTK since release 3.22.18.