From 24ca1a5b578a63b731127c115f2cc6ea50c25686 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Thu, 16 Apr 2020 19:49:12 +0200 Subject: [PATCH] client: improve wl_display_connect docs Add a paragraph about WAYLAND_SOCKET and describe what happens when the display name is a relative path. Signed-off-by: Simon Ser --- src/wayland-client.c | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/wayland-client.c b/src/wayland-client.c index 5358500..21d4606 100644 --- a/src/wayland-client.c +++ b/src/wayland-client.c @@ -1113,6 +1113,13 @@ wl_display_connect_to_fd(int fd) * its value will be replaced with the WAYLAND_DISPLAY environment * variable if it is set, otherwise display "wayland-0" will be used. * + * If WAYLAND_SOCKET is set, it's interpreted as a file descriptor number + * referring to an already opened socket. In this case, the socket is used + * as-is and \c name is ignored. + * + * If \c name is a relative path, then the socket is opened relative to + * the XDG_RUNTIME_DIR directory. + * * If \c name is an absolute path, then that path is used as-is for * the location of the socket at which the Wayland server is listening; * no qualification inside XDG_RUNTIME_DIR is attempted. -- 2.7.4