rtnl: match - only match on one type at a time

[elogind.git] / man / sd_get_seats.xml

diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml
index 2ac76500ec8dc409fb22a996a212e849d5b74f60..8254b7cae4de2f160260285259a521f7b63c4e37 100644 (file)
--- a/man/sd_get_seats.xml
+++ b/man/sd_get_seats.xml
@@ -8,20 +8,20 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  General Public License for more details.
+  Lesser General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_get_seats">
+<refentry id="sd_get_seats" conditional='HAVE_PAM'>
 
         <refentryinfo>
                 <title>sd_get_seats</title>
@@ -46,7 +46,8 @@
                 <refname>sd_get_seats</refname>
                 <refname>sd_get_sessions</refname>
                 <refname>sd_get_uids</refname>
-                <refpurpose>Determine available seats, sessions and logged in users</refpurpose>
+                <refname>sd_get_machine_names</refname>
+                <refpurpose>Determine available seats, sessions, logged in users and virtual machines/containers</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -65,7 +66,12 @@
 
                         <funcprototype>
                                 <funcdef>int <function>sd_get_uids</function></funcdef>
-                                <paramdef>char*** <parameter>sessions</parameter></paramdef>
+                                <paramdef>uid_t** <parameter>users</parameter></paramdef>
+                        </funcprototype>
+
+                        <funcprototype>
+                                <funcdef>int <function>sd_get_machine_names</function></funcdef>
+                                <paramdef>char*** <parameter>machines</parameter></paramdef>
                         </funcprototype>
 
                 </funcsynopsis>
@@ -76,12 +82,12 @@
 
                 <para><function>sd_get_seats()</function> may be used
                 to determine all currently available local
-                seats. Returns a NULL terminated array of seat
+                seats. Returns a <constant>NULL</constant> terminated array of seat
                 identifiers. The returned array and all strings it
                 references need to be freed with the libc
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use. Note that instead of an empty array
-                NULL may be returned and should be considered
+                <constant>NULL</constant> may be returned and should be considered
                 equivalent to an empty array.</para>
 
                 <para>Similar, <function>sd_get_sessions()</function> may
@@ -89,28 +95,36 @@
 
                 <para>Similar, <function>sd_get_uids()</function> may
                 be used to determine all Unix users who currently have login sessions.</para>
+
+                <para>Similar,
+                <function>sd_get_machine_names()</function> may be
+                used to determine all current virtual machines and
+                containers on the system.</para>
+
+                <para>Note that the returned lists are not sorted and in an undefined order.</para>
         </refsect1>
 
         <refsect1>
                 <title>Return Value</title>
 
                 <para>On success <function>sd_get_seats()</function>,
-                <function>sd_get_sessions()</function> and
-                <function>sd_get_uids()</function> return the number
-                of entries in the arrays. On failure, these calls
-                return a negative errno-style error code.</para>
+                <function>sd_get_sessions()</function>,
+                <function>sd_get_uids()</function> and
+                <function>sd_get_machine_names()</function> return the
+                number of entries in the arrays. On failure, these
+                calls return a negative errno-style error code.</para>
         </refsect1>
 
         <refsect1>
                 <title>Notes</title>
 
                 <para>The <function>sd_get_seats()</function>,
-                <function>sd_get_sessions()</function> and
-                <function>sd_get_uids()</function> interfaces
+                <function>sd_get_sessions()</function>,
+                <function>sd_get_uids()</function> and
+                <function>sd_get_machine_names()</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>
+                <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>
 
@@ -119,7 +133,7 @@
 
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 </para>
         </refsect1>