X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_session_is_active.xml;h=a14286aeabf4bf3387d5259a05f465f0a7e6ecee;hb=5076f0ccfd36b67512d44fe355b80305ced7dcba;hp=88b22fd9f8366cabe5b791d26c209f98f84610f2;hpb=595aae376fae21f885ec9af2cac1aaf3ff3e9bee;p=elogind.git
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index 88b22fd9f..a14286aea 100644
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -8,16 +8,16 @@
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 .
-->
@@ -44,8 +44,13 @@
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
Determine state of a specific session
@@ -58,6 +63,12 @@
const char* session
+
+ int sd_session_get_state
+ const char* session
+ char** state
+
+
int sd_session_get_uid
const char* session
@@ -69,6 +80,30 @@
const char* session
char** seat
+
+
+ int sd_session_get_service
+ 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
+
@@ -81,6 +116,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
@@ -94,6 +148,48 @@
returned string needs to be freed with the libc
free3
call after use.
+
+ sd_session_get_service()
+ may be used to determine the name of the service (as
+ passed during PAM session setup) that registered 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_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 or
+ lock-screen 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 is one of 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.
@@ -102,8 +198,13 @@
If the test succeeds
sd_session_is_active() returns a
positive integer, if it fails 0. On success
- sd_session_get_uid() and
- sd_session_get_seat() return 0 or
+ 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
a positive integer. On failure, these calls return a
negative errno-style error code.
@@ -112,8 +213,13 @@
Notes
The sd_session_is_active(),
- sd_session_get_uid(), and
- sd_session_get_seat() interfaces
+ 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() interfaces
are available as shared library, which can be compiled
and linked to with the
libsystemd-login