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">
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
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.
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.
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/>.
24 <refentry id="systemctl">
27 <title>systemctl</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>systemctl</refentrytitle>
42 <manvolnum>1</manvolnum>
46 <refname>systemctl</refname>
47 <refpurpose>Control the systemd system and service manager</refpurpose>
52 <command>systemctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
57 <title>Description</title>
59 <para><command>systemctl</command> may be used to
60 introspect and control the state of the
61 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
62 system and service manager.</para>
66 <title>Options</title>
68 <para>The following options are understood:</para>
72 <term><option>--help</option></term>
73 <term><option>-h</option></term>
75 <listitem><para>Prints a short help
76 text and exits.</para></listitem>
80 <term><option>--version</option></term>
82 <listitem><para>Prints a short version
83 string and exits.</para></listitem>
87 <term><option>--type=</option></term>
88 <term><option>-t</option></term>
90 <listitem><para>The argument should
91 be a unit type name such as
92 <option>service</option> and
93 <option>socket</option>,
94 or a unit load state such as
95 <option>loaded</option> and
96 <option>masked</option>.
99 <para>If the argument is a unit type,
100 when listing units, limit display to
101 certain unit types. If not specified
102 units of all types will be shown.</para>
104 <para>If the argument is a unit load state,
105 when listing units, limit display to
106 certain unit types. If not specified
107 units of in all load states will be
113 <term><option>--property=</option></term>
114 <term><option>-p</option></term>
116 <listitem><para>When showing
117 unit/job/manager properties, limit
118 display to certain properties as
119 specified as argument. If not
120 specified all set properties are
121 shown. The argument should be a
122 property name, such as
123 <literal>MainPID</literal>. If
124 specified more than once all
125 properties with the specified names
126 are shown.</para></listitem>
130 <term><option>--all</option></term>
131 <term><option>-a</option></term>
133 <listitem><para>When listing units,
134 show all units, regardless of their
135 state, including inactive units. When
136 showing unit/job/manager properties,
137 show all properties regardless whether
138 they are set or not.</para></listitem>
142 <term><option>--failed</option></term>
144 <listitem><para>When listing units,
145 show only failed units. Do not confuse
147 <option>--fail</option>.</para></listitem>
151 <term><option>--full</option></term>
153 <listitem><para>Do not ellipsize unit
154 names and truncate unit descriptions
156 <command>list-units</command> and
157 <command>list-jobs</command>.</para></listitem>
161 <term><option>--fail</option></term>
163 <listitem><para>If the requested
164 operation conflicts with a pending
165 unfinished job, fail the command. If
166 this is not specified the requested
167 operation will replace the pending job,
168 if necessary. Do not confuse
170 <option>--failed</option>.</para></listitem>
174 <term><option>--ignore-dependencies</option></term>
176 <listitem><para>When enqueuing a new
177 job ignore all its dependencies and
178 execute it immediately. If passed no
179 required units of the unit passed will
180 be pulled in, and no ordering
181 dependencies will be honoured. This is
182 mostly a debugging and rescue tool for
183 the administrator and should not be
185 applications.</para></listitem>
189 <term><option>--quiet</option></term>
190 <term><option>-q</option></term>
192 <listitem><para>Suppress output to
194 <command>snapshot</command>,
195 <command>is-active</command>,
196 <command>enable</command> and
197 <command>disable</command>.</para></listitem>
201 <term><option>--no-block</option></term>
203 <listitem><para>Do not synchronously wait for
204 the requested operation to finish. If this is
205 not specified the job will be verified,
206 enqueued and <command>systemctl</command> will
207 wait until it is completed. By passing this
208 argument it is only verified and
209 enqueued.</para></listitem>
213 <term><option>--no-legend</option></term>
215 <listitem><para>Do not print a legend, i.e.
216 the column headers and the footer with hints.
221 <term><option>--no-pager</option></term>
223 <listitem><para>Do not pipe output into a
224 pager.</para></listitem>
228 <term><option>--system</option></term>
230 <listitem><para>Talk to the systemd
231 system manager. (Default)</para></listitem>
235 <term><option>--user</option></term>
237 <listitem><para>Talk to the systemd
238 manager of the calling user.</para></listitem>
242 <term><option>--order</option></term>
243 <term><option>--require</option></term>
245 <listitem><para>When used in
247 <command>dot</command> command (see
248 below), selects which dependencies are
249 shown in the dependency graph. If
250 <option>--order</option> is passed
251 only dependencies of type
252 <varname>After=</varname> or
253 <varname>Before=</varname> are
254 shown. If <option>--require</option>
255 is passed only dependencies of type
256 <varname>Requires=</varname>,
257 <varname>RequiresOverridable=</varname>,
258 <varname>Requisite=</varname>,
259 <varname>RequisiteOverridable=</varname>,
260 <varname>Wants=</varname> and
261 <varname>Conflicts=</varname> are
262 shown. If neither is passed, shows
263 dependencies of all these
264 types.</para></listitem>
268 <term><option>--no-wall</option></term>
270 <listitem><para>Don't send wall
272 halt, power-off, reboot.</para></listitem>
276 <term><option>--global</option></term>
278 <listitem><para>When used with
279 <command>enable</command> and
280 <command>disable</command>, operate on the
281 global user configuration
282 directory, thus enabling or disabling
283 a unit file globally for all future
284 logins of all users.</para></listitem>
288 <term><option>--no-reload</option></term>
290 <listitem><para>When used with
291 <command>enable</command> and
292 <command>disable</command>, do not
293 implicitly reload daemon configuration
295 changes.</para></listitem>
299 <term><option>--no-ask-password</option></term>
301 <listitem><para>When used with
302 <command>start</command> and related
303 commands, disables asking for
304 passwords. Background services may
305 require input of a password or
306 passphrase string, for example to
307 unlock system hard disks or
308 cryptographic certificates. Unless
309 this option is specified and the
310 command is invoked from a terminal
311 <command>systemctl</command> will
312 query the user on the terminal for the
313 necessary secrets. Use this option to
314 switch this behavior off. In this case
315 the password must be supplied by some
316 other means (for example graphical
317 password agents) or the service might
318 fail. This also disables querying the
319 user for authentication for privileged
320 operations.</para></listitem>
324 <term><option>--kill-who=</option></term>
326 <listitem><para>When used with
327 <command>kill</command>, choose which
328 processes to kill. Must be one of
329 <option>main</option>,
330 <option>control</option> or
331 <option>all</option> to select whether
332 to kill only the main process of the
333 unit, the control process or all
334 processes of the unit. If omitted
336 <option>all</option>.</para></listitem>
340 <term><option>--signal=</option></term>
341 <term><option>-s</option></term>
343 <listitem><para>When used with
344 <command>kill</command>, choose which
345 signal to send to selected
346 processes. Must be one of the well
347 known signal specifiers such as
348 SIGTERM, SIGINT or SIGSTOP. If
350 <option>SIGTERM</option>.</para></listitem>
354 <term><option>--force</option></term>
355 <term><option>-f</option></term>
357 <listitem><para>When used with
358 <command>enable</command>, overwrite any
360 symlinks.</para></listitem>
362 <listitem><para>When used with
363 <command>halt</command>,
364 <command>poweroff</command>,
365 <command>reboot</command> or
366 <command>kexec</command> execute the
367 selected operation without shutting
368 down all units. However, all processes
369 will be killed forcibly and all file
370 systems are unmounted or remounted
371 read-only. This is hence a drastic but
372 relatively safe option to request an
374 <option>--force</option> is specified
375 twice for these operations, they will
376 be executed immediately without
377 terminating any processes or umounting
378 any file systems. Warning: specifying
379 <option>--force</option> twice with
380 any of these operations might result
381 in data loss.</para></listitem>
385 <term><option>--root=</option></term>
387 <listitem><para>When used with
388 <command>enable</command>/<command>disable</command>/<command>is-enabled</command> (and
389 related commands), use alternative
390 root path when looking for unit
391 files.</para></listitem>
395 <term><option>--runtime</option></term>
397 <listitem><para>When used with
398 <command>enable</command>/<command>disable</command>/<command>is-enabled</command> (and related commands), make
399 changes only temporarily, so that they
400 are dropped on the next reboot. This
401 will have the effect that changes are
402 not made in subdirectories of
403 <filename>/etc</filename> but in
404 <filename>/run</filename>, with
405 identical immediate effects, however,
406 since the latter is lost on reboot,
408 too.</para></listitem>
412 <term><option>-H</option></term>
413 <term><option>--host</option></term>
415 <listitem><para>Execute operation
416 remotely. Specify a hostname, or
417 username and hostname separated by @,
418 to connect to. This will use SSH to
419 talk to the remote systemd
420 instance.</para></listitem>
424 <term><option>-P</option></term>
425 <term><option>--privileged</option></term>
427 <listitem><para>Acquire privileges via
428 PolicyKit before executing the
429 operation.</para></listitem>
433 <term><option>--lines=</option></term>
434 <term><option>-n</option></term>
436 <listitem><para>When used with
437 <command>status</command> controls the
438 number of journal lines to show,
439 counting from the most recent
440 ones. Takes a positive integer
441 argument. Defaults to
442 10.</para></listitem>
446 <term><option>--output=</option></term>
447 <term><option>-o</option></term>
449 <listitem><para>When used with
450 <command>status</command> controls the
451 formatting of the journal entries that
452 are shown. For the available choices
454 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. Defaults
456 <literal>short</literal>.</para></listitem>
461 <para>The following commands are understood:</para>
465 <term><command>list-units</command></term>
467 <listitem><para>List known units.</para></listitem>
470 <term><command>start [NAME...]</command></term>
472 <listitem><para>Start (activate) one
473 or more units specified on the command
474 line.</para></listitem>
477 <term><command>stop [NAME...]</command></term>
479 <listitem><para>Stop (deactivate) one
480 or more units specified on the command
481 line.</para></listitem>
484 <term><command>reload [NAME...]</command></term>
486 <listitem><para>Asks all units listed
487 on the command line to reload their
488 configuration. Note that this will
489 reload the service-specific
490 configuration, not the unit
491 configuration file of systemd. If you
492 want systemd to reload the
493 configuration file of a unit use the
494 <command>daemon-reload</command>
495 command. In other words: for the
496 example case of Apache, this will
498 <filename>httpd.conf</filename> in the
500 <filename>apache.service</filename>
501 systemd unit file. </para>
503 <para>This command should not be
505 <command>daemon-reload</command> or
506 <command>load</command>
507 commands.</para></listitem>
511 <term><command>restart [NAME...]</command></term>
513 <listitem><para>Restart one or more
514 units specified on the command
515 line. If the units are not running yet
517 started.</para></listitem>
520 <term><command>try-restart [NAME...]</command></term>
522 <listitem><para>Restart one or more
523 units specified on the command
524 line if the units are running. Do
525 nothing if units are not running.
526 Note that for compatibility
527 with Red Hat init scripts
528 <command>condrestart</command> is
529 equivalent to this command.</para></listitem>
532 <term><command>reload-or-restart [NAME...]</command></term>
534 <listitem><para>Reload one or more
535 units if they support it. If not,
536 restart them instead. If the units
537 are not running yet they will be
538 started.</para></listitem>
541 <term><command>reload-or-try-restart [NAME...]</command></term>
543 <listitem><para>Reload one or more
544 units if they support it. If not,
545 restart them instead. Do nothing if
546 the units are not running. Note that
547 for compatibility with SysV init
549 <command>force-reload</command> is
551 command.</para></listitem>
554 <term><command>isolate [NAME]</command></term>
556 <listitem><para>Start the unit
557 specified on the command line and its
558 dependencies and stop all others.</para>
560 <para>This is similar to changing the
561 runlevel in a traditional init system. The
562 <command>isolate</command> command will
563 immediately stop processes that are not
564 enabled in the new unit, possibly including
565 the graphical environment or terminal you
566 are currently using.</para>
568 <para>Note that this works only on units
569 where <option>AllowIsolate=</option> is
571 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
572 for details.</para></listitem>
575 <term><command>kill [NAME...]</command></term>
577 <listitem><para>Send a signal to one
578 or more processes of the unit. Use
579 <option>--kill-who=</option> to select
580 which process to kill. Use
581 <option>--kill-mode=</option> to
582 select the kill mode and
583 <option>--signal=</option> to select
584 the signal to send.</para></listitem>
587 <term><command>is-active [NAME...]</command></term>
589 <listitem><para>Check whether any of
590 the specified units are active
591 (i.e. running). Returns an exit code
592 0 if at least one is active, non-zero
594 <option>--quiet</option> is specified
595 this will also print the current unit
596 state to STDOUT.</para></listitem>
599 <term><command>status [NAME...|PID...]</command></term>
601 <listitem><para>Show terse runtime
602 status information about one or more
603 units, followed by its most recent log
604 data from the journal. This function
605 is intended to generate human-readable
606 output. If you are looking for
607 computer-parsable output, use
608 <command>show</command> instead. If a
609 PID is passed information about the
610 unit the process of the PID belongs to
611 is shown.</para></listitem>
614 <term><command>show [NAME...|JOB...]</command></term>
616 <listitem><para>Show properties of one
617 or more units, jobs or the manager
618 itself. If no argument is specified
619 properties of the manager will be
620 shown. If a unit name is specified
621 properties of the unit is shown, and
622 if a job id is specified properties of
623 the job is shown. By default, empty
624 properties are suppressed. Use
625 <option>--all</option> to show those
626 too. To select specific properties to
628 <option>--property=</option>. This
629 command is intended to be used
630 whenever computer-parsable output is
632 <command>status</command> if you are
633 looking for formatted human-readable
634 output.</para></listitem>
637 <term><command>help [NAME...|PID...]</command></term>
639 <listitem><para>Show manual pages for
640 one or more units, if available. If a
641 PID is passed the manual pages for the
642 unit the process of the PID belongs to
643 is shown.</para></listitem>
646 <term><command>reset-failed [NAME...]</command></term>
648 <listitem><para>Reset the
649 '<literal>failed</literal>' state of the
650 specified units, or if no unit name is
651 passed of all units. When a unit fails
652 in some way (i.e. process exiting with
653 non-zero error code, terminating
654 abnormally or timing out) it will
655 automatically enter the
656 '<literal>failed</literal>' state and
657 its exit code and status is recorded
658 for introspection by the administrator
659 until the service is restarted or
661 command.</para></listitem>
665 <term><command>list-unit-files</command></term>
667 <listitem><para>List installed unit files.
672 <term><command>enable [NAME...]</command></term>
674 <listitem><para>Enable one or
675 more unit files or unit file
676 instances, as specified on the
677 command line. This will create a
678 number of symlinks as encoded in
679 the <literal>[Install]</literal>
680 sections of the unit files. After
681 the symlinks have been created the
682 systemd configuration is reloaded
683 (in a way that is equivalent to
684 <command>daemon-reload</command>)
685 to ensure the changes are taken into
686 account immediately. Note that this
687 does not have the effect that any of
688 the units enabled are also started at
689 the same time. If this is desired
690 a separate <command>start</command>
691 command must be invoked for the unit.
692 Also note that in case of instance
693 enablement, symlinks named same as
694 instances are created in install
695 location, however they all point to
696 the same template unit file.</para>
698 <para>This command will
699 print the actions executed. This
700 output may be suppressed by passing
701 <option>--quiet</option>.</para>
703 <para>Note that this operation creates
704 only the suggested symlinks for the
705 units. While this command is the
706 recommended way to manipulate the unit
707 configuration directory, the
708 administrator is free to make
709 additional changes manually, by
710 placing or removing symlinks in the
711 directory. This is particularly useful
712 to create configurations that deviate
713 from the suggested default
714 installation. In this case the
715 administrator must make sure to invoke
716 <command>daemon-reload</command>
717 manually as necessary, to ensure his
718 changes are taken into account.</para>
720 <para>Enabling units should not be
721 confused with starting (activating)
722 units, as done by the
723 <command>start</command>
724 command. Enabling and starting units
725 is orthogonal: units may be enabled
726 without being started and started
727 without being enabled. Enabling simply
728 hooks the unit into various suggested
729 places (for example, so that the unit
730 is automatically started on boot or
731 when a particular kind of hardware is
732 plugged in). Starting actually spawns
733 the daemon process (in case of service
734 units), or binds the socket (in case
735 of socket units), and so
738 <para>Depending on whether
739 <option>--system</option>,
740 <option>--user</option> or
741 <option>--global</option> is specified
742 this enables the unit for the system,
743 for the calling user only
744 or for all future logins of all
745 users. Note that in the latter case no
746 systemd daemon configuration is
752 <term><command>disable [NAME...]</command></term>
754 <listitem><para>Disables one or more
755 units. This removes all symlinks to
756 the specified unit files from the unit
757 configuration directory, and hence
758 undoes the changes made by
759 <command>enable</command>. Note
760 however that this removes
761 all symlinks to the unit files
762 (i.e. including manual additions), not
763 just those actually created by
764 <command>enable</command>. This call
765 implicitly reloads the systemd daemon
766 configuration after completing the
767 disabling of the units. Note that this
768 command does not implicitly stop the
769 units that is being disabled. If this
770 is desired an additional
771 <command>stop</command> command should
772 be executed afterwards.</para>
774 <para>This command will print the
775 actions executed. This output may be
776 suppressed by passing
777 <option>--quiet</option>.</para>
780 <para>This command honors
781 <option>--system</option>,
782 <option>--user</option>,
783 <option>--global</option> in a similar
785 <command>enable</command>.</para>
789 <term><command>is-enabled [NAME...]</command></term>
791 <listitem><para>Checks whether any of
792 the specified unit files is enabled
794 <command>enable</command>). Returns an
795 exit code of 0 if at least one is
796 enabled, non-zero otherwise. Prints
797 the current enable status. To suppress
799 <option>--quiet</option>.</para></listitem>
803 <term><command>reenable [NAME...]</command></term>
805 <listitem><para>Reenable one or more
806 unit files, as specified on the
807 command line. This is a combination of
808 <command>disable</command> and
809 <command>enable</command> and is
810 useful to reset the symlinks a unit is
811 enabled with to the defaults
813 <literal>[Install]</literal> section
814 of the unit file.</para>
819 <term><command>preset [NAME...]</command></term>
821 <listitem><para>Reset one or more unit
822 files, as specified on the command
823 line, to the defaults configured in
824 the preset policy files. This has the
826 <command>disable</command> or
827 <command>enable</command>, depending
828 how the unit is listed in the preset
829 files. For more information on preset
831 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
832 more information on the concept of
833 presets please consult the <ulink
834 url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
840 <term><command>mask [NAME...]</command></term>
842 <listitem><para>Mask one or more unit
843 files, as specified on the command
844 line. This will link these units to
845 <filename>/dev/null</filename>, making
846 it impossible to start them. This is a stronger version
847 of <command>disable</command>, since
848 it prohibits all kinds of activation
849 of the unit, including manual
850 activation. Use this option with
856 <term><command>unmask [NAME...]</command></term>
858 <listitem><para>Unmask one or more
859 unit files, as specified on the
860 command line. This will undo the
862 <command>mask</command>.</para>
867 <term><command>link [NAME...]</command></term>
869 <listitem><para>Link a unit file that
870 is not in the unit file search paths
871 into the unit file search path. This
872 requires an absolute path to a unit
873 file. The effect of this can be undone
874 with <command>disable</command>. The
875 effect of this command is that a unit
876 file is available for
877 <command>start</command> and other
878 commands although it isn't installed
879 directly in the unit search
885 <term><command>load [NAME...]</command></term>
887 <listitem><para>Load one or more units
888 specified on the command line. This
889 will simply load their configuration
890 from disk, but not start them. To
891 start them you need to use the
892 <command>start</command> command which
893 will implicitly load a unit that has
894 not been loaded yet. Note that systemd
895 garbage collects loaded units that are
896 not active or referenced by an active
897 unit. This means that units loaded
898 this way will usually not stay loaded
899 for long. Also note that this command
900 cannot be used to reload unit
901 configuration. Use the
902 <command>daemon-reload</command>
903 command for that. All in all, this
904 command is of little use except for
906 <para>This command should not be
908 <command>daemon-reload</command> or
909 <command>reload</command>
910 commands.</para></listitem>
913 <term><command>list-jobs</command></term>
915 <listitem><para>List jobs that are in progress.</para></listitem>
918 <term><command>cancel [JOB...]</command></term>
920 <listitem><para>Cancel one or more
921 jobs specified on the command line by
923 IDs. If no job id is specified, cancel all pending jobs.</para></listitem>
926 <term><command>dump</command></term>
928 <listitem><para>Dump server
929 status. This will output a (usually
930 very long) human readable manager
931 status dump. Its format is subject to
932 change without notice and should not
934 applications.</para></listitem>
937 <term><command>dot</command></term>
939 <listitem><para>Generate textual
940 dependency graph description in dot
941 format for further processing with the
943 <citerefentry><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
944 tool. Use a command line like
945 <command>systemctl dot | dot -Tsvg >
946 systemd.svg</command> to generate a
947 graphical dependency tree. Unless
948 <option>--order</option> or
949 <option>--require</option> is passed
950 the generated graph will show both
951 ordering and requirement
952 dependencies.</para></listitem>
955 <term><command>snapshot [NAME]</command></term>
957 <listitem><para>Create a snapshot. If
958 a snapshot name is specified, the new
959 snapshot will be named after it. If
960 none is specified an automatic
961 snapshot name is generated. In either
962 case, the snapshot name used is
963 printed to STDOUT, unless
964 <option>--quiet</option> is
967 <para>A snapshot refers to a saved
968 state of the systemd manager. It is
969 implemented itself as a unit that is
970 generated dynamically with this
971 command and has dependencies on all
972 units active at the time. At a later
973 time the user may return to this state
975 <command>isolate</command> command on
976 the snapshot unit.</para></listitem>
978 <para>Snapshots are only useful for
979 saving and restoring which units are
980 running or are stopped, they do not
981 save/restore any other
982 state. Snapshots are dynamic and lost
986 <term><command>delete [NAME...]</command></term>
988 <listitem><para>Remove a snapshot
989 previously created with
990 <command>snapshot</command>.</para></listitem>
993 <term><command>daemon-reload</command></term>
995 <listitem><para>Reload systemd manager
996 configuration. This will reload all
997 unit files and recreate the entire
998 dependency tree. While the daemon is
999 reloaded, all sockets systemd listens
1000 on on behalf of user configuration will
1001 stay accessible.</para> <para>This
1002 command should not be confused with
1003 the <command>load</command> or
1004 <command>reload</command>
1005 commands.</para></listitem>
1008 <term><command>daemon-reexec</command></term>
1010 <listitem><para>Reexecute the systemd
1011 manager. This will serialize the
1012 manager state, reexecute the process
1013 and deserialize the state again. This
1014 command is of little use except for
1015 debugging and package
1016 upgrades. Sometimes it might be
1017 helpful as a heavy-weight
1018 <command>daemon-reload</command>. While
1019 the daemon is reexecuted all sockets
1020 systemd listens on on behalf of user
1021 configuration will stay
1022 accessible.</para></listitem>
1025 <term><command>show-environment</command></term>
1027 <listitem><para>Dump the systemd
1028 manager environment block. The
1029 environment block will be dumped in
1030 straight-forward form suitable for
1031 sourcing into a shell script. This
1032 environment block will be passed to
1033 all processes the manager
1034 spawns.</para></listitem>
1037 <term><command>set-environment [NAME=VALUE...]</command></term>
1039 <listitem><para>Set one or more
1040 systemd manager environment variables,
1041 as specified on the command
1042 line.</para></listitem>
1045 <term><command>unset-environment [NAME...]</command></term>
1047 <listitem><para>Unset one or more
1048 systemd manager environment
1049 variables. If only a variable name is
1050 specified it will be removed
1051 regardless of its value. If a variable
1052 and a value are specified the variable
1053 is only removed if it has the
1054 specified value.</para></listitem>
1057 <term><command>default</command></term>
1059 <listitem><para>Enter default
1060 mode. This is mostly equivalent to
1062 default.target</command>.</para></listitem>
1065 <term><command>rescue</command></term>
1067 <listitem><para>Enter rescue
1068 mode. This is mostly equivalent to
1070 rescue.target</command> but also
1071 prints a wall message to all
1072 users.</para></listitem>
1075 <term><command>emergency</command></term>
1077 <listitem><para>Enter emergency
1078 mode. This is mostly equivalent to
1080 emergency.target</command> but also
1081 prints a wall message to all
1082 users.</para></listitem>
1085 <term><command>halt</command></term>
1087 <listitem><para>Shut down and halt the
1088 system. This is mostly equivalent to
1089 <command>start halt.target</command>
1090 but also prints a wall message to all
1091 users. If combined with
1092 <option>--force</option> shutdown of
1093 all running services is skipped,
1094 however all processes are killed and
1095 all file systems are unmounted or
1096 mounted read-only, immediately
1097 followed by the system halt. If
1098 <option>--force</option> is specified
1099 twice the operation is immediately
1100 executed without terminating any
1101 processes or unmounting any file
1102 systems. This may result in data
1103 loss.</para></listitem>
1106 <term><command>poweroff</command></term>
1108 <listitem><para>Shut down and
1109 power-off the system. This is mostly
1110 equivalent to <command>start
1111 poweroff.target</command> but also
1112 prints a wall message to all users. If
1113 combined with <option>--force</option>
1114 shutdown of all running services is
1115 skipped, however all processes are
1116 killed and all file systems are
1117 unmounted or mounted read-only,
1118 immediately followed by the powering
1119 off. If <option>--force</option> is
1120 specified twice the operation is
1121 immediately executed without
1122 terminating any processes or
1123 unmounting any file systems. This may
1124 result in data loss.</para></listitem>
1127 <term><command>reboot</command></term>
1129 <listitem><para>Shut down and reboot
1130 the system. This is mostly equivalent
1132 reboot.target</command> but also
1133 prints a wall message to all users. If
1134 combined with <option>--force</option>
1135 shutdown of all running services is
1136 skipped, however all processes are
1137 killed and all file systems are
1138 unmounted or mounted read-only,
1139 immediately followed by the reboot. If
1140 <option>--force</option> is specified
1141 twice the operation is immediately
1142 executed without terminating any
1143 processes or unmounting any file
1144 systems. This may result in data
1145 loss.</para></listitem>
1148 <term><command>kexec</command></term>
1150 <listitem><para>Shut down and reboot
1151 the system via kexec. This is mostly
1152 equivalent to <command>start
1153 kexec.target</command> but also prints
1154 a wall message to all users. If
1155 combined with <option>--force</option>
1156 shutdown of all running services is
1157 skipped, however all processes are killed
1158 and all file systems are unmounted or
1159 mounted read-only, immediately
1161 reboot.</para></listitem>
1164 <term><command>exit</command></term>
1166 <listitem><para>Ask the systemd
1167 manager to quit. This is only
1168 supported for user service managers
1169 (i.e. in conjunction with the
1170 <option>--user</option> option) and
1171 will fail otherwise.</para></listitem>
1174 <term><command>suspend</command></term>
1176 <listitem><para>Suspend the system.</para></listitem>
1179 <term><command>hibernate</command></term>
1181 <listitem><para>Hibernate the system.</para></listitem>
1184 <term><command>switch-root [ROOT] [INIT]</command></term>
1186 <listitem><para>Switches to a
1187 different root directory and executes
1188 a new system manager process below
1189 it. This is intended for usage in
1190 initial RAM disks ("initrd"), and will
1191 transition from the initrd's system
1192 manager process (a.k.a "init" process)
1193 to the main system manager
1194 process. Takes two arguments: the
1195 directory to make the new root
1196 directory, and the path to the new
1197 system manager binary below it to
1198 execute as PID 1. If the latter is
1199 omitted or the empty string, a
1200 systemd binary will automatically be
1201 searched for and used as init. If the
1202 system manager path is omitted or
1203 equal the empty string the state of
1204 the initrd's system manager process is
1205 passed to the main system manager,
1206 which allows later introspection of the
1207 state of the services involved in the
1208 initrd boot.</para></listitem>
1215 <title>Exit status</title>
1217 <para>On success 0 is returned, a non-zero failure
1218 code otherwise.</para>
1222 <title>Environment</title>
1226 <term><varname>$SYSTEMD_PAGER</varname></term>
1227 <listitem><para>Pager to use when
1228 <option>--no-pager</option> is not given;
1229 overrides <varname>$PAGER</varname>. Setting
1230 this to an empty string or the value
1231 <literal>cat</literal> is equivalent to passing
1232 <option>--no-pager</option>.</para></listitem>
1238 <title>See Also</title>
1240 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1241 <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1242 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1243 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1244 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1245 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1246 <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1247 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>