mirror of
https://gitlab.freedesktop.org/wayland/wayland.git
synced 2026-05-02 06:46:26 -04:00
Core Wayland window system code and protocol
Connecting by default to wayland-0 when environment variables WAYLAND_DISPLAY/WAYLAND_SOCKET are not set can cause unexpected connections when more than one session is being used. Specifically, if you run a program from a non-Wayland context (over ssh, on a VT, in an X11 session, from a job scheduler), while some unrelated compositor is listening on wayland-0, the program may connect to the compositor and leave the user wondering what has happened. This commit adjusts the documentation to clarify that the wayland-0 fallback is kept "for compatibility reasons", implying that in typical use programs do not rely on it. The changes to the wayland-server documentation (+ publican docs) briefly explain why compositors should avoid providing wayland-0. To avoid breaking existing software, the fallback to wayland-0 has not been removed (and perhaps never will be). As part of this change, the wl_display_add_socket_auto function has been documented to describe its action as well as the recommended alternative of connecting to the first available socket in the sequence wayland-1, wayland-2, etc. Signed-off-by: Manuel Stoeckl <code@mstoeckl.com> |
||
|---|---|---|
| .gitlab/issue_templates | ||
| cursor | ||
| doc | ||
| egl | ||
| m4 | ||
| protocol | ||
| src | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| autogen.sh | ||
| configure.ac | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| Makefile.am | ||
| meson.build | ||
| meson_options.txt | ||
| publish-doc | ||
| README | ||
| releasing.txt | ||
| wayland-scanner.m4 | ||
| wayland-scanner.mk | ||
What is Wayland?
Wayland is a project to define a protocol for a compositor to talk to
its clients as well as a library implementation of the protocol. The
compositor can be a standalone display server running on Linux kernel
modesetting and evdev input devices, an X application, or a wayland
client itself. The clients can be traditional applications, X servers
(rootless or fullscreen) or other display servers.
The wayland protocol is essentially only about input handling and
buffer management. The compositor receives input events and forwards
them to the relevant client. The clients creates buffers and renders
into them and notifies the compositor when it needs to redraw. The
protocol also handles drag and drop, selections, window management and
other interactions that must go through the compositor. However, the
protocol does not handle rendering, which is one of the features that
makes wayland so simple. All clients are expected to handle rendering
themselves, typically through cairo or OpenGL.
The weston compositor is a reference implementation of a wayland
compositor and the weston repository also includes a few example
clients.
Building the wayland libraries is fairly simple, aside from libffi,
they don't have many dependencies:
$ git clone https://gitlab.freedesktop.org/wayland/wayland
$ cd wayland
$ meson build/ --prefix=PREFIX
$ ninja -C build/ install
where PREFIX is where you want to install the libraries. See
https://wayland.freedesktop.org for more complete build instructions
for wayland, weston, xwayland and various toolkits.