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