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>8</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></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> | <option>--help</option></term>
  85
  86                                 <listitem><para>Prints a short help
  87                                 text and exits.</para></listitem>
  88                         </varlistentry>
  89                         <varlistentry>
  90                                 <term><option>--unit=</option></term>
  91
  92                                 <listitem><para>Set default unit to
  93                                 activate on startup. If not specified
  94                                 defaults to
  95                                 <filename>default.target</filename>.</para></listitem>
  96                         </varlistentry>
  97                         <varlistentry>
  98                                 <term><option>--running-as=</option></term>
  99
 100                                 <listitem><para>Tell systemd to run in
 101                                 a particular mode. Argument is one of
 102                                 <option>system</option>,
 103                                 <option>session</option>. Normally it
 104                                 should not be necessary to pass this
 105                                 option, as systemd automatically
 106                                 detects the mode it is started
 107                                 in. This call is hence of little use
 108                                 except for
 109                                 debugging.</para></listitem>
 110                         </varlistentry>
 111                         <varlistentry>
 112                                 <term><option>--test</option></term>
 113
 114                                 <listitem><para>Determine startup
 115                                 sequence, dump it and exit. This is an
 116                                 option useful for debugging
 117                                 only.</para></listitem>
 118                         </varlistentry>
 119                         <varlistentry>
 120                                 <term><option>--dump-configuration-items</option></term>
 121
 122                                 <listitem><para>Dump understood unit
 123                                 configuration items. This outputs a
 124                                 terse list of configuration items
 125                                 understood in unit definition
 126                                 files.</para></listitem>
 127                         </varlistentry>
 128                         <varlistentry>
 129                                 <term><option>--confirm-spawn</option></term>
 130
 131                                 <listitem><para>Ask for confirmation when spawning processes.</para></listitem>
 132                         </varlistentry>
 133                         <varlistentry>
 134                                 <term><option>--introspect=</option></term>
 135
 136                                 <listitem><para>Extract D-Bus
 137                                 interface introspection data. This is
 138                                 mostly useful at build ot install time
 139                                 to generate data suitable for the
 140                                 D-Bus interfaces
 141                                 repository. Optionally the interface
 142                                 name for the introspection data may be
 143                                 specified. If omitted the
 144                                 introspection data for all interfaces
 145                                 is dumped.</para></listitem>
 146                         </varlistentry>
 147                         <varlistentry>
 148                                 <term><option>--log-level=</option></term>
 149
 150                                 <listitem><para>Set log level. As
 151                                 argument this accepts a numerical log
 152                                 level or the well-known <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 153                                 symbolic names (lowercase):
 154                                 <option>emerg</option>,
 155                                 <option>alert</option>,
 156                                 <option>crit</option>,
 157                                 <option>err</option>,
 158                                 <option>warning</option>,
 159                                 <option>notice</option>,
 160                                 <option>info</option>,
 161                                 <option>debug</option>.</para></listitem>
 162                         </varlistentry>
 163                         <varlistentry>
 164                                 <term><option>--log-target=</option></term>
 165
 166                                 <listitem><para>Set log
 167                                 target. Argument must be one of
 168                                 <option>console</option>,
 169                                 <option>syslog</option>,
 170                                 <option>kmsg</option>,
 171                                 <option>syslog-or-kmsg</option>,
 172                                 <option>null</option>.</para></listitem>
 173                         </varlistentry>
 174                         <varlistentry>
 175                                 <term><option>--log-color=</option></term>
 176
 177                                 <listitem><para>Highlight important
 178                                 log messages. Argument is a boolean
 179                                 value. If the argument is omitted it
 180                                 defaults to
 181                                 <option>true</option>.</para></listitem>
 182                         </varlistentry>
 183                         <varlistentry>
 184                                 <term><option>--log-location=</option></term>
 185
 186                                 <listitem><para>Include code location
 187                                 in log messages. This is mostly
 188                                 relevant for debugging
 189                                 purposes. Argument is a boolean
 190                                 value. If the argument is omitted
 191                                 it defaults to
 192                                 <option>true</option>.</para></listitem>
 193                         </varlistentry>
 194
 195
 196                 </variablelist>
 197         </refsect1>
 198
 199         <refsect1>
 200                 <title>Sockets and FIFOs</title>
 201
 202                 <variablelist>
 203                         <varlistentry>
 204                                 <term><filename>@/org/freedesktop/systemd1/notify</filename></term>
 205
 206                                 <listitem><para>Daemon status
 207                                 notification socket. This is an AF_UNIX
 208                                 datagram socket in the Linux abstract
 209                                 namespace, and is used to implement
 210                                 the daemon notification logic as
 211                                 implemented by
 212                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
 213
 214                         </varlistentry>
 215
 216                         <varlistentry>
 217                                 <term><filename>@/org/freedesktop/systemd1/logger</filename></term>
 218
 219                                 <listitem><para>Used internally by the
 220                                 <filename>systemd-logger.service</filename>
 221                                 unit to connect STDOUT and/or STDERR
 222                                 of spawned processes to
 223                                 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 224                                 or the kernel log buffer. This is an
 225                                 AF_UNIX stream socket in the Linux
 226                                 abstract namespace.</para></listitem>
 227                         </varlistentry>
 228
 229                         <varlistentry>
 230                                 <term><filename>@/org/freedesktop/systemd1/private</filename></term>
 231
 232                                 <listitem><para>Used internally as
 233                                 communication channel between
 234                                 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 235                                 and the systemd process. This is an
 236                                 AF_UNIX stream socket in the Linux
 237                                 abstract namespace. This interface is
 238                                 private to systemd and should not be
 239                                 used in external
 240                                 projects.</para></listitem>
 241                         </varlistentry>
 242
 243                         <varlistentry>
 244                                 <term><filename>/dev/initctl</filename></term>
 245
 246                                 <listitem><para>Limited compatibility
 247                                 support for the SysV client interface,
 248                                 as implemented by the
 249                                 <filename>systemd-initctl.service</filename>
 250                                 unit. This is a named pipe in the file
 251                                 system. This interface is obsolete and
 252                                 should not be used in new
 253                                 applications.</para></listitem>
 254                         </varlistentry>
 255                 </variablelist>
 256         </refsect1>
 257
 258
 259         <refsect1>
 260                 <title>See Also</title>
 261                 <para>
 262                         <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 263                 </para>
 264         </refsect1>
 265
 266 </refentry>