aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorManuel Stoeckl <code@mstoeckl.com>2021-03-02 22:04:58 -0500
committerSimon Ser <contact@emersion.fr>2025-06-08 16:20:35 +0000
commit4a0c4e211949bd58fa7e6105487b8dac0d4cfd1c (patch)
tree326eaa0a422aa65f7722c4c68cd8eb6a790408a7 /doc
parentserver: Document wl_display_add_socket_auto (diff)
downloadwayland-4a0c4e211949bd58fa7e6105487b8dac0d4cfd1c.tar
wayland-4a0c4e211949bd58fa7e6105487b8dac0d4cfd1c.tar.gz
wayland-4a0c4e211949bd58fa7e6105487b8dac0d4cfd1c.tar.bz2
wayland-4a0c4e211949bd58fa7e6105487b8dac0d4cfd1c.tar.lz
wayland-4a0c4e211949bd58fa7e6105487b8dac0d4cfd1c.tar.xz
wayland-4a0c4e211949bd58fa7e6105487b8dac0d4cfd1c.tar.zst
wayland-4a0c4e211949bd58fa7e6105487b8dac0d4cfd1c.zip
doc: Further explain typical display socket lookup
This change mentions the case where WAYLAND_SOCKET is used, which helps people avoid just testing 'getenv(WAYLAND_DISPLAY)' to see if a Wayland compositor is available; Signed-off-by: Manuel Stoeckl <code@mstoeckl.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/publican/sources/Protocol.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/publican/sources/Protocol.xml b/doc/publican/sources/Protocol.xml
index 692f17e..e4087e9 100644
--- a/doc/publican/sources/Protocol.xml
+++ b/doc/publican/sources/Protocol.xml
@@ -97,7 +97,9 @@
in the environment). Beginning in Wayland 1.15, implementations can
optionally support server socket endpoints located at arbitrary
locations in the filesystem by setting <emphasis>WAYLAND_DISPLAY</emphasis>
- to the absolute path at which the server endpoint listens.
+ to the absolute path at which the server endpoint listens. The socket may
+ also be provided through file descriptor inheritance, in which case
+ <emphasis>WAYLAND_SOCKET</emphasis> is set.
</para>
<para>
Every message is structured as 32-bit words; values are represented in the