mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-04-09 08:21:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

client: improve wl_display_connect docs

Browse source 
Add a paragraph about WAYLAND_SOCKET and describe what happens when the display
name is a relative path.

Signed-off-by: Simon Ser <contact@emersion.fr>
This commit is contained in:
Simon Ser 2020-04-16 19:49:12 +02:00
parent 25f216d97f
commit 24ca1a5b57
No known key found for this signature in database
GPG key ID: 0FDE7BE0E88F5E48
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/wayland-client.c
View file

@ -1113,6 +1113,13 @@ wl_display_connect_to_fd(int fd)
* its value will be replaced with the WAYLAND_DISPLAY environment * its value will be replaced with the WAYLAND_DISPLAY environment
* variable if it is set, otherwise display "wayland-0" will be used. * 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 * 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; * the location of the socket at which the Wayland server is listening;
* no qualification inside XDG_RUNTIME_DIR is attempted. * no qualification inside XDG_RUNTIME_DIR is attempted.