build-sys: bump release and sonames

[elogind.git] / man / sd_uid_get_state.xml

diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml
index c5096e885b31b335a3d950b374246108e2eed4ae..cc8fc0f5b6046462a6bad549843fa4b0a8cc4b2e 100644 (file)
--- a/man/sd_uid_get_state.xml
+++ b/man/sd_uid_get_state.xml
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_uid_get_state">
+<refentry id="sd_uid_get_state" conditional='HAVE_PAM'>
 
         <refentryinfo>
                 <title>sd_uid_get_state</title>
@@ -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
@@ -107,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
@@ -116,15 +120,16 @@
 
                 <para><function>sd_uid_get_sessions()</function> 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 <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
@@ -177,7 +182,7 @@
 
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd_pid_get_owner_uid</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 </para>
         </refsect1>