man/systemctl.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="systemctl"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>systemctl</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>systemctl</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>systemctl</refname>
  48     <refpurpose>Control the systemd system and service manager</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <cmdsynopsis>
  53       <command>systemctl</command>
  54       <arg choice="opt" rep="repeat">OPTIONS</arg>
  55       <arg choice="plain">COMMAND</arg>
  56       <arg choice="opt" rep="repeat">NAME</arg>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59
  60   <refsect1>
  61     <title>Description</title>
  62
  63     <para><command>systemctl</command> may be used to
  64     introspect and control the state of the
  65     <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  66     system and service manager.</para>
  67   </refsect1>
  68
  69   <refsect1>
  70     <title>Options</title>
  71
  72     <para>The following options are understood:</para>
  73
  74     <variablelist>
  75       <varlistentry>
  76         <term><option>-t</option></term>
  77         <term><option>--type=</option></term>
  78
  79         <listitem>
  80           <para>The argument should be a comma-separated list of unit
  81           types such as <option>service</option> and
  82           <option>socket</option>.
  83           </para>
  84
  85           <para>If one of the arguments is a unit type, when listing
  86           units, limit display to certain unit types. Otherwise, units
  87           of all types will be shown.</para>
  88
  89           <para>As a special case, if one of the arguments is
  90           <option>help</option>, a list of allowed values will be
  91           printed and the program will exit.</para>
  92         </listitem>
  93       </varlistentry>
  94
  95       <varlistentry>
  96         <term><option>--state=</option></term>
  97
  98         <listitem>
  99         <para>The argument should be a comma-separated list of unit LOAD,
 100         SUB, or ACTIVE states. When listing units, show only those
 101         in specified states.</para>
 102         </listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term><option>-p</option></term>
 107         <term><option>--property=</option></term>
 108
 109         <listitem>
 110           <para>When showing unit/job/manager properties with the
 111           <command>show</command> command, limit display to certain
 112           properties as specified as argument. If not specified, all
 113           set properties are shown. The argument should be a
 114           comma-separated list of property names, such as
 115           <literal>MainPID</literal>. If specified more than once, all
 116           properties with the specified names are shown.</para>
 117         </listitem>
 118       </varlistentry>
 119
 120       <varlistentry>
 121         <term><option>-a</option></term>
 122         <term><option>--all</option></term>
 123
 124         <listitem>
 125           <para>When listing units, show all loaded units, regardless
 126           of their state, including inactive units. When showing
 127           unit/job/manager properties, show all properties regardless
 128           whether they are set or not.</para>
 129           <para>To list all units installed on the system, use the
 130           <command>list-unit-files</command> command instead.</para>
 131         </listitem>
 132       </varlistentry>
 133
 134       <varlistentry>
 135         <term><option>-r</option></term>
 136         <term><option>--recursive</option></term>
 137
 138         <listitem>
 139           <para>When listing units, also show units of local
 140           containers. Units of local containers will be prefixed with
 141           the container name, separated by a single colon character
 142           (<literal>:</literal>).</para>
 143         </listitem>
 144       </varlistentry>
 145
 146       <varlistentry>
 147         <term><option>--reverse</option></term>
 148
 149         <listitem>
 150           <para>Show reverse dependencies between units with
 151           <command>list-dependencies</command>, i.e. units with
 152           dependencies of type <varname>Wants=</varname> or
 153           <varname>Requires=</varname> on the given unit.
 154           </para>
 155         </listitem>
 156       </varlistentry>
 157
 158       <varlistentry>
 159         <term><option>--after</option></term>
 160
 161         <listitem>
 162           <para>With <command>list-dependencies</command>, show the
 163           units that are ordered before the specified unit. In other
 164           words, list the units that are in the <varname>After=</varname>
 165           directive of the specified unit, have the specified unit in
 166           their <varname>Before=</varname> directive, or are otherwise
 167           implicit dependencies of the specified unit.</para>
 168         </listitem>
 169       </varlistentry>
 170
 171       <varlistentry>
 172         <term><option>--before</option></term>
 173
 174         <listitem>
 175           <para>With <command>list-dependencies</command>, show the
 176           units that are ordered after the specified unit. In other
 177           words, list the units that are in the <varname>Before=</varname>
 178           directive of the specified unit, have the specified unit in
 179           their <varname>After=</varname> directive, or otherwise depend
 180           on the specified unit.</para>
 181         </listitem>
 182       </varlistentry>
 183
 184       <varlistentry>
 185         <term><option>-l</option></term>
 186         <term><option>--full</option></term>
 187
 188         <listitem>
 189           <para>Do not ellipsize unit names, process tree entries,
 190           journal output, or truncate unit descriptions in the output
 191           of <command>status</command>, <command>list-units</command>,
 192           <command>list-jobs</command>, and
 193           <command>list-timers</command>.</para>
 194         </listitem>
 195       </varlistentry>
 196
 197       <varlistentry>
 198         <term><option>--show-types</option></term>
 199
 200         <listitem>
 201           <para>When showing sockets, show the type of the socket.</para>
 202         </listitem>
 203       </varlistentry>
 204
 205       <varlistentry>
 206         <term><option>--job-mode=</option></term>
 207
 208         <listitem>
 209         <para>When queuing a new job, this option controls how to deal with
 210         already queued jobs. It takes one of <literal>fail</literal>,
 211         <literal>replace</literal>,
 212         <literal>replace-irreversibly</literal>,
 213         <literal>isolate</literal>,
 214         <literal>ignore-dependencies</literal>,
 215         <literal>ignore-requirements</literal> or
 216         <literal>flush</literal>. Defaults to
 217         <literal>replace</literal>, except when the
 218         <command>isolate</command> command is used which implies the
 219         <literal>isolate</literal> job mode.</para>
 220
 221         <para>If <literal>fail</literal> is specified and a requested
 222         operation conflicts with a pending job (more specifically:
 223         causes an already pending start job to be reversed into a stop
 224         job or vice versa), cause the operation to fail.</para>
 225
 226         <para>If <literal>replace</literal> (the default) is
 227         specified, any conflicting pending job will be replaced, as
 228         necessary.</para>
 229
 230         <para>If <literal>replace-irreversibly</literal> is specified,
 231         operate like <literal>replace</literal>, but also mark the new
 232         jobs as irreversible. This prevents future conflicting
 233         transactions from replacing these jobs (or even being enqueued
 234         while the irreversible jobs are still pending). Irreversible
 235         jobs can still be cancelled using the <command>cancel</command>
 236         command.</para>
 237
 238         <para><literal>isolate</literal> is only valid for start
 239         operations and causes all other units to be stopped when the
 240         specified unit is started. This mode is always used when the
 241         <command>isolate</command> command is used.</para>
 242
 243         <para><literal>flush</literal> will cause all queued jobs to
 244         be canceled when the new job is enqueued.</para>
 245
 246         <para>If <literal>ignore-dependencies</literal> is specified,
 247         then all unit dependencies are ignored for this new job and
 248         the operation is executed immediately. If passed, no required
 249         units of the unit passed will be pulled in, and no ordering
 250         dependencies will be honored. This is mostly a debugging and
 251         rescue tool for the administrator and should not be used by
 252         applications.</para>
 253
 254         <para><literal>ignore-requirements</literal> is similar to
 255         <literal>ignore-dependencies</literal>, but only causes the
 256         requirement dependencies to be ignored, the ordering
 257         dependencies will still be honoured.</para>
 258         </listitem>
 259
 260       </varlistentry>
 261
 262       <varlistentry>
 263         <term><option>-i</option></term>
 264         <term><option>--ignore-inhibitors</option></term>
 265
 266         <listitem>
 267           <para>When system shutdown or a sleep state is requested,
 268           ignore inhibitor locks. Applications can establish inhibitor
 269           locks to avoid that certain important operations (such as CD
 270           burning or suchlike) are interrupted by system shutdown or a
 271           sleep state. Any user may take these locks and privileged
 272           users may override these locks. If any locks are taken,
 273           shutdown and sleep state requests will normally fail
 274           (regardless of whether privileged or not) and a list of active locks
 275           is printed. However, if <option>--ignore-inhibitors</option>
 276           is specified, the locks are ignored and not printed, and the
 277           operation attempted anyway, possibly requiring additional
 278           privileges.</para>
 279         </listitem>
 280       </varlistentry>
 281
 282       <varlistentry>
 283         <term><option>-q</option></term>
 284         <term><option>--quiet</option></term>
 285
 286         <listitem>
 287           <para>Suppress output to standard output in
 288           <command>snapshot</command>,
 289           <command>is-active</command>,
 290           <command>is-failed</command>,
 291           <command>enable</command> and
 292         <command>disable</command>.</para>
 293         </listitem>
 294       </varlistentry>
 295
 296       <varlistentry>
 297         <term><option>--no-block</option></term>
 298
 299         <listitem>
 300           <para>Do not synchronously wait for the requested operation
 301           to finish. If this is not specified, the job will be
 302           verified, enqueued and <command>systemctl</command> will
 303           wait until it is completed. By passing this argument, it is
 304           only verified and enqueued.</para>
 305         </listitem>
 306       </varlistentry>
 307
 308       <varlistentry>
 309         <term><option>--no-legend</option></term>
 310
 311         <listitem>
 312           <para>Do not print the legend, i.e. the column headers and
 313           the footer with hints.</para>
 314         </listitem>
 315       </varlistentry>
 316
 317       <xi:include href="user-system-options.xml" xpointer="user" />
 318       <xi:include href="user-system-options.xml" xpointer="system" />
 319
 320       <varlistentry>
 321         <term><option>--no-wall</option></term>
 322
 323         <listitem>
 324           <para>Do not send wall message before halt, power-off,
 325           reboot.</para>
 326         </listitem>
 327       </varlistentry>
 328
 329       <varlistentry>
 330         <term><option>--global</option></term>
 331
 332         <listitem>
 333           <para>When used with <command>enable</command> and
 334           <command>disable</command>, operate on the global user
 335           configuration directory, thus enabling or disabling a unit
 336           file globally for all future logins of all users.</para>
 337         </listitem>
 338       </varlistentry>
 339
 340       <varlistentry>
 341         <term><option>--no-reload</option></term>
 342
 343         <listitem>
 344           <para>When used with <command>enable</command> and
 345           <command>disable</command>, do not implicitly reload daemon
 346           configuration after executing the changes.</para>
 347         </listitem>
 348       </varlistentry>
 349
 350       <varlistentry>
 351         <term><option>--no-ask-password</option></term>
 352
 353         <listitem>
 354           <para>When used with <command>start</command> and related
 355           commands, disables asking for passwords. Background services
 356           may require input of a password or passphrase string, for
 357           example to unlock system hard disks or cryptographic
 358           certificates. Unless this option is specified and the
 359           command is invoked from a terminal,
 360           <command>systemctl</command> will query the user on the
 361           terminal for the necessary secrets. Use this option to
 362           switch this behavior off. In this case, the password must be
 363           supplied by some other means (for example graphical password
 364           agents) or the service might fail. This also disables
 365           querying the user for authentication for privileged
 366           operations.</para>
 367         </listitem>
 368
 369       </varlistentry>
 370
 371       <varlistentry>
 372         <term><option>--kill-who=</option></term>
 373
 374         <listitem>
 375           <para>When used with <command>kill</command>, choose which
 376           processes to send a signal to. Must be one of
 377           <option>main</option>, <option>control</option> or
 378           <option>all</option> to select whether to kill only the main
 379           process, the control process or all processes of the
 380           unit. The main process of the unit is the one that defines
 381           the life-time of it. A control process of a unit is one that
 382           is invoked by the manager to induce state changes of it. For
 383           example, all processes started due to the
 384           <varname>ExecStartPre=</varname>,
 385           <varname>ExecStop=</varname> or
 386           <varname>ExecReload=</varname> settings of service units are
 387           control processes. Note that there is only one control
 388           process per unit at a time, as only one state change is
 389           executed at a time. For services of type
 390           <varname>Type=forking</varname>, the initial process started
 391           by the manager for <varname>ExecStart=</varname> is a
 392           control process, while the process ultimately forked off by
 393           that one is then considered the main process of the unit (if
 394           it can be determined). This is different for service units
 395           of other types, where the process forked off by the manager
 396           for <varname>ExecStart=</varname> is always the main process
 397           itself. A service unit consists of zero or one main process,
 398           zero or one control process plus any number of additional
 399           processes. Not all unit types manage processes of these
 400           types however. For example, for mount units, control processes
 401           are defined (which are the invocations of
 402           <filename>/usr/bin/mount</filename> and
 403           <filename>/usr/bin/umount</filename>), but no main process
 404           is defined. If omitted, defaults to
 405           <option>all</option>.</para>
 406         </listitem>
 407
 408       </varlistentry>
 409
 410       <varlistentry>
 411         <term><option>-s</option></term>
 412         <term><option>--signal=</option></term>
 413
 414         <listitem>
 415           <para>When used with <command>kill</command>, choose which
 416           signal to send to selected processes. Must be one of the
 417           well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
 418           <constant>SIGSTOP</constant>. If omitted, defaults to
 419           <option>SIGTERM</option>.</para>
 420         </listitem>
 421       </varlistentry>
 422
 423       <varlistentry>
 424         <term><option>-f</option></term>
 425         <term><option>--force</option></term>
 426
 427         <listitem>
 428           <para>When used with <command>enable</command>, overwrite
 429           any existing conflicting symlinks.</para>
 430
 431           <para>When used with <command>halt</command>,
 432           <command>poweroff</command>, <command>reboot</command> or
 433           <command>kexec</command>, execute the selected operation
 434           without shutting down all units. However, all processes will
 435           be killed forcibly and all file systems are unmounted or
 436           remounted read-only. This is hence a drastic but relatively
 437           safe option to request an immediate reboot. If
 438           <option>--force</option> is specified twice for these
 439           operations, they will be executed immediately without
 440           terminating any processes or unmounting any file
 441           systems. Warning: specifying <option>--force</option> twice
 442           with any of these operations might result in data
 443           loss.</para>
 444         </listitem>
 445       </varlistentry>
 446
 447       <varlistentry>
 448         <term><option>--root=</option></term>
 449
 450         <listitem>
 451           <para>When used with
 452           <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
 453           (and related commands), use alternative root path when
 454           looking for unit files.</para>
 455         </listitem>
 456
 457       </varlistentry>
 458
 459       <varlistentry>
 460         <term><option>--runtime</option></term>
 461
 462         <listitem>
 463           <para>When used with <command>enable</command>,
 464           <command>disable</command>,
 465           (and related commands), make changes only temporarily, so
 466           that they are lost on the next reboot. This will have the
 467           effect that changes are not made in subdirectories of
 468           <filename>/etc</filename> but in <filename>/run</filename>,
 469           with identical immediate effects, however, since the latter
 470           is lost on reboot, the changes are lost too.</para>
 471
 472           <para>Similarly, when used with
 473           <command>set-property</command>, make changes only
 474           temporarily, so that they are lost on the next
 475           reboot.</para>
 476         </listitem>
 477       </varlistentry>
 478
 479       <varlistentry>
 480         <term><option>-n</option></term>
 481         <term><option>--lines=</option></term>
 482
 483         <listitem>
 484           <para>When used with <command>status</command>, controls the
 485           number of journal lines to show, counting from the most
 486           recent ones. Takes a positive integer argument. Defaults to
 487           10.</para>
 488         </listitem>
 489       </varlistentry>
 490
 491       <varlistentry>
 492         <term><option>-o</option></term>
 493         <term><option>--output=</option></term>
 494
 495         <listitem>
 496           <para>When used with <command>status</command>, controls the
 497           formatting of the journal entries that are shown. For the
 498           available choices, see
 499           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 500           Defaults to <literal>short</literal>.</para>
 501         </listitem>
 502       </varlistentry>
 503
 504       <varlistentry>
 505         <term><option>--plain</option></term>
 506
 507         <listitem>
 508           <para>When used with <command>list-dependencies</command>,
 509           the output is printed as a list instead of a tree.</para>
 510         </listitem>
 511       </varlistentry>
 512
 513       <xi:include href="user-system-options.xml" xpointer="host" />
 514       <xi:include href="user-system-options.xml" xpointer="machine" />
 515
 516       <xi:include href="standard-options.xml" xpointer="help" />
 517       <xi:include href="standard-options.xml" xpointer="version" />
 518       <xi:include href="standard-options.xml" xpointer="no-pager" />
 519     </variablelist>
 520   </refsect1>
 521
 522   <refsect1>
 523     <title>Commands</title>
 524
 525     <para>The following commands are understood:</para>
 526
 527     <refsect2>
 528       <title>Unit Commands</title>
 529
 530       <variablelist>
 531         <varlistentry>
 532           <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
 533
 534           <listitem>
 535             <para>List known units (subject to limitations specified
 536             with <option>-t</option>). If one or more
 537             <replaceable>PATTERN</replaceable>s are specified, only
 538             units matching one of them are shown.</para>
 539
 540             <para>This is the default command.</para>
 541           </listitem>
 542         </varlistentry>
 543
 544         <varlistentry>
 545           <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
 546
 547           <listitem>
 548             <para>List socket units ordered by listening address.
 549             If one or more <replaceable>PATTERN</replaceable>s are
 550             specified, only socket units matching one of them are
 551             shown. Produces output similar to
 552             <programlisting>
 553 LISTEN           UNIT                        ACTIVATES
 554 /dev/initctl     systemd-initctl.socket      systemd-initctl.service
 555 ...
 556 [::]:22          sshd.socket                 sshd.service
 557 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 558
 559 5 sockets listed.</programlisting>
 560             Note: because the addresses might contains spaces, this output
 561             is not suitable for programmatic consumption.
 562             </para>
 563
 564             <para>See also the options <option>--show-types</option>,
 565             <option>--all</option>, and <option>--failed</option>.</para>
 566           </listitem>
 567         </varlistentry>
 568
 569         <varlistentry>
 570           <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
 571
 572           <listitem>
 573             <para>List timer units ordered by the time they elapse
 574             next. If one or more <replaceable>PATTERN</replaceable>s
 575             are specified, only units matching one of them are shown.
 576             </para>
 577
 578             <para>See also the options <option>--all</option> and
 579             <option>--failed</option>.</para>
 580           </listitem>
 581         </varlistentry>
 582
 583         <varlistentry>
 584           <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
 585
 586           <listitem>
 587             <para>Start (activate) one or more units specified on the
 588             command line.</para>
 589
 590             <para>Note that glob patterns operate on a list of currently
 591             loaded units. Units which are not active and are not in a
 592             failed state usually are not loaded, and would not be
 593             matched by any pattern. In addition, in case of
 594             instantiated units, systemd is often unaware of the
 595             instance name until the instance has been started. Therefore,
 596             using glob patterns with <command>start</command>
 597             has limited usefulness.</para>
 598           </listitem>
 599         </varlistentry>
 600         <varlistentry>
 601           <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
 602
 603           <listitem>
 604             <para>Stop (deactivate) one or more units specified on the
 605             command line.</para>
 606           </listitem>
 607         </varlistentry>
 608         <varlistentry>
 609           <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
 610
 611           <listitem>
 612             <para>Asks all units listed on the command line to reload
 613             their configuration. Note that this will reload the
 614             service-specific configuration, not the unit configuration
 615             file of systemd. If you want systemd to reload the
 616             configuration file of a unit, use the
 617             <command>daemon-reload</command> command. In other words:
 618             for the example case of Apache, this will reload Apache's
 619             <filename>httpd.conf</filename> in the web server, not the
 620             <filename>apache.service</filename> systemd unit
 621             file.</para>
 622
 623             <para>This command should not be confused with the
 624             <command>daemon-reload</command> or <command>load</command>
 625             commands.</para>
 626           </listitem>
 627
 628         </varlistentry>
 629         <varlistentry>
 630           <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
 631
 632           <listitem>
 633             <para>Restart one or more units specified on the command
 634             line. If the units are not running yet, they will be
 635             started.</para>
 636           </listitem>
 637         </varlistentry>
 638         <varlistentry>
 639           <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
 640
 641           <listitem>
 642             <para>Restart one or more units specified on the command
 643             line if the units are running. This does nothing if units are not
 644             running.  Note that, for compatibility with Red Hat init
 645             scripts, <command>condrestart</command> is equivalent to this
 646             command.</para>
 647           </listitem>
 648         </varlistentry>
 649         <varlistentry>
 650           <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
 651
 652           <listitem>
 653             <para>Reload one or more units if they support it. If not,
 654             restart them instead. If the units are not running yet, they
 655             will be started.</para>
 656           </listitem>
 657         </varlistentry>
 658         <varlistentry>
 659           <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
 660
 661           <listitem>
 662             <para>Reload one or more units if they support it. If not,
 663             restart them instead. This does nothing if the units are not
 664             running. Note that, for compatibility with SysV init scripts,
 665             <command>force-reload</command> is equivalent to this
 666             command.</para>
 667           </listitem>
 668         </varlistentry>
 669         <varlistentry>
 670           <term><command>isolate <replaceable>NAME</replaceable></command></term>
 671
 672           <listitem>
 673             <para>Start the unit specified on the command line and its
 674             dependencies and stop all others.</para>
 675
 676             <para>This is similar to changing the runlevel in a
 677             traditional init system. The <command>isolate</command>
 678             command will immediately stop processes that are not enabled
 679             in the new unit, possibly including the graphical
 680             environment or terminal you are currently using.</para>
 681
 682             <para>Note that this is allowed only on units where
 683             <option>AllowIsolate=</option> is enabled. See
 684             <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 685             for details.</para>
 686           </listitem>
 687         </varlistentry>
 688         <varlistentry>
 689           <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
 690
 691           <listitem>
 692             <para>Send a signal to one or more processes of the
 693             unit. Use <option>--kill-who=</option> to select which
 694             process to kill. Use <option>--signal=</option> to select
 695             the signal to send.</para>
 696           </listitem>
 697         </varlistentry>
 698         <varlistentry>
 699           <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
 700
 701           <listitem>
 702             <para>Check whether any of the specified units are active
 703             (i.e. running). Returns an exit code
 704             <constant>0</constant> if at least one is active, or
 705             non-zero otherwise. Unless <option>--quiet</option> is
 706             specified, this will also print the current unit state to
 707             standard output.</para>
 708           </listitem>
 709         </varlistentry>
 710         <varlistentry>
 711           <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
 712
 713           <listitem>
 714             <para>Check whether any of the specified units are in a
 715             "failed" state. Returns an exit code
 716             <constant>0</constant> if at least one has failed,
 717             non-zero otherwise. Unless <option>--quiet</option> is
 718             specified, this will also print the current unit state to
 719             standard output.</para>
 720           </listitem>
 721         </varlistentry>
 722         <varlistentry>
 723           <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
 724
 725           <listitem>
 726             <para>Show terse runtime status information about one or
 727             more units, followed by most recent log data from the
 728             journal. If no units are specified, show system status. If
 729             combined with <option>--all</option>, also show the status of
 730             all units (subject to limitations specified with
 731             <option>-t</option>). If a PID is passed, show information
 732             about the unit the process belongs to.</para>
 733
 734             <para>This function is intended to generate human-readable
 735             output. If you are looking for computer-parsable output,
 736             use <command>show</command> instead. By default this
 737             function only shows 10 lines of output and ellipsizes
 738             lines to fit in the terminal window. This can be changes
 739             with <option>--lines</option> and <option>--full</option>,
 740             see above. In addition, <command>journalctl
 741             --unit=<replaceable>NAME</replaceable></command> or
 742             <command>journalctl
 743             --user-unit=<replaceable>NAME</replaceable></command> use
 744             a similar filter for messages and might be more
 745             convenient.
 746             </para>
 747           </listitem>
 748         </varlistentry>
 749         <varlistentry>
 750           <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
 751
 752           <listitem>
 753             <para>Show properties of one or more units, jobs, or the
 754             manager itself. If no argument is specified, properties of
 755             the manager will be shown. If a unit name is specified,
 756             properties of the unit is shown, and if a job id is
 757             specified, properties of the job is shown. By default, empty
 758             properties are suppressed. Use <option>--all</option> to
 759             show those too. To select specific properties to show, use
 760             <option>--property=</option>. This command is intended to be
 761             used whenever computer-parsable output is required. Use
 762             <command>status</command> if you are looking for formatted
 763             human-readable output.</para>
 764           </listitem>
 765         </varlistentry>
 766         <varlistentry>
 767           <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
 768
 769           <listitem>
 770             <para>Show backing files of one or more units. Prints the
 771             "fragment" and "drop-ins" (source files) of units. Each
 772             file is preceded by a comment which includes the file
 773             name.</para>
 774           </listitem>
 775         </varlistentry>
 776         <varlistentry>
 777           <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
 778
 779           <listitem>
 780             <para>Set the specified unit properties at runtime where
 781             this is supported. This allows changing configuration
 782             parameter properties such as resource control settings at
 783             runtime. Not all properties may be changed at runtime, but
 784             many resource control settings (primarily those in
 785             <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
 786             may. The changes are applied instantly, and stored on disk
 787             for future boots, unless <option>--runtime</option> is
 788             passed, in which case the settings only apply until the
 789             next reboot. The syntax of the property assignment follows
 790             closely the syntax of assignments in unit files.</para>
 791
 792             <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
 793
 794             <para>Note that this command allows changing multiple
 795             properties at the same time, which is preferable over
 796             setting them individually. Like unit file configuration
 797             settings, assigning the empty list to list parameters will
 798             reset the list.</para>
 799           </listitem>
 800         </varlistentry>
 801
 802         <varlistentry>
 803           <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
 804
 805           <listitem>
 806             <para>Show manual pages for one or more units, if
 807             available. If a PID is given, the manual pages for the unit
 808             the process belongs to are shown.</para>
 809           </listitem>
 810         </varlistentry>
 811
 812         <varlistentry>
 813           <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
 814
 815           <listitem>
 816             <para>Reset the <literal>failed</literal> state of the
 817             specified units, or if no unit name is passed, reset the state of all
 818             units. When a unit fails in some way (i.e. process exiting
 819             with non-zero error code, terminating abnormally or timing
 820             out), it will automatically enter the
 821             <literal>failed</literal> state and its exit code and status
 822             is recorded for introspection by the administrator until the
 823             service is restarted or reset with this command.</para>
 824           </listitem>
 825         </varlistentry>
 826
 827         <varlistentry>
 828           <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
 829
 830           <listitem>
 831             <para>Shows required and wanted units of the specified
 832             unit. If no unit is specified,
 833             <filename>default.target</filename> is implied. Target units
 834             are recursively expanded.  When <option>--all</option> is
 835             passed, all other units are recursively expanded as
 836             well.</para>
 837           </listitem>
 838         </varlistentry>
 839       </variablelist>
 840     </refsect2>
 841
 842     <refsect2>
 843       <title>Unit File Commands</title>
 844
 845       <variablelist>
 846         <varlistentry>
 847           <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
 848
 849           <listitem>
 850             <para>List installed unit files. If one or more
 851             <replaceable>PATTERN</replaceable>s are specified, only
 852             units whose filename (just the last component of the path)
 853             matches one of them are shown.</para>
 854           </listitem>
 855         </varlistentry>
 856
 857         <varlistentry>
 858           <term><command>enable <replaceable>NAME</replaceable>...</command></term>
 859
 860           <listitem>
 861             <para>Enable one or more unit files or unit file instances,
 862             as specified on the command line. This will create a number
 863             of symlinks as encoded in the <literal>[Install]</literal>
 864             sections of the unit files. After the symlinks have been
 865             created, the systemd configuration is reloaded (in a way that
 866             is equivalent to <command>daemon-reload</command>) to ensure
 867             the changes are taken into account immediately. Note that
 868             this does <emphasis>not</emphasis> have the effect of also
 869             starting any of the units being enabled. If this
 870             is desired, a separate <command>start</command> command must
 871             be invoked for the unit. Also note that in case of instance
 872             enablement, symlinks named the same as instances are created in
 873             the install location, however they all point to the same
 874             template unit file.</para>
 875
 876             <para>This command will print the actions executed. This
 877             output may be suppressed by passing <option>--quiet</option>.
 878             </para>
 879
 880             <para>Note that this operation creates only the suggested
 881             symlinks for the units. While this command is the
 882             recommended way to manipulate the unit configuration
 883             directory, the administrator is free to make additional
 884             changes manually by placing or removing symlinks in the
 885             directory. This is particularly useful to create
 886             configurations that deviate from the suggested default
 887             installation. In this case, the administrator must make sure
 888             to invoke <command>daemon-reload</command> manually as
 889             necessary to ensure the changes are taken into account.
 890             </para>
 891
 892             <para>Enabling units should not be confused with starting
 893             (activating) units, as done by the <command>start</command>
 894             command. Enabling and starting units is orthogonal: units
 895             may be enabled without being started and started without
 896             being enabled. Enabling simply hooks the unit into various
 897             suggested places (for example, so that the unit is
 898             automatically started on boot or when a particular kind of
 899             hardware is plugged in). Starting actually spawns the daemon
 900             process (in case of service units), or binds the socket (in
 901             case of socket units), and so on.</para>
 902
 903             <para>Depending on whether <option>--system</option>,
 904             <option>--user</option>, <option>--runtime</option>,
 905             or <option>--global</option> is specified, this enables the unit
 906             for the system, for the calling user only, for only this boot of
 907             the system, or for all future logins of all users, or only this
 908             boot.  Note that in the last case, no systemd daemon
 909             configuration is reloaded.</para>
 910           </listitem>
 911         </varlistentry>
 912
 913         <varlistentry>
 914           <term><command>disable <replaceable>NAME</replaceable>...</command></term>
 915
 916           <listitem>
 917             <para>Disables one or more units. This removes all symlinks
 918             to the specified unit files from the unit configuration
 919             directory, and hence undoes the changes made by
 920             <command>enable</command>. Note however that this removes
 921             all symlinks to the unit files (i.e. including manual
 922             additions), not just those actually created by
 923             <command>enable</command>. This call implicitly reloads the
 924             systemd daemon configuration after completing the disabling
 925             of the units. Note that this command does not implicitly
 926             stop the units that are being disabled. If this is desired,
 927             an additional <command>stop</command> command should be
 928             executed afterwards.</para>
 929
 930             <para>This command will print the actions executed. This
 931             output may be suppressed by passing <option>--quiet</option>.
 932             </para>
 933
 934             <para>This command honors <option>--system</option>,
 935             <option>--user</option>, <option>--runtime</option> and
 936             <option>--global</option> in a similar way as
 937             <command>enable</command>.</para>
 938           </listitem>
 939         </varlistentry>
 940
 941         <varlistentry>
 942           <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
 943
 944           <listitem>
 945             <para>Checks whether any of the specified unit files are
 946             enabled (as with <command>enable</command>). Returns an
 947             exit code of 0 if at least one is enabled, non-zero
 948             otherwise. Prints the current enable status (see table).
 949             To suppress this output, use <option>--quiet</option>.
 950             </para>
 951
 952             <table>
 953               <title>
 954                 <command>is-enabled</command> output
 955               </title>
 956
 957               <tgroup cols='3'>
 958                 <thead>
 959                   <row>
 960                     <entry>Printed string</entry>
 961                     <entry>Meaning</entry>
 962                     <entry>Return value</entry>
 963                   </row>
 964                 </thead>
 965                 <tbody>
 966                   <row>
 967                     <entry><literal>enabled</literal></entry>
 968                     <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
 969                     <entry morerows='1'>0</entry>
 970                   </row>
 971                   <row>
 972                     <entry><literal>enabled-runtime</literal></entry>
 973                   </row>
 974                   <row>
 975                     <entry><literal>linked</literal></entry>
 976                     <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
 977                     <entry morerows='1'>1</entry>
 978                   </row>
 979                   <row>
 980                     <entry><literal>linked-runtime</literal></entry>
 981                   </row>
 982                   <row>
 983                     <entry><literal>masked</literal></entry>
 984                     <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
 985                     <entry morerows='1'>1</entry>
 986                   </row>
 987                   <row>
 988                     <entry><literal>masked-runtime</literal></entry>
 989                   </row>
 990                   <row>
 991                     <entry><literal>static</literal></entry>
 992                     <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
 993                     <entry>0</entry>
 994                   </row>
 995                   <row>
 996                     <entry><literal>disabled</literal></entry>
 997                     <entry>Unit is not enabled</entry>
 998                     <entry>1</entry>
 999                   </row>
1000                 </tbody>
1001               </tgroup>
1002             </table>
1003
1004           </listitem>
1005         </varlistentry>
1006
1007         <varlistentry>
1008           <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
1009
1010           <listitem>
1011             <para>Reenable one or more unit files, as specified on the
1012             command line. This is a combination of
1013             <command>disable</command> and <command>enable</command> and
1014             is useful to reset the symlinks a unit is enabled with to
1015             the defaults configured in the <literal>[Install]</literal>
1016             section of the unit file.</para>
1017           </listitem>
1018         </varlistentry>
1019
1020         <varlistentry>
1021           <term><command>preset <replaceable>NAME</replaceable>...</command></term>
1022
1023           <listitem>
1024             <para>Reset one or more unit files, as specified on the
1025             command line, to the defaults configured in the preset
1026             policy files. This has the same effect as
1027             <command>disable</command> or <command>enable</command>,
1028             depending how the unit is listed in the preset files. For
1029             more information on the preset policy format, see
1030             <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1031             For more information on the concept of presets, please
1032             consult the
1033             <ulink url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1034             document.</para>
1035           </listitem>
1036         </varlistentry>
1037
1038         <varlistentry>
1039           <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1040
1041           <listitem>
1042             <para>Mask one or more unit files, as specified on the
1043             command line. This will link these units to
1044             <filename>/dev/null</filename>, making it impossible to
1045             start them. This is a stronger version of
1046             <command>disable</command>, since it prohibits all kinds of
1047             activation of the unit, including manual activation. Use
1048             this option with care. This honors the
1049             <option>--runtime</option> option to only mask temporarily
1050             until the next reboot of the system.</para>
1051           </listitem>
1052         </varlistentry>
1053
1054         <varlistentry>
1055           <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1056
1057           <listitem>
1058             <para>Unmask one or more unit files, as specified on the
1059             command line. This will undo the effect of
1060             <command>mask</command>.</para>
1061           </listitem>
1062         </varlistentry>
1063
1064         <varlistentry>
1065           <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1066
1067           <listitem>
1068             <para>Link a unit file that is not in the unit file search
1069             paths into the unit file search path. This requires an
1070             absolute path to a unit file. The effect of this can be
1071             undone with <command>disable</command>. The effect of this
1072             command is that a unit file is available for
1073             <command>start</command> and other commands although it
1074             is not installed directly in the unit search path.</para>
1075           </listitem>
1076         </varlistentry>
1077
1078         <varlistentry>
1079           <term><command>get-default</command></term>
1080
1081           <listitem>
1082             <para>Get the default target specified
1083             via <filename>default.target</filename> link.</para>
1084           </listitem>
1085         </varlistentry>
1086
1087         <varlistentry>
1088           <term><command>set-default <replaceable>NAME</replaceable></command></term>
1089
1090           <listitem>
1091             <para>Set the default target to boot into. Command links
1092             <filename>default.target</filename> to the given unit.</para>
1093           </listitem>
1094         </varlistentry>
1095       </variablelist>
1096     </refsect2>
1097
1098     <refsect2>
1099       <title>Machine Commands</title>
1100
1101       <variablelist>
1102         <varlistentry>
1103           <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
1104
1105           <listitem>
1106             <para>List the host and all running local containers with
1107             their state. If one or more
1108             <replaceable>PATTERN</replaceable>s are specified, only
1109             containers matching one of them are shown.
1110             </para>
1111           </listitem>
1112         </varlistentry>
1113       </variablelist>
1114     </refsect2>
1115
1116     <refsect2>
1117       <title>Job Commands</title>
1118
1119       <variablelist>
1120         <varlistentry>
1121           <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1122
1123           <listitem>
1124             <para>List jobs that are in progress. If one or more
1125             <replaceable>PATTERN</replaceable>s are specified, only
1126             jobs for units matching one of them are shown.</para>
1127           </listitem>
1128         </varlistentry>
1129         <varlistentry>
1130           <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1131
1132           <listitem>
1133             <para>Cancel one or more jobs specified on the command line
1134             by their numeric job IDs. If no job ID is specified, cancel
1135             all pending jobs.</para>
1136           </listitem>
1137         </varlistentry>
1138       </variablelist>
1139     </refsect2>
1140
1141     <refsect2>
1142       <title>Snapshot Commands</title>
1143
1144       <variablelist>
1145         <varlistentry>
1146           <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1147
1148           <listitem>
1149             <para>Create a snapshot. If a snapshot name is specified,
1150             the new snapshot will be named after it. If none is
1151             specified, an automatic snapshot name is generated. In
1152             either case, the snapshot name used is printed to standard
1153             output, unless <option>--quiet</option> is specified.
1154             </para>
1155
1156             <para>A snapshot refers to a saved state of the systemd
1157             manager. It is implemented itself as a unit that is
1158             generated dynamically with this command and has dependencies
1159             on all units active at the time. At a later time, the user
1160             may return to this state by using the
1161             <command>isolate</command> command on the snapshot unit.
1162             </para>
1163
1164             <para>Snapshots are only useful for saving and restoring
1165             which units are running or are stopped, they do not
1166             save/restore any other state. Snapshots are dynamic and lost
1167             on reboot.</para>
1168           </listitem>
1169         </varlistentry>
1170         <varlistentry>
1171           <term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
1172
1173           <listitem>
1174             <para>Remove a snapshot previously created with
1175             <command>snapshot</command>.</para>
1176           </listitem>
1177         </varlistentry>
1178       </variablelist>
1179     </refsect2>
1180
1181     <refsect2>
1182       <title>Environment Commands</title>
1183
1184       <variablelist>
1185         <varlistentry>
1186           <term><command>show-environment</command></term>
1187
1188           <listitem>
1189             <para>Dump the systemd manager environment block. The
1190             environment block will be dumped in straight-forward form
1191             suitable for sourcing into a shell script. This environment
1192             block will be passed to all processes the manager
1193             spawns.</para>
1194           </listitem>
1195         </varlistentry>
1196         <varlistentry>
1197           <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1198
1199           <listitem>
1200             <para>Set one or more systemd manager environment variables,
1201             as specified on the command line.</para>
1202           </listitem>
1203         </varlistentry>
1204         <varlistentry>
1205           <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1206
1207           <listitem>
1208             <para>Unset one or more systemd manager environment
1209             variables. If only a variable name is specified, it will be
1210             removed regardless of its value. If a variable and a value
1211             are specified, the variable is only removed if it has the
1212             specified value.</para>
1213           </listitem>
1214         </varlistentry>
1215         <varlistentry>
1216           <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term>
1217
1218           <listitem>
1219             <para>Import all, one or more environment variables set on
1220             the client into the systemd manager environment block. If
1221             no arguments are passed, the entire environment block is
1222             imported. Otherwise, a list of one or more environment
1223             variable names should be passed, whose client-side values
1224             are then imported into the manager's environment
1225             block.</para>
1226           </listitem>
1227         </varlistentry>
1228       </variablelist>
1229     </refsect2>
1230
1231     <refsect2>
1232       <title>Manager Lifecycle Commands</title>
1233
1234       <variablelist>
1235         <varlistentry>
1236           <term><command>daemon-reload</command></term>
1237
1238           <listitem>
1239             <para>Reload systemd manager configuration. This will reload
1240             all unit files and recreate the entire dependency
1241             tree. While the daemon is being reloaded, all sockets systemd
1242             listens on on behalf of user configuration will stay
1243             accessible.</para> <para>This command should not be confused
1244             with the <command>load</command> or
1245             <command>reload</command> commands.</para>
1246           </listitem>
1247         </varlistentry>
1248         <varlistentry>
1249           <term><command>daemon-reexec</command></term>
1250
1251           <listitem>
1252             <para>Reexecute the systemd manager. This will serialize the
1253             manager state, reexecute the process and deserialize the
1254             state again. This command is of little use except for
1255             debugging and package upgrades. Sometimes, it might be
1256             helpful as a heavy-weight <command>daemon-reload</command>.
1257             While the daemon is being reexecuted, all sockets systemd listening
1258             on behalf of user configuration will stay accessible.
1259             </para>
1260           </listitem>
1261         </varlistentry>
1262       </variablelist>
1263     </refsect2>
1264
1265     <refsect2>
1266       <title>System Commands</title>
1267
1268       <variablelist>
1269         <varlistentry>
1270           <term><command>default</command></term>
1271
1272           <listitem>
1273             <para>Enter default mode. This is mostly equivalent to
1274             <command>isolate default.target</command>.</para>
1275           </listitem>
1276         </varlistentry>
1277         <varlistentry>
1278           <term><command>rescue</command></term>
1279
1280           <listitem>
1281             <para>Enter rescue mode. This is mostly equivalent to
1282             <command>isolate rescue.target</command>, but also prints a
1283             wall message to all users.</para>
1284           </listitem>
1285         </varlistentry>
1286         <varlistentry>
1287           <term><command>emergency</command></term>
1288
1289           <listitem>
1290             <para>Enter emergency mode. This is mostly equivalent to
1291             <command>isolate emergency.target</command>, but also prints
1292             a wall message to all users.</para>
1293           </listitem>
1294         </varlistentry>
1295         <varlistentry>
1296           <term><command>halt</command></term>
1297
1298           <listitem>
1299             <para>Shut down and halt the system. This is mostly equivalent to
1300             <command>start halt.target --irreversible</command>, but also
1301             prints a wall message to all users.  If combined with
1302             <option>--force</option>, shutdown of all running services is
1303             skipped, however all processes are killed and all file
1304             systems are unmounted or mounted read-only, immediately
1305             followed by the system halt.  If <option>--force</option> is
1306             specified twice, the operation is immediately executed
1307             without terminating any processes or unmounting any file
1308             systems. This may result in data loss.</para>
1309           </listitem>
1310         </varlistentry>
1311         <varlistentry>
1312           <term><command>poweroff</command></term>
1313
1314           <listitem>
1315             <para>Shut down and power-off the system. This is mostly
1316             equivalent to <command>start poweroff.target --irreversible</command>,
1317             but also prints a wall message to all users. If combined with
1318             <option>--force</option>, shutdown of all running services is
1319             skipped, however all processes are killed and all file
1320             systems are unmounted or mounted read-only, immediately
1321             followed by the powering off. If <option>--force</option> is
1322             specified twice, the operation is immediately executed
1323             without terminating any processes or unmounting any file
1324             systems. This may result in data loss.</para>
1325           </listitem>
1326         </varlistentry>
1327         <varlistentry>
1328           <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1329
1330           <listitem>
1331             <para>Shut down and reboot the system. This is mostly
1332             equivalent to <command>start reboot.target --irreversible</command>,
1333             but also prints a wall message to all users. If combined with
1334             <option>--force</option>, shutdown of all running services is
1335             skipped, however all processes are killed and all file
1336             systems are unmounted or mounted read-only, immediately
1337             followed by the reboot. If <option>--force</option> is
1338             specified twice, the operation is immediately executed
1339             without terminating any processes or unmounting any file
1340             systems. This may result in data loss.</para>
1341
1342             <para>If the optional argument
1343             <replaceable>arg</replaceable> is given, it will be passed
1344             as the optional argument to the
1345             <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1346             system call. The value is architecture and firmware
1347             specific. As an example, <literal>recovery</literal> might
1348             be used to trigger system recovery, and
1349             <literal>fota</literal> might be used to trigger a
1350             <quote>firmware over the air</quote> update.</para>
1351           </listitem>
1352         </varlistentry>
1353         <varlistentry>
1354           <term><command>kexec</command></term>
1355
1356           <listitem>
1357             <para>Shut down and reboot the system via kexec. This is
1358             mostly equivalent to <command>start kexec.target --irreversible</command>,
1359             but also prints a wall message to all users. If combined
1360             with <option>--force</option>, shutdown of all running
1361             services is skipped, however all processes are killed and
1362             all file systems are unmounted or mounted read-only,
1363             immediately followed by the reboot.</para>
1364           </listitem>
1365         </varlistentry>
1366         <varlistentry>
1367           <term><command>exit</command></term>
1368
1369           <listitem>
1370             <para>Ask the systemd manager to quit. This is only
1371             supported for user service managers (i.e. in conjunction
1372             with the <option>--user</option> option) and will fail
1373             otherwise.</para>
1374           </listitem>
1375
1376         </varlistentry>
1377         <varlistentry>
1378           <term><command>suspend</command></term>
1379
1380           <listitem>
1381             <para>Suspend the system. This will trigger activation of
1382             the special <filename>suspend.target</filename> target.
1383             </para>
1384           </listitem>
1385         </varlistentry>
1386         <varlistentry>
1387           <term><command>hibernate</command></term>
1388
1389           <listitem>
1390             <para>Hibernate the system. This will trigger activation of
1391             the special <filename>hibernate.target</filename> target.
1392             </para>
1393           </listitem>
1394         </varlistentry>
1395         <varlistentry>
1396           <term><command>hybrid-sleep</command></term>
1397
1398           <listitem>
1399             <para>Hibernate and suspend the system. This will trigger
1400             activation of the special
1401             <filename>hybrid-sleep.target</filename> target.</para>
1402           </listitem>
1403         </varlistentry>
1404         <varlistentry>
1405           <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1406
1407           <listitem>
1408             <para>Switches to a different root directory and executes a
1409             new system manager process below it. This is intended for
1410             usage in initial RAM disks ("initrd"), and will transition
1411             from the initrd's system manager process (a.k.a "init"
1412             process) to the main system manager process. This call takes two
1413             arguments: the directory that is to become the new root directory, and
1414             the path to the new system manager binary below it to
1415             execute as PID 1. If the latter is omitted or the empty
1416             string, a systemd binary will automatically be searched for
1417             and used as init. If the system manager path is omitted or
1418             equal to the empty string, the state of the initrd's system
1419             manager process is passed to the main system manager, which
1420             allows later introspection of the state of the services
1421             involved in the initrd boot.</para>
1422           </listitem>
1423         </varlistentry>
1424       </variablelist>
1425     </refsect2>
1426
1427     <refsect2>
1428       <title>Parameter Syntax</title>
1429
1430       <para>Unit commands listed above take either a single unit name
1431       (designated as <replaceable>NAME</replaceable>), or multiple
1432       unit specifications (designated as
1433       <replaceable>PATTERN</replaceable>...). In the first case, the
1434       unit name with or without a suffix must be given. If the suffix
1435       is not specified, systemctl will append a suitable suffix,
1436       <literal>.service</literal> by default, and a type-specific
1437       suffix in case of commands which operate only on specific unit
1438       types. For example,
1439       <programlisting># systemctl start sshd</programlisting> and
1440       <programlisting># systemctl start sshd.service</programlisting>
1441       are equivalent, as are
1442       <programlisting># systemctl isolate snapshot-11</programlisting>
1443       and
1444       <programlisting># systemctl isolate snapshot-11.snapshot</programlisting>
1445       Note that (absolute) paths to device nodes are automatically
1446       converted to device unit names, and other (absolute) paths to
1447       mount unit names.
1448       <programlisting># systemctl status /dev/sda
1449 # systemctl status /home</programlisting>
1450       are equivalent to:
1451       <programlisting># systemctl status dev-sda.device
1452 # systemctl status home.mount</programlisting>
1453       In the second case, shell-style globs will be matched against
1454       currently loaded units; literal unit names, with or without
1455       a suffix, will be treated as in the first case. This means that
1456       literal unit names always refer to exactly one unit, but globs
1457       may match zero units and this is not considered an error.</para>
1458
1459       <para>Glob patterns use
1460       <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1461       so normal shell-style globbing rules are used, and
1462       <literal>*</literal>, <literal>?</literal>,
1463       <literal>[]</literal> may be used. See
1464       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1465       for more details. The patterns are matched against the names of
1466       currently loaded units, and patterns which do not match anything
1467       are silently skipped. For example:
1468       <programlisting># systemctl stop sshd@*.service</programlisting>
1469       will stop all <filename>sshd@.service</filename> instances.
1470       </para>
1471
1472       <para>For unit file commands, the specified
1473       <replaceable>NAME</replaceable> should be the full name of the
1474       unit file, or the absolute path to the unit file:
1475       <programlisting># systemctl enable foo.service</programlisting>
1476       or
1477       <programlisting># systemctl link /path/to/foo.service</programlisting>
1478       </para>
1479     </refsect2>
1480
1481   </refsect1>
1482
1483   <refsect1>
1484     <title>Exit status</title>
1485
1486     <para>On success, 0 is returned, a non-zero failure
1487     code otherwise.</para>
1488   </refsect1>
1489
1490   <xi:include href="less-variables.xml" />
1491
1492   <refsect1>
1493     <title>See Also</title>
1494     <para>
1495       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1496       <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1497       <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1498       <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1499       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1500       <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1501       <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1502       <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1503       <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1504       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1505     </para>
1506   </refsect1>
1507
1508 </refentry>