]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/sd_get_seats.xml
man: document sd_bus_message_get_bus() in sd_bus_message_new(3)
[thirdparty/systemd.git] / man / sd_get_seats.xml
index 37eb3fc8945047de89f780bacacd7021ded1b1f3..925516dc1df17fc2b82144d1bd907ad2ab398d7a 100644 (file)
@@ -3,38 +3,15 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
-
-  Copyright 2010 Lennart Poettering
-
-  systemd is free software; you can redistribute it and/or modify it
-  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
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+  SPDX-License-Identifier: LGPL-2.1+
 -->
 
-<refentry id="sd_get_seats" conditional='HAVE_PAM'>
+<refentry id="sd_get_seats" conditional='HAVE_PAM'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>sd_get_seats</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
     <title>Description</title>
 
     <para><function>sd_get_seats()</function> may be used to determine
-    all currently available local seats. Returns a
-    <constant>NULL</constant> terminated array of seat identifiers.
+    all currently available local seats. Returns the number of seat
+    identifiers and if the input pointer is non-NULL, a
+    <constant>NULL</constant>-terminated array of seat identifiers
+    is stored at the address.
     The returned array and all strings it references need to be freed
     with the libc
     <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     errno-style error code.</para>
   </refsect1>
 
-
   <refsect1>
     <title>Errors</title>
 
 
     <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
-
-        <listitem><para>An input parameter was invalid (out of range,
-        or NULL, where that is not accepted).</para></listitem>
-      </varlistentry>
-
       <varlistentry>
         <term><constant>-ENOMEM</constant></term>
 
     </variablelist>
   </refsect1>
 
-  <refsect1>
-    <title>Notes</title>
-
-    <para>The <function>sd_get_seats()</function>,
-    <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
-    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-    file.</para>
-  </refsect1>
+  <xi:include href="libsystemd-pkgconfig.xml" />
 
   <refsect1>
     <title>See Also</title>