chiark / gitweb /
man: improve documentation for StandardOutput= and StandardInput=
[elogind.git] / man / sd_session_is_active.xml
index 4d5e6d113eab9f04cd303a6929360cb0fda1589f..5006be4df5421536518bc30d7dd4382098529417 100644 (file)
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_is_active</function></funcdef>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_is_active</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_is_remote</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_is_remote</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_state</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_state</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>state</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>state</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_uid</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_uid</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>uid_t<parameter>uid</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>uid_t *<parameter>uid</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_seat</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_seat</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>seat</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>seat</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_service</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_service</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>service</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>service</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_type</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_type</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>type</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>type</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_class</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_class</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>class</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>class</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_display</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_display</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>display</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>display</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_remote_host</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_remote_host</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>remote_host</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>remote_host</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_remote_user</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_remote_user</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>remote_user</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>remote_user</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_tty</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_tty</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>char** <parameter>tty</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>char **<parameter>tty</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_vt</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_vt</function></funcdef>
-                                <paramdef>const char<parameter>session</parameter></paramdef>
-                                <paramdef>unsigned int<parameter>vt</parameter></paramdef>
+                                <paramdef>const char *<parameter>session</parameter></paramdef>
+                                <paramdef>unsigned int *<parameter>vt</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
                 returned. This function is a more generic version of
                 <function>sd_session_is_active()</function>. The returned
                 string needs to be freed with the libc
                 returned. This function is a more generic version of
                 <function>sd_session_is_active()</function>. The returned
                 string needs 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.</para>
 
                 <para><function>sd_session_get_uid()</function> may be
                 call after use.</para>
 
                 <para><function>sd_session_get_uid()</function> may be
                 identifier belongs to. Note that not all sessions are
                 attached to a seat, this call will fail for them. The
                 returned string needs to be freed with the libc
                 identifier belongs to. Note that not all sessions are
                 attached to a seat, this call will fail for them. The
                 returned string needs 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.</para>
 
                 <para><function>sd_session_get_service()</function>
                 call after use.</para>
 
                 <para><function>sd_session_get_service()</function>
                 session identified by the specified session
                 identifier. The returned string needs to be freed with
                 the libc
                 session identified by the specified session
                 identifier. The returned string needs 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.</para>
 
                 <para><function>sd_session_get_type()</function> may
                 be used to determine the type of the session
                 identified by the specified session identifier. The
                 returned string is one of <literal>x11</literal>,
                 call after use.</para>
 
                 <para><function>sd_session_get_type()</function> may
                 be used to determine the type of the session
                 identified by the specified session identifier. The
                 returned string is one of <literal>x11</literal>,
-                <literal>wayland</literal>, <literal>tty</literal> or
-                <literal>unspecified</literal> and needs to be freed
-                with the libc
-                <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                <literal>wayland</literal>, <literal>tty</literal>,
+                <literal>mir</literal> or <literal>unspecified</literal> and
+                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_session_get_class()</function> may
                 call after use.</para>
 
                 <para><function>sd_session_get_class()</function> may
                 <literal>lock-screen</literal>, or
                 <literal>background</literal> and needs to be freed
                 with the libc
                 <literal>lock-screen</literal>, or
                 <literal>background</literal> and needs 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.</para>
 
                 <para><function>sd_session_get_display()</function>
                 call after use.</para>
 
                 <para><function>sd_session_get_display()</function>
                 session identified by the specified session
                 identifier. The returned string needs to be
                 freed with the libc
                 session identified by the specified session
                 identifier. The returned string needs 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.</para>
 
                 <para><function>sd_session_get_remote_host()</function>
                 call after use.</para>
 
                 <para><function>sd_session_get_remote_host()</function>
                 session identified by the specified session
                 identifier. The returned string needs to be
                 freed with the libc
                 session identified by the specified session
                 identifier. The returned string needs 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.</para>
 
                 <para><function>sd_session_get_remote_user()</function>
                 call after use.</para>
 
                 <para><function>sd_session_get_remote_user()</function>
                 session identified by the specified session
                 identifier. The returned string needs to be
                 freed with the libc
                 session identified by the specified session
                 identifier. The returned string needs 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 this value is rarely known
                 to the system, and even then should not be relied on.</para>
 
                 call after use. Note that this value is rarely known
                 to the system, and even then should not be relied on.</para>
 
                 session identified by the specified session
                 identifier. The returned string needs to be
                 freed with the libc
                 session identified by the specified session
                 identifier. The returned string needs 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.</para>
 
                 <para><function>sd_session_get_vt()</function>
                 call after use.</para>
 
                 <para><function>sd_session_get_vt()</function>
                 <function>sd_session_get_tty()</function>
                 interfaces are available as a shared library, which can
                 be compiled and linked to with the
                 <function>sd_session_get_tty()</function>
                 interfaces are available as a 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>
 
                 file.</para>
         </refsect1>