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