X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_uid_get_state.xml;h=e1b345c2779a1774bb94d72445ba43e2207a8c9f;hp=9249021aa159a5a992a3d1d3d967a72c667d1f22;hb=edf2573743b25273bee020230a60f1a054b8ec60;hpb=19c5f19d69bb5f520fa7213239490c55de06d99d diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index 9249021aa..e1b345c27 100644 --- a/man/sd_uid_get_state.xml +++ b/man/sd_uid_get_state.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_uid_get_state @@ -47,6 +47,7 @@ sd_uid_is_on_seat sd_uid_get_sessions sd_uid_get_seats + sd_uid_get_display Determine login state of a specific Unix user ID @@ -57,28 +58,34 @@ int sd_uid_get_state uid_t uid - char** state + char **state int sd_uid_is_on_seat uid_t uid int require_active - const char* seat + const char *seat int sd_uid_get_sessions uid_t uid int require_active - char*** sessions + char ***sessions int sd_uid_get_seats uid_t uid int require_active - char*** seats + char ***seats + + + + int sd_uid_get_display + uid_t uid + char **session @@ -93,13 +100,17 @@ at all), lingering (user not logged in, but some user services running), online (user logged in, but not - active), active (user logged in on - an active seat). In the future additional states might + active, i.e. has no session in the foreground), + active (user logged in, and has at + least one active session, i.e. one session in the + foreground), closing (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 the libc - free3 + free3 call after use. sd_uid_is_on_seat() may be @@ -107,7 +118,7 @@ or active on a specific seat. Accepts a Unix user identifier and a seat identifier string as parameters. The require_active - 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 @@ -116,25 +127,26 @@ sd_uid_get_sessions() may be used to determine the current sessions of the - specified user. Acceptes a Unix user identifier as + specified user. Accepts a Unix user identifier as parameter. The require_active - 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 sessions which - needs to be freed by the caller with the libc - free3 + parameter controls whether the returned list shall + consist of only those sessions where the user is + currently active (> 0), where the user is currently + online but possibly inactive (= 0), or + logged in at all but possibly closing the session (< 0). The call returns a + NULL terminated string array of session identifiers in + sessions which needs to be + freed by the caller with the libc + free3 call after use, including all the strings referenced. If the string array parameter is passed as - NULL the array will not be filled in, but the return + NULL, the array will not be filled in, but the return code still indicates the number of current - sessions. Note that instead of an empty array NULL may + sessions. Note that instead of an empty array NULL may be returned and should be considered equivalent to an empty array. - Similar, sd_uid_get_seats() + Similarly, sd_uid_get_seats() may be used to determine the list of seats on which the user currently has sessions. Similar semantics apply, however note that the user may have @@ -142,19 +154,27 @@ with no attached seat and hence the number of entries in the returned array may differ from the one returned by sd_uid_get_sessions(). + + sd_uid_get_display() + returns the name of the "primary" session of a user. + If the user has graphical sessions, it will be the + oldest graphical session. Otherwise, it will be the + oldest open session. Return Value - On success + On success, sd_uid_get_state() returns 0 or a - positive integer. If the test succeeds + positive integer. If the test succeeds, sd_uid_is_on_seat() returns a - positive integer, if it fails + positive integer; if it fails, 0. sd_uid_get_sessions() and sd_uid_get_seats() return the - number of entries in the returned arrays. On failure, + number of entries in the returned arrays. + sd_uid_get_display() returns + a non-negative code on success. On failure, these calls return a negative errno-style error code. @@ -162,14 +182,24 @@ Notes - The sd_uid_get_state(), + Functions described here are available as a + shared library, and can be compiled and linked to + using the + libsystemd pkg-config1 + entry. + + + + History + + sd_uid_get_state(), sd_uid_is_on_seat(), - sd_uid_get_sessions(), and - sd_uid_get_seats() interfaces are - available as shared library, which can be compiled and - linked to with the libsystemd-login - pkg-config1 - file. + sd_uid_get_sessions(), + and sd_uid_get_seats() functions + were added in systemd-31. + + sd_uid_get_display() was + added in systemd-213. @@ -177,7 +207,7 @@ systemd1, - sd-login7, + sd-login3, sd_pid_get_owner_uid3