X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_session_is_active.xml;h=293ce71642678bc573c9e170d0ea887efc7154d6;hp=a9107cb95f552a77cad4c9e7b95ead62f78d7964;hb=cd49e2f6641aaa3a9185704ca2f14a1e0855c247;hpb=cb07866b1b7c11e687a322d70dd9f9d73bbbe488

diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index a9107cb95..293ce7164 100644
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_session_is_active">
+<refentry id="sd_session_is_active" conditional='HAVE_PAM'>
 
         <refentryinfo>
                 <title>sd_session_is_active</title>
@@ -51,6 +51,8 @@
                 <refname>sd_session_get_type</refname>
                 <refname>sd_session_get_class</refname>
                 <refname>sd_session_get_display</refname>
+                <refname>sd_session_get_tty</refname>
+                <refname>sd_session_get_vt</refname>
                 <refpurpose>Determine state of a specific session</refpurpose>
         </refnamediv>
 
@@ -104,6 +106,18 @@
                                 <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>
+
+                        <funcprototype>
+                                <funcdef>int <function>sd_session_get_vt</function></funcdef>
+                                <paramdef>const char* <parameter>session</parameter></paramdef>
+                                <paramdef>unsigned int* <parameter>vt</parameter></paramdef>
+                        </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
 
@@ -172,8 +186,9 @@
                 be used to determine the class of the session
                 identified by the specified session identifier. The
                 returned string is one of <literal>user</literal>,
-                <literal>greeter</literal> or
-                <literal>lock-screen</literal> and needs to be freed
+                <literal>greeter</literal>,
+                <literal>lock-screen</literal>, or
+                <literal>background</literal> and needs to be freed
                 with the libc
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
@@ -181,21 +196,36 @@
                 <para><function>sd_session_get_display()</function>
                 may be used to determine the X11 display of the
                 session identified by the specified session
-                identifier. The returned string is one of needs to be
+                identifier. The returned string 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
-                member of, if there is any.</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 needs to be
+                freed with the libc
+                <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                call after use.</para>
+
+                <para><function>sd_session_get_vt()</function>
+                may be used to determine the VT number of the
+                session identified by the specified session
+                identifier. This function will return an error if
+                the seat does not support VTs.</para>
+
+                <para>If the <varname>session</varname> parameter of
+                any of these functions is passed as
+                <constant>NULL</constant>, the operation is executed
+                for the session the calling process is a member of, if
+                there is any.</para>
         </refsect1>
 
         <refsect1>
                 <title>Return Value</title>
 
-                <para>If the test succeeds
+                <para>If the test succeeds,
                 <function>sd_session_is_active()</function> returns a
                 positive integer, if it fails 0.  On success
                 <function>sd_session_get_state()</function>,
@@ -203,8 +233,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,12 +249,12 @@
                 <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
-                <literal>libsystemd-login</literal>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <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
+                <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>