diff options
author | Mantas MikulÄ—nas <grawity@gmail.com> | 2013-12-22 02:48:46 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2013-12-21 22:02:57 -0500 |
commit | 5b04fe60004e7c5cd5a43648ede3e6a965e70b8c (patch) | |
tree | 8af2bf059a7aef482afbe3376f64ffc798e17114 /man | |
parent | bee7e928990fd8a0c5909c2022a2b9eede557c81 (diff) |
libsystemd-login: add sd_session_get_remote_{host, user}
Diffstat (limited to 'man')
-rw-r--r-- | man/sd_session_is_active.xml | 50 |
1 files changed, 47 insertions, 3 deletions
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml index 293ce71642..d94ae196ab 100644 --- a/man/sd_session_is_active.xml +++ b/man/sd_session_is_active.xml @@ -66,6 +66,11 @@ </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> <paramdef>char** <parameter>state</parameter></paramdef> @@ -108,6 +113,18 @@ </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> <paramdef>char** <parameter>tty</parameter></paramdef> @@ -130,6 +147,11 @@ (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 @@ -201,6 +223,23 @@ <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 @@ -226,7 +265,8 @@ <title>Return Value</title> <para>If the test succeeds, - <function>sd_session_is_active()</function> returns a + <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>, @@ -234,7 +274,9 @@ <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> @@ -250,7 +292,9 @@ <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> interfaces are available as shared library, which can be compiled and linked to with the |