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