chiark / gitweb /
bus: make sd_bus_request_name() and sd_bus_release_name() behave more like other...
[elogind.git] / man / sd_seat_get_active.xml
index 82a1ea0481cd11ed811563638006fcd2b53f1865..cd8769698c508d324ea56032afdfc58e9ec0a9bf 100644 (file)
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_seat_get_active">
+<refentry id="sd_seat_get_active" conditional='HAVE_PAM'>
 
         <refentryinfo>
                 <title>sd_seat_get_active</title>
@@ -46,6 +46,8 @@
                 <refname>sd_seat_get_active</refname>
                 <refname>sd_seat_get_sessions</refname>
                 <refname>sd_seat_can_multi_session</refname>
+                <refname>sd_seat_can_tty</refname>
+                <refname>sd_seat_can_graphical</refname>
                 <refpurpose>Determine state of a specific seat</refpurpose>
         </refnamediv>
 
@@ -65,7 +67,7 @@
                                 <paramdef>const char* <parameter>seat</parameter></paramdef>
                                 <paramdef>char*** <parameter>sessions</parameter></paramdef>
                                 <paramdef>uid_t** <parameter>uid</parameter></paramdef>
-                                <paramdef>unsigned* <parameter>n_uids</parameter></paramdef>
+                                <paramdef>unsigned int* <parameter>n_uids</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                 a seat, if there is any. Returns the session
                 identifier and the user identifier of the Unix user
                 the session is belonging to. Either the session or the
-                user identifier parameter can be be passed NULL, in
-                case only one of the parameters shall be queried. The
-                returned string needs to be freed with the libc
+                user identifier parameter can be passed
+                <constant>NULL</constant>, in case only one of the
+                parameters shall be queried. 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_seat_get_sessions()</function> may
                 be used to determine all sessions on the specified
-                seat. Returns two arrays, one (NULL terminated) with
+                seat. Returns two arrays, one (<constant>NULL</constant> terminated) with
                 the session identifiers of the sessions and one with
                 the user identifiers of the Unix users the sessions
                 belong to. An additional parameter may be used to
                 return the number of entries in the latter array. The
                 two arrays and the latter parameter may be passed as
-                NULL in case these values need not to be
+                <constant>NULL</constant> in case these values need not to be
                 determined. The arrays and the strings referenced by
                 them need to be freed with the libc
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use. Note that instead of an empty array
-                NULL may be returned and should be considered
+                <constant>NULL</constant> may be returned and should be considered
                 equivalent to an empty array.</para>
 
                 <para><function>sd_seat_can_multi_session()</function>
                 may be used to determine whether a specific seat is
                 capable of multi-session, i.e. allows multiple login
-                sessions in parallel (whith only one being active at a
+                sessions in parallel (with only one being active at a
                 time).</para>
 
                 <para><function>sd_seat_can_tty()</function> may be
                 graphics functionality, i.e. is useful as a graphics
                 display.</para>
 
-                <para>If the <literal>seat</literal> parameter of any
-                of these functions is passed as NULL the operation is
-                executed for the seat of the session of the calling
-                process, if there is any.</para>
+                <para>If the <varname>seat</varname> parameter of any
+                of these functions is passed as
+                <constant>NULL</constant>, the operation is executed
+                for the seat of the session of the calling process, if
+                there is any.</para>
         </refsect1>
 
         <refsect1>
                 <title>Return Value</title>
 
                 <para> On success
-                <function>sd_seat_get_active()</function> return
-                return 0 or a positive integer. On success
+                <function>sd_seat_get_active()</function>
+                returns 0 or a positive integer. On success
                 <function>sd_seat_get_sessions()</function> returns
                 the number of entries in the session identifier
-                array. If the test succeeds
+                array. If the test succeeds,
                 <function>sd_seat_can_multi_session</function>,
                 <function>sd_seat_can_tty</function> and
                 <function>sd_seat_can_graphical</function> return a
                 <function>sd_seat_can_grapical()</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>
+                <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>
 
 
                 <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_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 </para>
         </refsect1>