login: document new sd_session_get_xxx() calls

This commit is contained in:
Lennart Poettering 2012-02-15 20:13:24 +01:00
parent eb91400c68
commit 81e0d95604
2 changed files with 57 additions and 0 deletions

View File

@ -2064,6 +2064,10 @@ MANPAGES_ALIAS += \
man/sd_login_monitor_get_fd.3 \ man/sd_login_monitor_get_fd.3 \
man/sd_session_get_uid.3 \ man/sd_session_get_uid.3 \
man/sd_session_get_seat.3 \ man/sd_session_get_seat.3 \
man/sd_session_get_service.3 \
man/sd_session_get_type.3 \
man/sd_session_get_class.3 \
man/sd_session_get_display.3 \
man/sd_pid_get_owner_uid.3 \ man/sd_pid_get_owner_uid.3 \
man/sd_pid_get_unit.3 \ man/sd_pid_get_unit.3 \
man/sd_uid_is_on_seat.3 \ man/sd_uid_is_on_seat.3 \
@ -2079,6 +2083,10 @@ man/sd_login_monitor_flush.3: man/sd_login_monitor_new.3
man/sd_login_monitor_get_fd.3: man/sd_login_monitor_new.3 man/sd_login_monitor_get_fd.3: man/sd_login_monitor_new.3
man/sd_session_get_uid.3: man/sd_session_is_active.3 man/sd_session_get_uid.3: man/sd_session_is_active.3
man/sd_session_get_seat.3: man/sd_session_is_active.3 man/sd_session_get_seat.3: man/sd_session_is_active.3
man/sd_session_get_service.3: man/sd_session_is_active.3
man/sd_session_get_type.3: man/sd_session_is_active.3
man/sd_session_get_class.3: man/sd_session_is_active.3
man/sd_session_get_display.3: man/sd_session_is_active.3
man/sd_pid_get_owner_uid.3: man/sd_pid_get_session.3 man/sd_pid_get_owner_uid.3: man/sd_pid_get_session.3
man/sd_pid_get_unit.3: man/sd_pid_get_session.3 man/sd_pid_get_unit.3: man/sd_pid_get_session.3
man/sd_uid_is_on_seat.3: man/sd_uid_get_state.3 man/sd_uid_is_on_seat.3: man/sd_uid_get_state.3

View File

@ -47,6 +47,9 @@
<refname>sd_session_get_uid</refname> <refname>sd_session_get_uid</refname>
<refname>sd_session_get_seat</refname> <refname>sd_session_get_seat</refname>
<refname>sd_session_get_service</refname> <refname>sd_session_get_service</refname>
<refname>sd_session_get_type</refname>
<refname>sd_session_get_class</refname>
<refname>sd_session_get_display</refname>
<refpurpose>Determine state of a specific session</refpurpose> <refpurpose>Determine state of a specific session</refpurpose>
</refnamediv> </refnamediv>
@ -76,6 +79,24 @@
<paramdef>const char* <parameter>session</parameter></paramdef> <paramdef>const char* <parameter>session</parameter></paramdef>
<paramdef>char** <parameter>service</parameter></paramdef> <paramdef>char** <parameter>service</parameter></paramdef>
</funcprototype> </funcprototype>
<funcprototype>
<funcdef>int <function>sd_session_get_type</function></funcdef>
<paramdef>const char* <parameter>session</parameter></paramdef>
<paramdef>char** <parameter>type</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_session_get_class</function></funcdef>
<paramdef>const char* <parameter>session</parameter></paramdef>
<paramdef>char** <parameter>class</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_session_get_display</function></funcdef>
<paramdef>const char* <parameter>session</parameter></paramdef>
<paramdef>char** <parameter>display</parameter></paramdef>
</funcprototype>
</funcsynopsis> </funcsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -111,6 +132,34 @@
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para> 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>tty</literal> or
<literal>unspecified</literal> and needs to be freed
with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para>
<para><function>sd_session_get_class()</function> may
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
with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para>
<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
freed with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para>
<para>If the <literal>session</literal> parameter of <para>If the <literal>session</literal> parameter of
any of these functions is passed as NULL the operation any of these functions is passed as NULL the operation
is executed for the session the calling process is a is executed for the session the calling process is a