X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_session_is_active.xml;h=d94ae196ab6e1db7c9cac6c205abc7e9d820e2ae;hb=5b04fe60004e7c5cd5a43648ede3e6a965e70b8c;hp=a9107cb95f552a77cad4c9e7b95ead62f78d7964;hpb=f274ece0f76b5709408821e317e87aef76123db6;p=elogind.git
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index a9107cb95..d94ae196a 100644
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -21,7 +21,7 @@
along with systemd; If not, see .
-->
-
+
sd_session_is_active
@@ -51,6 +51,8 @@
sd_session_get_type
sd_session_get_class
sd_session_get_display
+ sd_session_get_tty
+ sd_session_get_vt
Determine state of a specific session
@@ -63,6 +65,11 @@
const char* session
+
+ int sd_session_is_remote
+ const char* session
+
+
int sd_session_get_state
const char* session
@@ -104,6 +111,30 @@
const char* session
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
+
@@ -116,6 +147,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
@@ -172,8 +208,9 @@
be used to determine the class of the session
identified by the specified session identifier. The
returned string is one of user,
- greeter or
- lock-screen and needs to be freed
+ greeter,
+ lock-screen, or
+ background and needs to be freed
with the libc
free3
call after use.
@@ -181,30 +218,66 @@
sd_session_get_display()
may be used to determine the X11 display of the
session identified by the specified session
- identifier. The returned string is one of needs to be
+ identifier. The returned string needs to be
+ freed with the libc
+ 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
+ identifier. The returned string needs to be
freed with the libc
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
+ 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() and
- sd_session_get_display() return 0 or
+ sd_session_get_class(),
+ 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.
@@ -218,12 +291,14 @@
sd_session_get_seat(),
sd_session_get_service(),
sd_session_get_type(),
- sd_session_get_class() and
- sd_session_get_display() interfaces
- are available as shared library, which can be compiled
- and linked to with the
- libsystemd-login
- pkg-config1
+ sd_session_get_class(),
+ 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
+ be compiled and linked to with the
+ libsystemd-login pkg-config1
file.