X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_session_is_active.xml;h=e9840669c27c4efa4b0181bf5c88ba63c6a6e79c;hp=d94ae196ab6e1db7c9cac6c205abc7e9d820e2ae;hb=cb87a73b45503eaa6bead291423a529b00d27156;hpb=5b04fe60004e7c5cd5a43648ede3e6a965e70b8c
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index d94ae196a..e9840669c 100644
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -44,15 +44,19 @@
sd_session_is_active
+ sd_session_is_remote
sd_session_get_state
sd_session_get_uid
sd_session_get_seat
sd_session_get_service
sd_session_get_type
sd_session_get_class
+ sd_session_get_desktop
sd_session_get_display
sd_session_get_tty
sd_session_get_vt
+ sd_session_get_remote_host
+ sd_session_get_remote_user
Determine state of a specific session
@@ -62,78 +66,84 @@
int sd_session_is_active
- const char* session
+ const char *session
int sd_session_is_remote
- const char* session
+ const char *session
int sd_session_get_state
- const char* session
- char** state
+ const char *session
+ char **state
int sd_session_get_uid
- const char* session
- uid_t* uid
+ const char *session
+ uid_t *uid
int sd_session_get_seat
- const char* session
- char** seat
+ const char *session
+ char **seat
int sd_session_get_service
- const char* session
- char** service
+ const char *session
+ char **service
int sd_session_get_type
- const char* session
- char** type
+ const char *session
+ char **type
int sd_session_get_class
- const char* session
- char** class
+ const char *session
+ char **class
+
+
+
+ int sd_session_get_desktop
+ const char *session
+ char **desktop
int sd_session_get_display
- const char* session
- char** display
+ const char *session
+ char **display
int sd_session_get_remote_host
- const char* session
- char** remote_host
+ const char *session
+ char **remote_host
int sd_session_get_remote_user
- const char* session
- char** remote_user
+ const char *session
+ char **remote_user
int sd_session_get_tty
- const char* session
- char** tty
+ const char *session
+ char **tty
int sd_session_get_vt
- const char* session
- unsigned int* vt
+ const char *session
+ unsigned int *vt
@@ -168,7 +178,7 @@
returned. This function is a more generic version of
sd_session_is_active(). The returned
string needs to be freed with the libc
- free3
+ free3
call after use.
sd_session_get_uid() may be
@@ -182,7 +192,7 @@
identifier belongs to. Note that not all sessions are
attached to a seat, this call will fail for them. The
returned string needs to be freed with the libc
- free3
+ free3
call after use.
sd_session_get_service()
@@ -191,17 +201,17 @@
session identified by the specified session
identifier. The returned string needs to be freed with
the libc
- free3
+ free3
call after use.
sd_session_get_type() may
be used to determine the type of the session
identified by the specified session identifier. The
returned string is one of x11,
- tty or
- unspecified and needs to be freed
- with the libc
- free3
+ wayland, tty,
+ mir or unspecified and
+ needs to be freed with the libc
+ free3
call after use.
sd_session_get_class() may
@@ -212,7 +222,23 @@
lock-screen, or
background and needs to be freed
with the libc
- free3
+ free3
+ call after use.
+
+ sd_session_get_desktop() may
+ be used to determine the brand of the desktop running on
+ the session identified by the specified session identifier.
+ This field can be set freely by desktop environments and
+ does not follow any special formatting. However, desktops
+ are strongly recommended to use the same identifiers and
+ capitalization as for
+ $XDG_CURRENT_DESKTOP, as defined by
+ the Desktop
+ Entry
+ Specification. The returned string needs to be
+ freed with the libc
+ free3
call after use.
sd_session_get_display()
@@ -220,7 +246,7 @@
session identified by the specified session
identifier. The returned string needs to be
freed with the libc
- free3
+ free3
call after use.
sd_session_get_remote_host()
@@ -228,7 +254,7 @@
session identified by the specified session
identifier. The returned string needs to be
freed with the libc
- free3
+ free3
call after use.
sd_session_get_remote_user()
@@ -236,7 +262,7 @@
session identified by the specified session
identifier. The returned string needs to be
freed with the libc
- free3
+ free3
call after use. Note that this value is rarely known
to the system, and even then should not be relied on.
@@ -245,7 +271,7 @@
session identified by the specified session
identifier. The returned string needs to be
freed with the libc
- free3
+ free3
call after use.
sd_session_get_vt()
@@ -267,7 +293,7 @@
If the test succeeds,
sd_session_is_active() and
sd_session_is_remote() return a
- positive integer, if it fails 0. On success
+ positive integer; if it fails, 0. On success,
sd_session_get_state(),
sd_session_get_uid(),
sd_session_get_seat(),
@@ -296,9 +322,9 @@
sd_session_get_remote_host(),
sd_session_get_remote_user() and
sd_session_get_tty()
- interfaces are available as shared library, which can
+ interfaces are available as a shared library, which can
be compiled and linked to with the
- libsystemd-login pkg-config1
+ libsystemd pkg-config1
file.