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