picnoir/Systemd
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

man: document new sd_session_get_state() call

Browse source
This commit is contained in:
Lennart Poettering 2012-06-21 16:31:06 +02:00
parent 0604381b9d
commit 7ea9cb9120
2 changed files with 32 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
man/sd_session_is_active.xml
View file

@ -44,6 +44,7 @@
<refnamediv>
<refname>sd_session_is_active</refname>
<refname>sd_session_get_state</refname>
<refname>sd_session_get_uid</refname>
<refname>sd_session_get_seat</refname>
<refname>sd_session_get_service</refname>
@ -62,6 +63,12 @@
<paramdef>const char* <parameter>session</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_session_get_state</function></funcdef>
<paramdef>const char* <parameter>session</parameter></paramdef>
<paramdef>char** <parameter>state</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_session_get_uid</function></funcdef>
<paramdef>const char* <parameter>session</parameter></paramdef>
@ -109,6 +116,25 @@
(i.e. currently in the foreground and available for
user input) or not.</para>
<para><function>sd_session_get_state()</function> may
be used to determine the state of the session
identified by the specified session identifier. The
following states are currently known:
<literal>online</literal> (session logged in, but
session not active, i.e. not in the foreground),
<literal>active</literal> (session logged in and
active, i.e. in the foreground),
<literal>closing</literal> (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
<function>sd_session_is_active()</function>. The returned
string needs to be freed with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para>
<para><function>sd_session_get_uid()</function> may be
used to determine the user identifier of the Unix user the session
identified by the specified session identifier belongs

8
man/sd_uid_get_state.xml
View file

@ -93,8 +93,12 @@
at all), <literal>lingering</literal> (user not logged
in, but some user services running),
<literal>online</literal> (user logged in, but not
active), <literal>active</literal> (user logged in on
an active seat). In the future additional states might
active, i.e. has no session in the foreground),
<literal>active</literal> (user logged in, and has at
least one active session, i.e. one session in the
foreground), <literal>closing</literal> (user not
logged in, and not lingering, but some processes 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. The returned string needs to be freed with