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   xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>sd_booted</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Lennart</firstname>
  35         <surname>Poettering</surname>
  36         <email>lennart@poettering.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;systemd/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> checks whether the system
  65     was booted up using the systemd init system.</para>
  66   </refsect1>
  67
  68   <refsect1>
  69     <title>Return Value</title>
  70
  71     <para>On failure, this call returns a negative errno-style error
  72     code. If the system was booted up with systemd as init system,
  73     this call returns a positive return value, zero otherwise.</para>
  74   </refsect1>
  75
  76   <refsect1>
  77     <title>Notes</title>
  78
  79     <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
  80
  81     <para>Internally, this function checks whether the directory
  82     <filename>/run/systemd/system/</filename> exists. A simple check
  83     like this can also be implemented trivially in shell or any other
  84     language.</para>
  85   </refsect1>
  86
  87   <refsect1>
  88     <title>See Also</title>
  89     <para>
  90       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  91       <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
  92     </para>
  93   </refsect1>
  94
  95 </refentry>