timer: add timer persistance (aka anacron-like behaviour)

[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 b9b713c64e9e508fd6c5af810a67216cde243070..f2899eed63b107c0cebea580adad2f1cb1499714 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/>.
 -->
 
   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>
 
         <refentryinfo>
                 <title>sd_uid_get_state</title>


@@ -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>
                 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
                 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


@@ -120,25 +120,26 @@
 
                 <para><function>sd_uid_get_sessions()</function> may
                 be used to determine the current sessions of the
 
                 <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>
                 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
+                <constant>NULL</constant> 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
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 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
+                <constant>NULL</constant>, the array will not be filled in, but the return

                 code still indicates the number of current
                 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 <constant>NULL</constant> may

                 be returned and should be considered equivalent to an
                 empty array.</para>
 
                 be returned and should be considered equivalent to an
                 empty array.</para>
 

-                <para>Similar, <function>sd_uid_get_seats()</function>
+                <para>Similarly, <function>sd_uid_get_seats()</function>

                 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
                 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


@@ -151,11 +152,11 @@
         <refsect1>
                 <title>Return Value</title>
 
         <refsect1>
                 <title>Return Value</title>
 

-                <para>On success
+                <para>On success,

                 <function>sd_uid_get_state()</function> returns 0 or a
                 <function>sd_uid_get_state()</function> returns 0 or a

-                positive integer. If the test succeeds
+                positive integer. If the test succeeds,

                 <function>sd_uid_is_on_seat()</function> returns a
                 <function>sd_uid_is_on_seat()</function> returns a

-                positive integer, if it fails
+                positive integer; if it fails,

                 0. <function>sd_uid_get_sessions()</function> and
                 <function>sd_uid_get_seats()</function> return the
                 number of entries in the returned arrays. On failure,
                 0. <function>sd_uid_get_sessions()</function> and
                 <function>sd_uid_get_seats()</function> return the
                 number of entries in the returned arrays. On failure,


@@ -170,9 +171,8 @@
                 <function>sd_uid_is_on_seat()</function>,
                 <function>sd_uid_get_sessions()</function>, and
                 <function>sd_uid_get_seats()</function> interfaces are
                 <function>sd_uid_is_on_seat()</function>,
                 <function>sd_uid_get_sessions()</function>, and
                 <function>sd_uid_get_seats()</function> interfaces are

-                available as shared library, which can be compiled and
-                linked to with the <literal>libsystemd-login</literal>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                available as a shared library, which can be compiled and
+                linked to with the <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>

                 file.</para>
         </refsect1>
 
                 file.</para>
         </refsect1>