Core Wayland window system code and protocol
Find a file
Pekka Paalanen 147617800d doc: start documenting Xwayland
This is a rough intro to what Xwayland is and does, with just one
implementation detail so far (Window identification).

I paid no attention to formatting details, those can be polished in
follow-ups. I just want the prose out.

I also just quickly whacked up the diagram, would be happy to see
someone replace it with a nicer one. I just didn't have time to learn
dot for now.

v2:
- typo fix
- rephrase "talking to hardware" as "driving the displays"
- mention circular dependency in intro
- add section to explain rootless and rootful modes
- remove paragraph about Xwayland protocol usage
- move TBD part to the end under a new section header

v3:
- use "advantage" and "disadvantage" instead of "pro" and "con"
- slight rewording on rootful mode and rootless mode paragraphs
- removed the paragraph about the lack of shell and special Wayland
  protocol extensions
- removed the commented out list of ideas to write

v4:
- typo fixes pointed out by Yong

Cc: Olivier Fourdan <ofourdan@redhat.com>
Cc: Jonas Ådahl <jadahl@gmail.com>
Cc: Daniel Stone <daniel@fooishbar.org>
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
2017-12-18 12:05:03 +02:00
cursor cursor: add forward declaration for struct wl_buffer 2017-12-04 19:45:38 +00:00
doc doc: start documenting Xwayland 2017-12-18 12:05:03 +02:00
m4 Clean up .gitignore files 2010-11-11 20:11:27 -05:00
protocol protocol: make get_subsurface double-buffered 2017-12-05 10:43:17 +00:00
spec doc: move documentation from the tex file to docbook 2012-03-28 23:04:25 -04:00
src client: Allow absolute paths in WAYLAND_DISPLAY 2017-12-11 10:03:59 +02:00
tests client: Allow absolute paths in WAYLAND_DISPLAY 2017-12-11 10:03:59 +02:00
.gitignore tests: add scanner tests 2016-11-23 10:18:44 +02:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac Reopen master for regular development 2017-08-08 12:03:27 -07:00
COPYING COPYING: Update to MIT Expat License rather than MIT X License 2015-06-12 15:31:21 -07:00
Makefile.am build: remove wayland-version.h.in from EXTRA_DIST 2017-09-18 12:21:55 +03:00
publish-doc publish-doc: Add script for publishing docs to the website 2015-05-27 15:34:20 -07: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 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 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.