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=e89117d990a1314f9fda5a8ace15957397518426;hp=516275ea9feadcb53d80f0cad0e257eb07a732c8;hb=6b4991cfde6c0a0b62e836ca75ae362779c474d4;hpb=eff406331adb23e27e4bd29a3b69322fc359ca3d
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index 516275ea9..e89117d99 100644
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -8,20 +8,20 @@
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see .
-->
-
+
sd_session_is_active
@@ -44,9 +44,14 @@
sd_session_is_active
+ 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
+ sd_session_get_tty
Determine state of a specific session
@@ -59,6 +64,12 @@
const char* session
+
+ int sd_session_get_state
+ const char* session
+ char** state
+
+
int sd_session_get_uid
const char* session
@@ -76,6 +87,30 @@
const char* session
char** service
+
+
+ int sd_session_get_type
+ const char* session
+ char** type
+
+
+
+ int sd_session_get_class
+ const char* session
+ char** class
+
+
+
+ int sd_session_get_display
+ const char* session
+ char** display
+
+
+
+ int sd_session_get_tty
+ const char* session
+ char** tty
+
@@ -88,6 +123,25 @@
(i.e. currently in the foreground and available for
user input) or not.
+ sd_session_get_state() may
+ be used to determine the state of the session
+ identified by the specified session identifier. The
+ following states are currently known:
+ online (session logged in, but
+ session not active, i.e. not in the foreground),
+ active (session logged in and
+ active, i.e. in the foreground),
+ closing (session nominally logged
+ out, but some processes belonging to it are still
+ around). In the future additional states might be
+ defined, client code should be written to be robust in
+ regards to additional state strings being
+ returned. This function is a more generic version of
+ sd_session_is_active(). The returned
+ string needs to be freed with the libc
+ free3
+ call after use.
+
sd_session_get_uid() may be
used to determine the user identifier of the Unix user the session
identified by the specified session identifier belongs
@@ -110,6 +164,49 @@
the libc
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
+ 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,
+ lock-screen, or
+ background and needs to be freed
+ with the libc
+ free3
+ call after use.
+
+ sd_session_get_display()
+ may be used to determine the X11 display 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_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.
@@ -118,9 +215,14 @@
If the test succeeds
sd_session_is_active() returns a
positive integer, if it fails 0. On success
+ sd_session_get_state(),
sd_session_get_uid(),
- sd_session_get_service() and
- sd_session_get_seat() return 0 or
+ sd_session_get_seat(),
+ sd_session_get_service(),
+ sd_session_get_type(),
+ sd_session_get_class(),
+ sd_session_get_display() and
+ sd_session_get_tty() return 0 or
a positive integer. On failure, these calls return a
negative errno-style error code.
@@ -129,13 +231,17 @@
Notes
The sd_session_is_active(),
+ sd_session_get_state(),
sd_session_get_uid(),
- sd_session_get_service() and
- sd_session_get_seat() interfaces
- are available as shared library, which can be compiled
- and linked to with the
- libsystemd-login
- pkg-config1
+ sd_session_get_seat(),
+ sd_session_get_service(),
+ sd_session_get_type(),
+ sd_session_get_class(),
+ sd_session_get_display() 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.
@@ -144,7 +250,7 @@
systemd1,
- sd-login7,
+ sd-login3,
sd_pid_get_session3