Go to file
Bill Spitzak dd534a1fde doc: removed some unnecessary nested listing from doxygen output
This makes the lists of parameters slightly smaller and removes some
bullets from see-also and since.
2014-11-25 16:25:22 +02:00
cursor Add error handling for wl_cursors 2014-04-01 16:47:04 -07:00
doc doc: removed some unnecessary nested listing from doxygen output 2014-11-25 16:25:22 +02:00
m4 Clean up .gitignore files 2010-11-11 20:11:27 -05:00
protocol Protocol : Added destructor to wl_data_device interface 2014-11-04 15:04:29 +02:00
spec doc: move documentation from the tex file to docbook 2012-03-28 23:04:25 -04:00
src server: increase listen queue to 128 2014-11-24 16:32:35 +02:00
tests client: read_events should return -1 after an error 2014-11-21 13:59:42 +02:00
.gitignore gitignore: adpat to scanner and protocol path changes 2014-11-19 16:35:49 +02:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac doc: replace publican with xmlto 2014-09-22 10:30:41 +03:00
COPYING Add COPYING 2012-04-25 10:12:21 -04:00
Makefile.am tests: add test-compositor 2014-08-22 12:34:33 +03:00
README README: Tiny cosmetic change 2014-10-08 12:20:17 +01:00
TODO Update TODO 2012-10-21 20:53:37 -04:00
wayland-scanner.m4 scanner: check for wayland-scanner.pc before using variables 2013-08-07 16:25:10 -07:00
wayland-scanner.mk Split into a core repository that only holds the core Wayland libraries 2011-02-14 22:21:13 -05: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 git://anongit.freedesktop.org/wayland/wayland
    $ cd wayland
    $ ./autogen.sh --prefix=PREFIX
    $ make
    $ make install

where PREFIX is where you want to install the libraries.  See
http://wayland.freedesktop.org for more complete build instructions
for wayland, weston, xwayland and various toolkits.