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