tree-wide: drop 'This file is part of systemd' blurb

[elogind.git] / man / sd_uid_get_state.xml

diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml
index 4218f73818c0f12277b93a4f4b0d5ce1acf35ca4..4189f0c3d3751ff94740603ab6693af45113c9ad 100644 (file)
--- a/man/sd_uid_get_state.xml
+++ b/man/sd_uid_get_state.xml
@@ -3,25 +3,13 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
+  SPDX-License-Identifier: LGPL-2.1+
 
   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/>.
 -->
 
-<refentry id="sd_uid_get_state" conditional='HAVE_PAM'>
+<refentry id="sd_uid_get_state" conditional='HAVE_PAM'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>sd_uid_get_state</title>
@@ -170,27 +158,46 @@
   </refsect1>
 
   <refsect1>
-    <title>Notes</title>
+    <title>Errors</title>
 
-    <para>Functions described here are available as a shared library,
-    and can be compiled and linked to using the
-    <constant>libelogind</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-    entry.</para>
-  </refsect1>
+    <para>Returned errors may indicate the following problems:</para>
 
-  <refsect1>
-    <title>History</title>
+    <variablelist>
+
+      <varlistentry>
+        <term><constant>-ENODATA</constant></term>
 
-    <para><function>sd_uid_get_state()</function>,
-    <function>sd_uid_is_on_seat()</function>,
-    <function>sd_uid_get_sessions()</function>, and
-    <function>sd_uid_get_seats()</function> functions were added in
-    systemd-31.</para>
+        <listitem><para>The given field is not specified for the described
+        user.</para>
+        </listitem>
+      </varlistentry>
 
-    <para><function>sd_uid_get_display()</function> was added in
-    systemd-213.</para>
+      <varlistentry>
+        <term><constant>-ENXIO</constant></term>
+
+        <listitem><para>The specified seat is unknown.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>-EINVAL</constant></term>
+
+        <listitem><para>An input parameter was invalid (out of range,
+        or NULL, where that is not accepted). This is also returned if
+        the passed user ID is 0xFFFF or 0xFFFFFFFF, which are
+        undefined on Linux.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>-ENOMEM</constant></term>
+
+        <listitem><para>Memory allocation failed.</para></listitem>
+      </varlistentry>
+    </variablelist>
   </refsect1>
 
+  <xi:include href="libelogind-pkgconfig.xml" />
+
   <refsect1>
     <title>See Also</title>