Go to file
Emmanuel Gil Peyrot 3feed6e723 doc: Document libwayland-cursor with autotools
Signed-off-by: Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
2020-06-05 11:05:20 +00:00
cursor cursor: Properly document wl_cursor_image and wl_cursor 2020-06-05 11:05:20 +00:00
doc doc: Document libwayland-cursor with autotools 2020-06-05 11:05:20 +00:00
egl Add Meson build 2020-01-10 23:44:38 +01:00
m4 configure: detect libdl and librt 2019-04-06 19:53:25 +00:00
protocol protocol: add seat missing_capability error 2020-06-05 09:36:39 +00:00
src scanner: Guard interface declarations 2020-04-23 10:17:18 +02:00
tests Replace initial 8 spaces with a tab for all xml files 2020-04-29 12:21:33 +00:00
.editorconfig editorconfig: add settings for the .gitlab-ci.yml file 2020-06-05 08:22:34 +10:00
.gitignore .gitignore: add wayland-egl-abi-check 2018-04-02 11:01:33 -05:00
.gitlab-ci.yml gitlab CI: update to use the fdo ci templates 2020-06-05 09:33:31 +10:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac doc/man: remove manually written man pages 2020-04-16 19:53:28 +02:00
CONTRIBUTING.md contributing: use Gitlab merge request workflow 2019-03-07 14:35:22 +02:00
COPYING COPYING: Update to MIT Expat License rather than MIT X License 2015-06-12 15:31:21 -07:00
Makefile.am doc/man: remove manually written man pages 2020-04-16 19:53:28 +02:00
meson_options.txt meson: Add option to control building wayland-scanner 2020-03-13 10:25:24 -07:00
meson.build meson: Raise requirement to meson >= 0.52.1 2020-03-18 13:36:44 -07:00
publish-doc publish-doc: Add script for publishing docs to the website 2015-05-27 15:34:20 -07:00
README README with upadated compile instructions 2020-04-07 10:55:19 -07:00
releasing.txt releasing: fixup section numbers 2019-04-12 11:31:06 +03:00
TODO TODO: remove "SDL port", it's been done by now 2019-02-05 15:04:03 +02:00
wayland-scanner.m4 build: check wayland-scanner version 2020-01-16 17:25:06 +01:00
wayland-scanner.mk Pass input/output files as arguments to wayland-scanner 2017-08-18 15:20:24 +03:00

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.