man: various updates

This commit is contained in:
Lennart Poettering 2011-12-19 14:42:59 +01:00
parent 01448ff92d
commit 595aae376f
6 changed files with 41 additions and 15 deletions

View File

@ -75,7 +75,26 @@
actively make changes to the seat configuration, actively make changes to the seat configuration,
terminate login sessions, or switch session on a seat terminate login sessions, or switch session on a seat
you need to utilize the D-Bus API of you need to utilize the D-Bus API of
systemd-logind.</para> systemd-logind, instead.</para>
<para>These functions access data in
<filename>/proc</filename>,
<filename>/sys/fs/cgroup</filename> and
<filename>/run</filename>. All of these are virtual
file systems, hence the runtime cost of the accesses
is relatively cheap.</para>
<para>If the functions return string arrays, these are
generally NULL terminated and need to be freed by the
caller with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use, including the strings referenced
therein. Similar, individual strings returned need to
be freed, as well.</para>
<para>As a special exception, instead of an empty
string array NULL may be returned, which should be
treated equivalent to an empty string array.</para>
<para>See <para>See
<citerefentry><refentrytitle>sd_pid_get_session</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_pid_get_session</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

View File

@ -76,11 +76,13 @@
<para><function>sd_get_seats()</function> may be used <para><function>sd_get_seats()</function> may be used
to determine all currently available local to determine all currently available local
seats. Returns an array of seat identifiers. The seats. Returns a NULL terminated array of seat
returned array and all strings it references need to identifiers. The returned array and all strings it
be freed with the libc references need to be freed with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para> call after use. Note that instead of an empty array
NULL may be returned and should be considered
equivalent to an empty array.</para>
<para>Similar, <function>sd_get_sessions()</function> may <para>Similar, <function>sd_get_sessions()</function> may
be used to determine all current login sessions.</para> be used to determine all current login sessions.</para>
@ -118,7 +120,7 @@
<para> <para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para> </para>
</refsect1> </refsect1>

View File

@ -165,7 +165,7 @@
<para> <para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_get_seats</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_get_seats</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para> </para>
</refsect1> </refsect1>

View File

@ -101,7 +101,9 @@
determined. The arrays and the strings referenced by determined. The arrays and the strings referenced by
them need to be freed with the libc them need to be freed with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para> call after use. Note that instead of an empty array
NULL may be returned and should be considered
equivalent to an empty array.</para>
<para><function>sd_seat_can_multi_session()</function> <para><function>sd_seat_can_multi_session()</function>
may be used to determine whether a specific seat is may be used to determine whether a specific seat is
@ -143,7 +145,7 @@
<para> <para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para> </para>
</refsect1> </refsect1>

View File

@ -127,7 +127,7 @@
<para> <para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_pid_get_session</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_pid_get_session</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para> </para>
</refsect1> </refsect1>

View File

@ -126,10 +126,13 @@
identifiers in <parameter>sessions</parameter> which identifiers in <parameter>sessions</parameter> which
needs to be freed by the caller with the libc needs to be freed by the caller with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use, including all the strings referenced. If call after use, including all the strings
the string array parameter is passed as NULL the array referenced. If the string array parameter is passed as
will not be filled in, but the return code still NULL the array will not be filled in, but the return
indicates the number of current sessions.</para> code still indicates the number of current
sessions. Note that instead of an empty array NULL may
be returned and should be considered equivalent to an
empty array.</para>
<para>Similar, <function>sd_uid_get_seats()</function> <para>Similar, <function>sd_uid_get_seats()</function>
may be used to determine the list of seats on which may be used to determine the list of seats on which
@ -175,7 +178,7 @@
<para> <para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_pid_get_owner_uid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_pid_get_owner_uid</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para> </para>
</refsect1> </refsect1>