summaryrefslogtreecommitdiff
path: root/man/sd_session_is_active.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2013-01-15 03:00:33 +0100
committerLennart Poettering <lennart@poettering.net>2013-01-15 03:01:35 +0100
commitc84f5e4a825f17163ead0f60308d548b415334a5 (patch)
treea24bd2dfb483a9d0b44198f0aaada5459a24fb0a /man/sd_session_is_active.xml
parentdd04aac97f9e4739152e77d9f52bb0d0da1375d6 (diff)
login: introduce sd_session_get_tty()
Diffstat (limited to 'man/sd_session_is_active.xml')
-rw-r--r--man/sd_session_is_active.xml29
1 files changed, 23 insertions, 6 deletions
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index a9107cb95f..ab48b9efc2 100644
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -51,6 +51,7 @@
<refname>sd_session_get_type</refname>
<refname>sd_session_get_class</refname>
<refname>sd_session_get_display</refname>
+ <refname>sd_session_get_tty</refname>
<refpurpose>Determine state of a specific session</refpurpose>
</refnamediv>
@@ -104,6 +105,12 @@
<paramdef>const char* <parameter>session</parameter></paramdef>
<paramdef>char** <parameter>display</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>
+ </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -186,6 +193,14 @@
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para>
+ <para><function>sd_session_get_tty()</function>
+ may be used to determine the TTY device of the
+ session identified by the specified session
+ identifier. The returned string is one of needs to be
+ freed with the libc
+ <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ call after use.</para>
+
<para>If the <literal>session</literal> parameter of
any of these functions is passed as NULL the operation
is executed for the session the calling process is a
@@ -203,8 +218,9 @@
<function>sd_session_get_seat()</function>,
<function>sd_session_get_service()</function>,
<function>sd_session_get_type()</function>,
- <function>sd_session_get_class()</function> and
- <function>sd_session_get_display()</function> return 0 or
+ <function>sd_session_get_class()</function>,
+ <function>sd_session_get_display()</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>
</refsect1>
@@ -218,10 +234,11 @@
<function>sd_session_get_seat()</function>,
<function>sd_session_get_service()</function>,
<function>sd_session_get_type()</function>,
- <function>sd_session_get_class()</function> and
- <function>sd_session_get_display()</function> interfaces
- are available as shared library, which can be compiled
- and linked to with the
+ <function>sd_session_get_class()</function>,
+ <function>sd_session_get_display()</function> and
+ <function>sd_session_get_tty()</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>
file.</para>