Prep 229.9: Make all supportable API functions visible.

[elogind.git] / man / sd_booted.xml

diff --git a/man/sd_booted.xml b/man/sd_booted.xml
index d9c4013c04365a284103d7514b73c07427995a71..d6e9be16e096102b139fc16f47f00281950f9a8d 100644 (file)
--- a/man/sd_booted.xml
+++ b/man/sd_booted.xml
@@ -3,22 +3,22 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
+  This file is part of elogind.
 
-  Copyright 2010 Lennart Poettering
+  Copyright 2017 Sven Eden
 
-  systemd is free software; you can redistribute it and/or modify it
+  elogind 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
+  elogind 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/>.
+  along with elogind; If not, see <http://www.gnu.org/licenses/>.
 -->
 
 <refentry id="sd_booted"
@@ -26,14 +26,14 @@
 
   <refentryinfo>
     <title>sd_booted</title>
-    <productname>systemd</productname>
+    <productname>elogind</productname>
 
     <authorgroup>
       <author>
         <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
+        <firstname>Sven</firstname>
+        <surname>Eden</surname>
+        <email>sven.eden@gmx.de.net</email>
       </author>
     </authorgroup>
   </refentryinfo>
@@ -50,7 +50,7 @@
 
   <refsynopsisdiv>
     <funcsynopsis>
-      <funcsynopsisinfo>#include &lt;systemd/sd-daemon.h&gt;</funcsynopsisinfo>
+      <funcsynopsisinfo>#include &lt;elogind/sd-daemon.h&gt;</funcsynopsisinfo>
 
       <funcprototype>
         <funcdef>int <function>sd_booted</function></funcdef>
@@ -61,34 +61,21 @@
 
   <refsect1>
     <title>Description</title>
-    <para><function>sd_booted()</function> checks whether the system
-    was booted up using the systemd init system.</para>
+    <para><function>sd_booted()</function> is a compatibility function
+    that will always return 0. elogind is not meant to be used on systems
+    that are booted with systemd. Use systemd-login on such systems.</para>
   </refsect1>
 
   <refsect1>
     <title>Return Value</title>
 
-    <para>On failure, this call returns a negative errno-style error
-    code. If the system was booted up with systemd as init system,
-    this call returns a positive return value, zero otherwise.</para>
-  </refsect1>
-
-  <refsect1>
-    <title>Notes</title>
-
-    <xi:include href="libelogind-pkgconfig.xml" xpointer="pkgconfig-text"/>
-
-    <para>Internally, this function checks whether the directory
-    <filename>/run/systemd/system/</filename> exists. A simple check
-    like this can also be implemented trivially in shell or any other
-    language.</para>
+    <para>This function always returns zero.</para>
   </refsect1>
 
   <refsect1>
     <title>See Also</title>
     <para>
-      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
     </para>
   </refsect1>