summaryrefslogtreecommitdiff
path: root/man/sd_uid_get_state.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2012-09-12 08:30:35 +0200
committerLennart Poettering <lennart@poettering.net>2012-09-12 08:30:35 +0200
commitd18dff430bf60291a41b2c7dbe0ae5a5c4edf36c (patch)
treea3f72a4d63da42dc5ce32a422fef26f501ee8c74 /man/sd_uid_get_state.xml
parent78ab361c8f5f5d7614b5bf98b92f3aec4183bfb7 (diff)
login: reshuffle meaning of require_active parameter
Diffstat (limited to 'man/sd_uid_get_state.xml')
-rw-r--r--man/sd_uid_get_state.xml17
1 files changed, 9 insertions, 8 deletions
diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml
index b9b713c64..183e8a600 100644
--- a/man/sd_uid_get_state.xml
+++ b/man/sd_uid_get_state.xml
@@ -111,7 +111,7 @@
or active on a specific seat. Accepts a Unix user
identifier and a seat identifier string as
parameters. The <parameter>require_active</parameter>
- parameter is a boolean. If non-zero (true) this
+ parameter is a boolean value. If non-zero (true) this
function will test if the user is active (i.e. has a
session that is in the foreground and accepting user
input) on the specified seat, otherwise (false) only
@@ -122,13 +122,14 @@
be used to determine the current sessions of the
specified user. Acceptes a Unix user identifier as
parameter. The <parameter>require_active</parameter>
- boolean parameter controls whether the returned list
- shall consist of only those sessions where the user is
- currently active (true) or where the user is currently
- logged in at all, possibly inactive (false). The call
- returns a NULL terminated string array of session
- identifiers in <parameter>sessions</parameter> which
- needs to be freed by the caller with the libc
+ parameter controls whether the returned list shall
+ consist of only those sessions where the user is
+ currently active (&gt; 0), where the user is currently
+ online but possibly inactive (= 0), or
+ logged in at all but possibly closing the session (&lt; 0). The call returns a
+ NULL terminated string array of session identifiers in
+ <parameter>sessions</parameter> which needs to be
+ freed by the caller with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use, including all the strings
referenced. If the string array parameter is passed as