X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_session_is_active.xml;h=5006be4df5421536518bc30d7dd4382098529417;hp=1fa7457f7873b00a530657e6f5e7938e86be1902;hb=79c1afc67f973eaece8f1b7016e016bb33c256a7;hpb=a485210ce73fe1186fdc5fae481dc31773e14b3c
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index 1fa7457f7..5006be4df 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
@@ -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
@@ -61,55 +65,78 @@
int sd_session_is_active
- const char* session
+ const char *session
+
+
+
+ int sd_session_is_remote
+ 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_display
- const char* session
- char** display
+ 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
+ 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
@@ -139,7 +171,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
@@ -153,7 +185,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()
@@ -162,27 +194,28 @@
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
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
+ free3
call after use.
sd_session_get_display()
@@ -190,36 +223,63 @@
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()
+ 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
+ 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.
@@ -235,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.