Wayland is a new windowing protocol for Linux. Utilization of Wayland requires changes to and re-installation of parts of your system's software. For more information on Wayland see its homepage.
- 1 Requirements
- 2 Installation
- 3 Usage
- 4 Weston
- 5 GUI libraries
- 6 Window managers and desktop shells
- 7 Troubleshooting
- 8 See also
Currently Wayland will only work on systems utilizing KMS.
Wayland is most probably installed on your system already as it is an indirect dependency of official repositories.and . If it is not installed, you will find the package in the
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.
You need to installfrom the official repositories.
|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||Resize Window|
|Super + RMB||Rotate Window !|
|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:
Alternatively, to launch Weston natively, try switching to a terminal and running:
Then at a TTY within Weston, you can run the demos. To launch a terminal emulator:
To move flowers around the screen:
To test the frame protocol (runs
To display images:
$ weston-image image1.jpg image2.jpg...
To display PDF Files:
$ weston-view doc1.pdf doc2.pdf...
Example configuration file for keyboard layout, module selection and UI modifications. See
man weston.ini for full details:
[core] ### uncomment this line for xwayland support ### #modules=desktop-shell.so,xwayland.so [shell] background-image=/usr/share/backgrounds/gnome/Aqua.jpg background-color=0xff002244 panel-color=0x90ff0000 locking=true animation=zoom #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 [keyboard] keymap_rules=evdev #keymap_layout=gb #keymap_options=caps:ctrl_modifier,shift:both_capslock_cancel ### keymap_options from /usr/share/X11/xkb/rules/base.lst ### [terminal] #font=DroidSansMono #font-size=14 [launcher] icon=/usr/share/icons/gnome/24x24/apps/utilities-terminal.png path=/usr/bin/gnome-terminal [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 [launcher] icon=/usr/share/icons/gnome/24x24/apps/arts.png path=./clients/flower [screensaver] # Uncomment path to disable screensaver path=/usr/libexec/weston-screensaver duration=600 [input-method] path=/usr/libexec/weston-keyboard ### 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
[core] modules=desktop-shell.so,xwayland.so [keyboard] keymap_layout=gb [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 [output] name=LVDS1 mode=1680x1050 transform=90
You can find an officialpackage in extra.
When you want to run an X application from within Weston, it spins up Xwayland to service the request.
If you plan to run native X-applications inside Wayland, create or modify following configuration file:
Now you can also run X applications in weston.
If you want to run GNOME 3.12 on wayland, some hack is needed you may and refer to this guide.
(See details on the official website)
You need to installfrom 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:
You need to either
rebuild (currently not working, see with -opengl es2http://lists.qt-project.org/pipermail/development/2013-December/014789.html ) or use AUR. Then build the wayland plugin AUR.
To run a Qt5 app with the Wayland plugin, set the
QT_QPA_PLATFORM=wayland-egl environment variable.
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
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
Version 3.1 will have wayland support through a compile flag that you have to enable. In the mean time you can install the package from the AUR
-DGLFW_USE_WAYLAND=ON to the cmake flags
EFL has complete Wayland support. To run a EFL application on Wayland, see Wayland project page.
Window managers and desktop shells
KDE 4.11 beta supports starting KWin under Wayland system compositor. There is currently no support for using KWin as a session compositor.
With version 3.12 Gnome has experimental Wayland support but you have to install. You also have to install a mutter-wayland snapshot that makes use of the new Xwayland DDX. Use these two files to rebuild the package with makepkg.
With any open source driver you can now start "Gnome on Wayland" from GDM as a special session.
Some developers from i3 are thinking of starting a completely new project for implementing a shell plugin for Weston to implement the same features and style of i3.
First install a base Arch Linux install with base and base-devel. Do not install xorg or any of its libraries.
Wayland, DRM, Pixman, libxkbcommon
$ pacman -S wayland libdrm pixman libxkbcommon
$ sudo pacman -S python2 libxml2 llvm $ 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
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
$ 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
LLVM assertion failure
If you get an LLVM assertion failure, you need to rebuildwithout 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