chiark / gitweb /
man: xinclude --host/--machine
[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 systemd.
7
8   Copyright 2010 Lennart Poettering
9
10   systemd 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   systemd 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 systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="sd_booted">
25
26         <refentryinfo>
27                 <title>sd_booted</title>
28                 <productname>systemd</productname>
29
30                 <authorgroup>
31                         <author>
32                                 <contrib>Developer</contrib>
33                                 <firstname>Lennart</firstname>
34                                 <surname>Poettering</surname>
35                                 <email>lennart@poettering.net</email>
36                         </author>
37                 </authorgroup>
38         </refentryinfo>
39
40         <refmeta>
41                 <refentrytitle>sd_booted</refentrytitle>
42                 <manvolnum>3</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>sd_booted</refname>
47                 <refpurpose>Test whether the system is running the systemd init system</refpurpose>
48         </refnamediv>
49
50         <refsynopsisdiv>
51                 <funcsynopsis>
52                         <funcsynopsisinfo>#include &lt;systemd/sd-daemon.h&gt;</funcsynopsisinfo>
53
54                         <funcprototype>
55                                 <funcdef>int <function>sd_booted</function></funcdef>
56                                 <paramdef>void</paramdef>
57                         </funcprototype>
58                 </funcsynopsis>
59         </refsynopsisdiv>
60
61         <refsect1>
62                 <title>Description</title>
63                 <para><function>sd_booted()</function> checks whether
64                 the system was booted up using the systemd init system.</para>
65         </refsect1>
66
67         <refsect1>
68                 <title>Return Value</title>
69
70                 <para>On failure, this call returns a negative
71                 errno-style error code. If the system was booted up
72                 with systemd as init system, this call returns a
73                 positive return value, zero otherwise.</para>
74         </refsect1>
75
76         <refsect1>
77                 <title>Notes</title>
78
79                 <para>These APIs are implemented as a shared library,
80                 which can be compiled and linked to with the
81                 <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
82                 file.</para>
83
84                 <para>Internally, this function checks whether the
85                 directory <filename>/run/systemd/system/</filename>
86                 exists. A simple check like this can also be
87                 implemented trivially in shell or any other
88                 language.</para>
89
90         </refsect1>
91
92         <refsect1>
93                 <title>See Also</title>
94                 <para>
95                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
96                         <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
97                 </para>
98         </refsect1>
99
100 </refentry>