man/systemd.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 General Public License as published by
  12   the Free Software Foundation; either version 2 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   General Public License for more details.
  19
  20   You should have received a copy of the GNU General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd">
  25
  26         <refentryinfo>
  27                 <title>systemd</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>systemd</refentrytitle>
  42                 <manvolnum>1</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd</refname>
  47                 <refpurpose>systemd System and Session Manager</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <cmdsynopsis>
  52                         <command>systemd <arg choice="opt" rep="repeat">OPTIONS</arg></command>
  53                 </cmdsynopsis>
  54                 <cmdsynopsis>
  55                         <command>init <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command>
  56                 </cmdsynopsis>
  57         </refsynopsisdiv>
  58
  59         <refsect1>
  60                 <title>Description</title>
  61
  62                 <para>systemd is a system and session manager for
  63                 Linux operating systems. When run as first process on
  64                 boot (as PID 1) it may act as init system that brings
  65                 up and maintains userspace.</para>
  66
  67                 <para>For compatibility with SysV if systemd is called
  68                 as <command>init</command> and a PID that is not
  69                 1 it will execute <command>telinit</command> and pass
  70                 all command line arguments unmodified. That means
  71                 <command>init</command> and <command>telinit</command>
  72                 are mostly equivalent when invoked from normal login sessions. See
  73                 <citerefentry><refentrytitle>telinit</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  74                 for more information.</para>
  75         </refsect1>
  76
  77         <refsect1>
  78                 <title>Options</title>
  79
  80                 <para>The following options are understood:</para>
  81
  82                 <variablelist>
  83                         <varlistentry>
  84                                 <term><option>-h</option></term>
  85                                 <term><option>--help</option></term>
  86
  87                                 <listitem><para>Prints a short help
  88                                 text and exits.</para></listitem>
  89                         </varlistentry>
  90                         <varlistentry>
  91                                 <term><option>--unit=</option></term>
  92
  93                                 <listitem><para>Set default unit to
  94                                 activate on startup. If not specified
  95                                 defaults to
  96                                 <filename>default.target</filename>.</para></listitem>
  97                         </varlistentry>
  98                         <varlistentry>
  99                                 <term><option>--running-as=</option></term>
 100
 101                                 <listitem><para>Tell systemd to run in
 102                                 a particular mode. Argument is one of
 103                                 <option>system</option>,
 104                                 <option>session</option>. Normally it
 105                                 should not be necessary to pass this
 106                                 option, as systemd automatically
 107                                 detects the mode it is started
 108                                 in. This call is hence of little use
 109                                 except for
 110                                 debugging.</para></listitem>
 111                         </varlistentry>
 112                         <varlistentry>
 113                                 <term><option>--test</option></term>
 114
 115                                 <listitem><para>Determine startup
 116                                 sequence, dump it and exit. This is an
 117                                 option useful for debugging
 118                                 only.</para></listitem>
 119                         </varlistentry>
 120                         <varlistentry>
 121                                 <term><option>--dump-configuration-items</option></term>
 122
 123                                 <listitem><para>Dump understood unit
 124                                 configuration items. This outputs a
 125                                 terse list of configuration items
 126                                 understood in unit definition
 127                                 files.</para></listitem>
 128                         </varlistentry>
 129                         <varlistentry>
 130                                 <term><option>--confirm-spawn</option></term>
 131
 132                                 <listitem><para>Ask for confirmation when spawning processes.</para></listitem>
 133                         </varlistentry>
 134                         <varlistentry>
 135                                 <term><option>--introspect=</option></term>
 136
 137                                 <listitem><para>Extract D-Bus
 138                                 interface introspection data. This is
 139                                 mostly useful at build ot install time
 140                                 to generate data suitable for the
 141                                 D-Bus interfaces
 142                                 repository. Optionally the interface
 143                                 name for the introspection data may be
 144                                 specified. If omitted the
 145                                 introspection data for all interfaces
 146                                 is dumped.</para></listitem>
 147                         </varlistentry>
 148                         <varlistentry>
 149                                 <term><option>--log-level=</option></term>
 150
 151                                 <listitem><para>Set log level. As
 152                                 argument this accepts a numerical log
 153                                 level or the well-known <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 154                                 symbolic names (lowercase):
 155                                 <option>emerg</option>,
 156                                 <option>alert</option>,
 157                                 <option>crit</option>,
 158                                 <option>err</option>,
 159                                 <option>warning</option>,
 160                                 <option>notice</option>,
 161                                 <option>info</option>,
 162                                 <option>debug</option>.</para></listitem>
 163                         </varlistentry>
 164                         <varlistentry>
 165                                 <term><option>--log-target=</option></term>
 166
 167                                 <listitem><para>Set log
 168                                 target. Argument must be one of
 169                                 <option>console</option>,
 170                                 <option>syslog</option>,
 171                                 <option>kmsg</option>,
 172                                 <option>syslog-or-kmsg</option>,
 173                                 <option>null</option>.</para></listitem>
 174                         </varlistentry>
 175                         <varlistentry>
 176                                 <term><option>--log-color=</option></term>
 177
 178                                 <listitem><para>Highlight important
 179                                 log messages. Argument is a boolean
 180                                 value. If the argument is omitted it
 181                                 defaults to
 182                                 <option>true</option>.</para></listitem>
 183                         </varlistentry>
 184                         <varlistentry>
 185                                 <term><option>--log-location=</option></term>
 186
 187                                 <listitem><para>Include code location
 188                                 in log messages. This is mostly
 189                                 relevant for debugging
 190                                 purposes. Argument is a boolean
 191                                 value. If the argument is omitted
 192                                 it defaults to
 193                                 <option>true</option>.</para></listitem>
 194                         </varlistentry>
 195
 196
 197                 </variablelist>
 198         </refsect1>
 199
 200         <refsect1>
 201                 <title>Directories</title>
 202         </refsect1>
 203
 204         <refsect1>
 205                 <title>Signal</title>
 206
 207                 <variablelist>
 208                         <varlistentry>
 209                                 <term><filename>SIGTERM</filename></term>
 210
 211                                 <listitem><para>systemd serializes its
 212                                 state, reexecutes itself and
 213                                 deserializes the saved state
 214                                 again. This is mostly equivalent to
 215                                 <command>systemctl
 216                                 daemon-reexec</command>.</para></listitem>
 217                         </varlistentry>
 218                 </variablelist>
 219         </refsect1>
 220
 221
 222         <refsect1>
 223                 <title>Sockets and FIFOs</title>
 224
 225                 <variablelist>
 226                         <varlistentry>
 227                                 <term><filename>@/org/freedesktop/systemd1/notify</filename></term>
 228
 229                                 <listitem><para>Daemon status
 230                                 notification socket. This is an AF_UNIX
 231                                 datagram socket in the Linux abstract
 232                                 namespace, and is used to implement
 233                                 the daemon notification logic as
 234                                 implemented by
 235                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
 236
 237                         </varlistentry>
 238
 239                         <varlistentry>
 240                                 <term><filename>@/org/freedesktop/systemd1/logger</filename></term>
 241
 242                                 <listitem><para>Used internally by the
 243                                 <filename>systemd-logger.service</filename>
 244                                 unit to connect STDOUT and/or STDERR
 245                                 of spawned processes to
 246                                 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 247                                 or the kernel log buffer. This is an
 248                                 AF_UNIX stream socket in the Linux
 249                                 abstract namespace.</para></listitem>
 250                         </varlistentry>
 251
 252                         <varlistentry>
 253                                 <term><filename>@/org/freedesktop/systemd1/private</filename></term>
 254
 255                                 <listitem><para>Used internally as
 256                                 communication channel between
 257                                 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 258                                 and the systemd process. This is an
 259                                 AF_UNIX stream socket in the Linux
 260                                 abstract namespace. This interface is
 261                                 private to systemd and should not be
 262                                 used in external
 263                                 projects.</para></listitem>
 264                         </varlistentry>
 265
 266                         <varlistentry>
 267                                 <term><filename>/dev/initctl</filename></term>
 268
 269                                 <listitem><para>Limited compatibility
 270                                 support for the SysV client interface,
 271                                 as implemented by the
 272                                 <filename>systemd-initctl.service</filename>
 273                                 unit. This is a named pipe in the file
 274                                 system. This interface is obsolete and
 275                                 should not be used in new
 276                                 applications.</para></listitem>
 277                         </varlistentry>
 278                 </variablelist>
 279         </refsect1>
 280
 281
 282         <refsect1>
 283                 <title>See Also</title>
 284                 <para>
 285                         <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 286                 </para>
 287         </refsect1>
 288
 289 </refentry>