udev hwdb: Support shipping pre-compiled database in system images

[elogind.git] / man / sd_get_seats.xml

diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml
index 2ac76500ec8dc409fb22a996a212e849d5b74f60..76527c3f6fdbb4277fb9fcad1e137abb872e5b48 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
   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
   (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/>.
 -->
 
   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>
 
         <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>
                 <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>
         </refnamediv>
 
         <refsynopsisdiv>


@@ -55,17 +56,22 @@
 
                         <funcprototype>
                                 <funcdef>int <function>sd_get_seats</function></funcdef>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_get_seats</function></funcdef>

-                                <paramdef>char*** <parameter>seats</parameter></paramdef>
+                                <paramdef>char ***<parameter>seats</parameter></paramdef>

                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_get_sessions</function></funcdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_get_sessions</function></funcdef>

-                                <paramdef>char*** <parameter>sessions</parameter></paramdef>
+                                <paramdef>char ***<parameter>sessions</parameter></paramdef>

                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_get_uids</function></funcdef>
                         </funcprototype>
 
                         <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>
                         </funcprototype>
 
                 </funcsynopsis>


@@ -76,41 +82,49 @@
 
                 <para><function>sd_get_seats()</function> may be used
                 to determine all currently available local
 
                 <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
                 identifiers. The returned array and all strings it
                 references need to be freed with the libc

-                <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>

                 call after use. Note that instead of an empty array
                 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>
 
                 equivalent to an empty array.</para>
 

-                <para>Similar, <function>sd_get_sessions()</function> may
+                <para>Similarly, <function>sd_get_sessions()</function> may

                 be used to determine all current login sessions.</para>
 
                 be used to determine all current login sessions.</para>
 

-                <para>Similar, <function>sd_get_uids()</function> may
+                <para>Similarly, <function>sd_get_uids()</function> may

                 be used to determine all Unix users who currently have login sessions.</para>
                 be used to determine all Unix users who currently have login sessions.</para>

+
+                <para>Similarly,
+                <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>
 
         </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>
+                <para>On success, <function>sd_get_seats()</function>,
+                <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>,
         </refsect1>
 
         <refsect1>
                 <title>Notes</title>
 
                 <para>The <function>sd_get_seats()</function>,

-                <function>sd_get_sessions()</function> and
-                <function>sd_get_uids()</function> interfaces
-                are available as shared library, which can be compiled
+                <function>sd_get_sessions()</function>,
+                <function>sd_get_uids()</function> and
+                <function>sd_get_machine_names()</function> interfaces
+                are available as a shared library, which can be compiled

                 and linked to with the
                 and linked to with the

-                <literal>libsystemd-login</literal>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>

                 file.</para>
         </refsect1>
 
                 file.</para>
         </refsect1>
 


@@ -119,7 +133,7 @@
 
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 
                 <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>
                         <citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 </para>
         </refsect1>