chiark / gitweb /
hashmap: return more information from resize_buckets()
[elogind.git] / man / sd_seat_get_active.xml
index 3060ec7d52eaf468a9abf74771318db9de3ffe6b..20c7b99daa312995ec97b9b9319f719a7e8edd43 100644 (file)
@@ -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>
 
 
                         <funcprototype>
                                 <funcdef>int <function>sd_seat_get_active</function></funcdef>
-                                <paramdef>const char<parameter>seat</parameter></paramdef>
-                                <paramdef>char** <parameter>session</parameter></paramdef>
-                                <paramdef>uid_t<parameter>uid</parameter></paramdef>
+                                <paramdef>const char *<parameter>seat</parameter></paramdef>
+                                <paramdef>char **<parameter>session</parameter></paramdef>
+                                <paramdef>uid_t *<parameter>uid</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_seat_get_sessions</function></funcdef>
-                                <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>const char *<parameter>seat</parameter></paramdef>
+                                <paramdef>char ***<parameter>sessions</parameter></paramdef>
+                                <paramdef>uid_t **<parameter>uid</parameter></paramdef>
+                                <paramdef>unsigned int *<parameter>n_uids</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_seat_can_multi_session</function></funcdef>
-                                <paramdef>const char<parameter>seat</parameter></paramdef>
+                                <paramdef>const char *<parameter>seat</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_seat_can_tty</function></funcdef>
-                                <paramdef>const char<parameter>seat</parameter></paramdef>
+                                <paramdef>const char *<parameter>seat</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_seat_can_graphical</function></funcdef>
-                                <paramdef>const char<parameter>seat</parameter></paramdef>
+                                <paramdef>const char *<parameter>seat</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
                 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 passed NULL, 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>
+                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 project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
 
                 <para><function>sd_seat_get_sessions()</function> may
                 <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>
+                <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use. Note that instead of an empty array
                 <constant>NULL</constant> may be returned and should be considered
                 equivalent to an empty array.</para>
 
                 <para>If the <varname>seat</varname> parameter of any
                 of these functions is passed as
-                <constant>NULL</constant> the operation is executed
+                <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
+                <para> On success,
                 <function>sd_seat_get_active()</function>
-                returns 0 or a positive integer. On success
+                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_multi_session()</function>,
                 <function>sd_seat_can_tty()</function> and
                 <function>sd_seat_can_grapical()</function> interfaces
-                are available as shared library, which can be compiled
+                are available as shared library, which can be compiled
                 and linked to with the
-                <constant>libsystemd-login</constant>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>