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