X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_session_is_active.xml;h=31a611996e3b4b6bbb5a5404e1d0a04607b8e05b;hb=2139694e823935d3ac1479aa7c9a78ee3ffdc759;hp=6fa803bfa2f7e1a2f13b13d531a536392e690696;hpb=cc400110ffe1fb29b32e995e770819c1817bbfbc;p=elogind.git
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index 6fa803bfa..31a611996 100644
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -44,6 +44,7 @@
sd_session_is_active
+ sd_session_is_remote
sd_session_get_state
sd_session_get_uid
sd_session_get_seat
@@ -52,6 +53,9 @@
sd_session_get_class
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
@@ -64,6 +68,11 @@
const char* session
+
+ int sd_session_is_remote
+ const char* session
+
+
int sd_session_get_state
const char* session
@@ -106,11 +115,29 @@
char** display
+
+ int sd_session_get_remote_host
+ const char* session
+ char** remote_host
+
+
+
+ int sd_session_get_remote_user
+ const char* session
+ char** remote_user
+
+
int sd_session_get_tty
const char* session
char** tty
+
+
+ int sd_session_get_vt
+ const char* session
+ unsigned int* vt
+
@@ -123,6 +150,11 @@
(i.e. currently in the foreground and available for
user input) or not.
+ sd_session_is_remote() may
+ be used to determine whether the session identified by
+ the specified session identifier is a remote session
+ (i.e. its remote host is known) or not.
+
sd_session_get_state() may
be used to determine the state of the session
identified by the specified session identifier. The
@@ -169,9 +201,9 @@
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
+ wayland, tty,
+ mir or unspecified and
+ needs to be freed with the libc
free3
call after use.
@@ -194,6 +226,23 @@
free3
call after use.
+ sd_session_get_remote_host()
+ may be used to determine the remote hostname of the
+ session identified by the specified session
+ identifier. The returned string needs to be
+ freed with the libc
+ free3
+ call after use.
+
+ sd_session_get_remote_user()
+ may be used to determine the remote username of the
+ session identified by the specified session
+ identifier. The returned string needs to be
+ freed with the libc
+ free3
+ call after use. Note that this value is rarely known
+ to the system, and even then should not be relied on.
+
sd_session_get_tty()
may be used to determine the TTY device of the
session identified by the specified session
@@ -202,25 +251,35 @@
free3
call after use.
- If the session parameter of
- any of these functions is passed as NULL the operation
- is executed for the session the calling process is a
- member of, if there is any.
+ sd_session_get_vt()
+ may be used to determine the VT number of the
+ session identified by the specified session
+ identifier. This function will return an error if
+ the seat does not support VTs.
+
+ If the session parameter of
+ any of these functions is passed as
+ NULL, the operation is executed
+ for the session the calling process is a member of, if
+ there is any.
Return Value
- If the test succeeds
- sd_session_is_active() returns a
- positive integer, if it fails 0. On success
+ If the test succeeds,
+ sd_session_is_active() and
+ sd_session_is_remote() return a
+ positive integer; if it fails, 0. On success,
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_display() and
+ sd_session_get_display(),
+ sd_session_get_remote_user(),
+ sd_session_get_remote_host() and
sd_session_get_tty() return 0 or
a positive integer. On failure, these calls return a
negative errno-style error code.
@@ -236,12 +295,13 @@
sd_session_get_service(),
sd_session_get_type(),
sd_session_get_class(),
- sd_session_get_display() and
+ sd_session_get_display(),
+ 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.