chiark / gitweb /
Fix service file to match installed elogind binary location
[elogind.git] / man / sd_booted.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6   This file is part of elogind.
7
8   Copyright 2017 Sven Eden
9
10   elogind is free software; you can redistribute it and/or modify it
11   under the terms of the GNU Lesser General Public License as published by
12   the Free Software Foundation; either version 2.1 of the License, or
13   (at your option) any later version.
14
15   elogind is distributed in the hope that it will be useful, but
16   WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18   Lesser General Public License for more details.
19
20   You should have received a copy of the GNU Lesser General Public License
21   along with elogind; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="sd_booted"
25   xmlns:xi="http://www.w3.org/2001/XInclude">
26
27   <refentryinfo>
28     <title>sd_booted</title>
29     <productname>elogind</productname>
30
31     <authorgroup>
32       <author>
33         <contrib>Developer</contrib>
34         <firstname>Sven</firstname>
35         <surname>Eden</surname>
36         <email>sven.eden@gmx.de.net</email>
37       </author>
38     </authorgroup>
39   </refentryinfo>
40
41   <refmeta>
42     <refentrytitle>sd_booted</refentrytitle>
43     <manvolnum>3</manvolnum>
44   </refmeta>
45
46   <refnamediv>
47     <refname>sd_booted</refname>
48     <refpurpose>Test whether the system is running the systemd init system</refpurpose>
49   </refnamediv>
50
51   <refsynopsisdiv>
52     <funcsynopsis>
53       <funcsynopsisinfo>#include &lt;elogind/sd-daemon.h&gt;</funcsynopsisinfo>
54
55       <funcprototype>
56         <funcdef>int <function>sd_booted</function></funcdef>
57         <paramdef>void</paramdef>
58       </funcprototype>
59     </funcsynopsis>
60   </refsynopsisdiv>
61
62   <refsect1>
63     <title>Description</title>
64     <para><function>sd_booted()</function> is a compatibility function
65     that will always return 0. elogind is not meant to be used on systems
66     that are booted with systemd. Use systemd-login on such systems.</para>
67   </refsect1>
68
69   <refsect1>
70     <title>Return Value</title>
71
72     <para>This function always returns zero.</para>
73   </refsect1>
74
75   <refsect1>
76     <title>See Also</title>
77     <para>
78       <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
79     </para>
80   </refsect1>
81
82 </refentry>