This page describes Wayland-specific debugging tools.
Compositor features
Running wayland-info will list all global interfaces advertized
by the compositor. It will also tell additional information about the
interfaces it knows about and have something to report, like monitor make
and model, wl_seat capabilities, and wl_shm pixel formats. wayland-info
comes with wayland-utils,
and works on any compositor.
OpenGL features
OpenGL (all flavours) features under Wayland can be queried with
wflinfo
provided by Waffle.
Just use -p wayland argument.
Protocol dumpers
When using export WAYLAND_DEBUG=1 (or WAYLAND_DEBUG=client
or WAYLAND_DEBUG=server)
is not enough,
the following tools may help.
- wayland-tracker
A Wayland protocol dumper, MIT licensed, written in Haskell, produces binary,
text, and JSON formatted output. Runs as a middle-man for a single client.
- wayland-tracer
A Wayland protocol dumper, MIT licensed, written in C, produces binary and
human readable output. Can run as a middle-man for a single client, or
act as a middle-man Wayland server.
- wlanalyzer / wldump
A Wayland protocol dumper, MIT licensed, written in C++, produces human
readable output. Runs as a middle-man for a single client.
- wldbg
A Wayland connection processor, MIT licensed, written in C. Runs given functions
on messages passed between server and clients or works in gdb-like mode. Can listen
for new connections to a compositor and take over them.
Runs as a middle-man for single/multiple clients.
Introspection tools
- GammaRay
A software introspection tool for Qt applications, including a module for QtWayland
compositors. Leveraging the libwayland-server introspection API and the QtWayland API
it allows to look at the list of clients currently connected, their resources and relevant
information based on the type of the resource, and the protocol flow between the client(s)
and the compositor.
- wlhax
A terminal UI application that acts like a Wayland proxy. It monitors and
displays the Wayland connection state such as the current surface tree.
