logind: make session type and class settable via the same ways

[elogind.git] / man / sd_session_is_active.xml

diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index 293ce71642678bc573c9e170d0ea887efc7154d6..4d5e6d113eab9f04cd303a6929360cb0fda1589f 100644 (file)
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -44,6 +44,7 @@
 
         <refnamediv>
                 <refname>sd_session_is_active</refname>
 
         <refnamediv>
                 <refname>sd_session_is_active</refname>

+                <refname>sd_session_is_remote</refname>

                 <refname>sd_session_get_state</refname>
                 <refname>sd_session_get_uid</refname>
                 <refname>sd_session_get_seat</refname>
                 <refname>sd_session_get_state</refname>
                 <refname>sd_session_get_uid</refname>
                 <refname>sd_session_get_seat</refname>


@@ -53,6 +54,8 @@
                 <refname>sd_session_get_display</refname>
                 <refname>sd_session_get_tty</refname>
                 <refname>sd_session_get_vt</refname>
                 <refname>sd_session_get_display</refname>
                 <refname>sd_session_get_tty</refname>
                 <refname>sd_session_get_vt</refname>

+                <refname>sd_session_get_remote_host</refname>
+                <refname>sd_session_get_remote_user</refname>

                 <refpurpose>Determine state of a specific session</refpurpose>
         </refnamediv>
 
                 <refpurpose>Determine state of a specific session</refpurpose>
         </refnamediv>
 


@@ -65,6 +68,11 @@
                                 <paramdef>const char* <parameter>session</parameter></paramdef>
                         </funcprototype>
 
                                 <paramdef>const char* <parameter>session</parameter></paramdef>
                         </funcprototype>
 

+                        <funcprototype>
+                                <funcdef>int <function>sd_session_is_remote</function></funcdef>
+                                <paramdef>const char* <parameter>session</parameter></paramdef>
+                        </funcprototype>
+

                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_state</function></funcdef>
                                 <paramdef>const char* <parameter>session</parameter></paramdef>
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_state</function></funcdef>
                                 <paramdef>const char* <parameter>session</parameter></paramdef>


@@ -107,6 +115,18 @@
                                 <paramdef>char** <parameter>display</parameter></paramdef>
                         </funcprototype>
 
                                 <paramdef>char** <parameter>display</parameter></paramdef>
                         </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>
+                        </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>
+                        </funcprototype>
+

                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_tty</function></funcdef>
                                 <paramdef>const char* <parameter>session</parameter></paramdef>
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_tty</function></funcdef>
                                 <paramdef>const char* <parameter>session</parameter></paramdef>


@@ -130,6 +150,11 @@
                 (i.e. currently in the foreground and available for
                 user input) or not.</para>
 
                 (i.e. currently in the foreground and available for
                 user input) or not.</para>
 

+                <para><function>sd_session_is_remote()</function> may
+                be used to determine whether the session identified by
+                the specified session identifier is a remote session
+                (i.e. its remote host is known) or not.</para>
+

                 <para><function>sd_session_get_state()</function> may
                 be used to determine the state of the session
                 identified by the specified session identifier. The
                 <para><function>sd_session_get_state()</function> may
                 be used to determine the state of the session
                 identified by the specified session identifier. The


@@ -176,7 +201,7 @@
                 be used to determine the type of the session
                 identified by the specified session identifier. The
                 returned string is one of <literal>x11</literal>,
                 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>tty</literal> or
+                <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>unspecified</literal> and needs to be freed
                 with the libc
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>


@@ -201,6 +226,23 @@
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
 
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
 

+                <para><function>sd_session_get_remote_host()</function>
+                may be used to determine the remote hostname of the
+                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>
+                call after use.</para>
+
+                <para><function>sd_session_get_remote_user()</function>
+                may be used to determine the remote username of the
+                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>
+                call after use. Note that this value is rarely known
+                to the system, and even then should not be relied on.</para>
+

                 <para><function>sd_session_get_tty()</function>
                 may be used to determine the TTY device of the
                 session identified by the specified session
                 <para><function>sd_session_get_tty()</function>
                 may be used to determine the TTY device of the
                 session identified by the specified session


@@ -226,15 +268,18 @@
                 <title>Return Value</title>
 
                 <para>If the test succeeds,
                 <title>Return Value</title>
 
                 <para>If the test succeeds,

-                <function>sd_session_is_active()</function> returns a
-                positive integer, if it fails 0.  On success
+                <function>sd_session_is_active()</function> and
+                <function>sd_session_is_remote()</function> return a
+                positive integer; if it fails, 0.  On success,

                 <function>sd_session_get_state()</function>,
                 <function>sd_session_get_uid()</function>,
                 <function>sd_session_get_seat()</function>,
                 <function>sd_session_get_service()</function>,
                 <function>sd_session_get_type()</function>,
                 <function>sd_session_get_class()</function>,
                 <function>sd_session_get_state()</function>,
                 <function>sd_session_get_uid()</function>,
                 <function>sd_session_get_seat()</function>,
                 <function>sd_session_get_service()</function>,
                 <function>sd_session_get_type()</function>,
                 <function>sd_session_get_class()</function>,

-                <function>sd_session_get_display()</function> and
+                <function>sd_session_get_display()</function>,
+                <function>sd_session_get_remote_user()</function>,
+                <function>sd_session_get_remote_host()</function> and

                 <function>sd_session_get_tty()</function> return 0 or
                 a positive integer. On failure, these calls return a
                 negative errno-style error code.</para>
                 <function>sd_session_get_tty()</function> return 0 or
                 a positive integer. On failure, these calls return a
                 negative errno-style error code.</para>


@@ -250,9 +295,11 @@
                 <function>sd_session_get_service()</function>,
                 <function>sd_session_get_type()</function>,
                 <function>sd_session_get_class()</function>,
                 <function>sd_session_get_service()</function>,
                 <function>sd_session_get_type()</function>,
                 <function>sd_session_get_class()</function>,

-                <function>sd_session_get_display()</function> and
+                <function>sd_session_get_display()</function>,
+                <function>sd_session_get_remote_host()</function>,
+                <function>sd_session_get_remote_user()</function> and

                 <function>sd_session_get_tty()</function>
                 <function>sd_session_get_tty()</function>

-                interfaces are available as shared library, which can
+                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>
                 file.</para>
                 be compiled and linked to with the
                 <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>