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