]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemctl.xml
man: add missing subject in sentence
[thirdparty/systemd.git] / man / systemctl.xml
CommitLineData
514094f9 1<?xml version='1.0'?>
3a54a157
ZJS
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
681eb9cf
FB
4<!ENTITY % entities SYSTEM "custom-entities.ent" >
5%entities;
6]>
db9ecf05 7<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
7874bcd6 8
21ac6ff1
ZJS
9<refentry id="systemctl"
10 xmlns:xi="http://www.w3.org/2001/XInclude">
7874bcd6 11
4a6022f0
ZJS
12 <refentryinfo>
13 <title>systemctl</title>
14 <productname>systemd</productname>
4a6022f0
ZJS
15 </refentryinfo>
16
17 <refmeta>
18 <refentrytitle>systemctl</refentrytitle>
19 <manvolnum>1</manvolnum>
20 </refmeta>
21
22 <refnamediv>
23 <refname>systemctl</refname>
24 <refpurpose>Control the systemd system and service manager</refpurpose>
25 </refnamediv>
26
27 <refsynopsisdiv>
28 <cmdsynopsis>
29 <command>systemctl</command>
30 <arg choice="opt" rep="repeat">OPTIONS</arg>
31 <arg choice="plain">COMMAND</arg>
da5e955f 32 <arg choice="opt" rep="repeat">UNIT</arg>
4a6022f0
ZJS
33 </cmdsynopsis>
34 </refsynopsisdiv>
35
36 <refsect1>
37 <title>Description</title>
38
a4390b6b
LP
39 <para><command>systemctl</command> may be used to introspect and
40 control the state of the <literal>systemd</literal> system and
41 service manager. Please refer to
4a6022f0 42 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
a4390b6b
LP
43 for an introduction into the basic concepts and functionality this
44 tool manages.</para>
4a6022f0
ZJS
45 </refsect1>
46
47 <refsect1>
e1fac8a6 48 <title>Commands</title>
4a6022f0 49
e1fac8a6 50 <para>The following commands are understood:</para>
4a6022f0 51
e1fac8a6 52 <refsect2>
172338d5 53 <title>Unit Commands (Introspection and Modification)</title>
20b3f379 54
e1fac8a6
ZJS
55 <variablelist>
56 <varlistentry>
57 <term><command>list-units</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
4a6022f0 58
e1fac8a6
ZJS
59 <listitem>
60 <para>List units that <command>systemd</command> currently has in memory. This includes units that are
61 either referenced directly or through a dependency, units that are pinned by applications programmatically,
62 or units that were active in the past and have failed. By default only units which are active, have pending
63 jobs, or have failed are shown; this can be changed with option <option>--all</option>. If one or more
64 <replaceable>PATTERN</replaceable>s are specified, only units matching one of them are shown. The units
65 that are shown are additionally filtered by <option>--type=</option> and <option>--state=</option> if those
66 options are specified.</para>
4a6022f0 67
7ea5e82f
LP
68 <para>Note that this command does not show unit templates, but only instances of unit
69 templates. Units templates that aren't instantiated are not runnable, and will thus never show up
70 in the output of this command. Specifically this means that <filename>foo@.service</filename>
71 will never be shown in this list — unless instantiated, e.g. as
72 <filename>foo@bar.service</filename>. Use <command>list-unit-files</command> (see below) for
73 listing installed unit template files.</para>
74
e1fac8a6
ZJS
75 <para>Produces output similar to
76 <programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION
77 sys-module-fuse.device loaded active plugged /sys/module/fuse
78 -.mount loaded active mounted Root Mount
79 boot-efi.mount loaded active mounted /boot/efi
80 systemd-journald.service loaded active running Journal Service
81 systemd-logind.service loaded active running Login Service
82● user@1000.service loaded failed failed User Manager for UID 1000
83
84 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
9b9b3d36 85
e1fac8a6
ZJS
86LOAD = Reflects whether the unit definition was properly loaded.
87ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
88SUB = The low-level unit activation state, values depend on unit type.
e16972e6 89
e1fac8a6 90123 loaded units listed. Pass --all to see loaded but inactive units, too.
7ea5e82f
LP
91To show all installed unit files use 'systemctl list-unit-files'.</programlisting></para>
92
93 <para>The header and the last unit of a given type are underlined if the terminal supports
94 that. A colored dot is shown next to services which were masked, not found, or otherwise
95 failed.</para>
9b9b3d36 96
e1fac8a6
ZJS
97 <para>The LOAD column shows the load state, one of <constant>loaded</constant>,
98 <constant>not-found</constant>, <constant>bad-setting</constant>, <constant>error</constant>,
99 <constant>masked</constant>. The ACTIVE columns shows the general unit state, one of
100 <constant>active</constant>, <constant>reloading</constant>, <constant>inactive</constant>,
101 <constant>failed</constant>, <constant>activating</constant>, <constant>deactivating</constant>. The SUB
102 column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list
103 of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove
104 values. <programlisting>systemctl --state=help</programlisting> command maybe be used to display the
105 current set of possible values.</para>
4a6022f0 106
e1fac8a6
ZJS
107 <para>This is the default command.</para>
108 </listitem>
109 </varlistentry>
ea539eb6 110
2d5cdc62
DT
111 <varlistentry>
112 <term><command>list-automounts</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
113
114 <listitem>
115 <para>List automount units currently in memory, ordered by mount path. If one or more
116 <replaceable>PATTERN</replaceable>s are specified, only automount units matching one of them are shown.
117 Produces output similar to
118 <programlisting>
119WHAT WHERE MOUNTED IDLE TIMEOUT UNIT
120/dev/sdb1 /mnt/test no 120s mnt-test.automount
121binfmt_misc /proc/sys/fs/binfmt_misc yes 0 proc-sys-fs-binfmt_misc.automount
122
1232 automounts listed.</programlisting>
124 </para>
125
126 <para>Also see <option>--show-types</option>, <option>--all</option>, and <option>--state=</option>.</para>
127 </listitem>
128 </varlistentry>
129
e1fac8a6
ZJS
130 <varlistentry>
131 <term><command>list-sockets</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
ea539eb6 132
e1fac8a6
ZJS
133 <listitem>
134 <para>List socket units currently in memory, ordered by listening address. If one or more
135 <replaceable>PATTERN</replaceable>s are specified, only socket units matching one of them are
136 shown. Produces output similar to
137 <programlisting>
138LISTEN UNIT ACTIVATES
139/dev/initctl systemd-initctl.socket systemd-initctl.service
140
141[::]:22 sshd.socket sshd.service
142kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
4a6022f0 143
e1fac8a6
ZJS
1445 sockets listed.</programlisting>
145 Note: because the addresses might contains spaces, this output
146 is not suitable for programmatic consumption.
147 </para>
4a6022f0 148
e1fac8a6
ZJS
149 <para>Also see <option>--show-types</option>, <option>--all</option>, and <option>--state=</option>.</para>
150 </listitem>
151 </varlistentry>
21b587cf 152
e1fac8a6
ZJS
153 <varlistentry>
154 <term><command>list-timers</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
e9fbae3f 155
e1fac8a6
ZJS
156 <listitem>
157 <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
158 <replaceable>PATTERN</replaceable>s are specified, only units matching one of them are shown.
159 Produces output similar to
160 <programlisting>
161NEXT LEFT LAST PASSED UNIT ACTIVATES
162n/a n/a Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service
163Sun 2017-02-26 18:55:42 EST 1min 14s left Thu 2017-02-23 13:54:44 EST 3 days ago systemd-tmpfiles-clean.timer systemd-tmpfiles-clean.service
164Sun 2017-02-26 20:37:16 EST 1h 42min left Sun 2017-02-26 11:56:36 EST 6h ago apt-daily.timer apt-daily.service
165Sun 2017-02-26 20:57:49 EST 2h 3min left Sun 2017-02-26 11:56:36 EST 6h ago snapd.refresh.timer snapd.refresh.service
166 </programlisting>
167 </para>
4fa226ff 168
e1fac8a6
ZJS
169 <para><emphasis>NEXT</emphasis> shows the next time the timer will run.</para>
170 <para><emphasis>LEFT</emphasis> shows how long till the next time the timer runs.</para>
171 <para><emphasis>LAST</emphasis> shows the last time the timer ran.</para>
172 <para><emphasis>PASSED</emphasis> shows how long has passed since the timer last ran.</para>
173 <para><emphasis>UNIT</emphasis> shows the name of the timer</para>
174 <para><emphasis>ACTIVATES</emphasis> shows the name the service the timer activates when it runs.</para>
4a6022f0 175
e1fac8a6
ZJS
176 <para>Also see <option>--all</option> and <option>--state=</option>.</para>
177 </listitem>
178 </varlistentry>
1238ee09 179
172338d5
ZJS
180 <varlistentry>
181 <term><command>is-active <replaceable>PATTERN</replaceable>…</command></term>
182
183 <listitem>
184 <para>Check whether any of the specified units are active
185 (i.e. running). Returns an exit code
186 <constant>0</constant> if at least one is active, or
187 non-zero otherwise. Unless <option>--quiet</option> is
188 specified, this will also print the current unit state to
189 standard output.</para>
190 </listitem>
191 </varlistentry>
192
193 <varlistentry>
194 <term><command>is-failed <replaceable>PATTERN</replaceable>…</command></term>
195
196 <listitem>
197 <para>Check whether any of the specified units are in a
198 "failed" state. Returns an exit code
199 <constant>0</constant> if at least one has failed,
200 non-zero otherwise. Unless <option>--quiet</option> is
201 specified, this will also print the current unit state to
202 standard output.</para>
203 </listitem>
204 </varlistentry>
205
206 <varlistentry>
207 <term><command>status</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…]</optional></term>
208
209 <listitem>
a6e33464
ZJS
210 <para>Show runtime status information about the whole system or about one or more units followed
211 by most recent log data from the journal. If no positional arguments are specified, and no unit
212 filter is given with <option>--type=</option>, <option>--state=</option>, or
213 <option>--failed</option>, shows the status of the whole system. If combined with
214 <option>--all</option>, follows that with the status of all units. If positional arguments are
215 specified, each positional argument is treated as either a unit name to show, or a glob pattern
216 to show units whose names match that pattern, or a PID to show the unit containing that PID. When
217 <option>--type=</option>, <option>--state=</option>, or <option>--failed</option> are used, units
218 are additionally filtered by the TYPE and ACTIVE state.</para>
172338d5 219
157cb433
LP
220 <para>This function is intended to generate human-readable output. If you are looking for
221 computer-parsable output, use <command>show</command> instead. By default, this function only
222 shows 10 lines of output and ellipsizes lines to fit in the terminal window. This can be changed
223 with <option>--lines</option> and <option>--full</option>, see above. In addition,
224 <command>journalctl --unit=<replaceable>NAME</replaceable></command> or <command>journalctl
225 --user-unit=<replaceable>NAME</replaceable></command> use a similar filter for messages and might
226 be more convenient.</para>
227
1374f5a0 228 <para>Note that this operation only displays <emphasis>runtime</emphasis> status, i.e. information about
157cb433
LP
229 the current invocation of the unit (if it is running) or the most recent invocation (if it is not
230 running anymore, and has not been released from memory). Information about earlier invocations,
231 invocations from previous system boots, or prior invocations that have already been released from
232 memory may be retrieved via <command>journalctl --unit=</command>.</para>
233
234 <para>systemd implicitly loads units as necessary, so just running the <command>status</command>
235 will attempt to load a file. The command is thus not useful for determining if something was
236 already loaded or not. The units may possibly also be quickly unloaded after the operation is
237 completed if there's no reason to keep it in memory thereafter.</para>
172338d5
ZJS
238
239 <example>
240 <title>Example output from systemctl status </title>
241
242 <programlisting>$ systemctl status bluetooth
243● bluetooth.service - Bluetooth service
c1e0dc9c 244 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; preset: enabled)
172338d5
ZJS
245 Active: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago
246 Docs: man:bluetoothd(8)
247 Main PID: 930 (bluetoothd)
248 Status: "Running"
249 Tasks: 1
250 Memory: 648.0K
251 CPU: 435ms
252 CGroup: /system.slice/bluetooth.service
253 └─930 /usr/lib/bluetooth/bluetoothd
254
255Jan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service
256Jan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered
257Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5)
258</programlisting>
259
0c772b1c
LP
260 <para>The dot ("●") uses color on supported terminals to summarize the unit state at a
261 glance. Along with its color, its shape varies according to its state:
262 <literal>inactive</literal> or <literal>maintenance</literal> is a white circle ("○"),
263 <literal>active</literal> is a green dot ("●"), <literal>deactivating</literal> is a white dot,
264 <literal>failed</literal> or <literal>error</literal> is a red cross ("×"), and
265 <literal>reloading</literal> is a green clockwise circle arrow ("↻").</para>
266
267 <para>The "Loaded:" line in the output will show <literal>loaded</literal> if the unit has been
268 loaded into memory. Other possible values for "Loaded:" include: <literal>error</literal> if
269 there was a problem loading it, <literal>not-found</literal> if no unit file was found for this
270 unit, <literal>bad-setting</literal> if an essential unit file setting could not be parsed and
271 <literal>masked</literal> if the unit file has been masked. Along with showing the path to the
272 unit file, this line will also show the enablement state. Enabled units are included in the
273 dependency network between units, and thus are started at boot or via some other form of
274 activation. See the full table of possible enablement states — including the definition of
275 <literal>masked</literal> — in the documentation for the <command>is-enabled</command> command.
172338d5
ZJS
276 </para>
277
278 <para>The "Active:" line shows active state. The value is usually <literal>active</literal> or
0c772b1c
LP
279 <literal>inactive</literal>. Active could mean started, bound, plugged in, etc depending on the
280 unit type. The unit could also be in process of changing states, reporting a state of
281 <literal>activating</literal> or <literal>deactivating</literal>. A special
282 <literal>failed</literal> state is entered when the service failed in some way, such as a crash,
283 exiting with an error code or timing out. If the failed state is entered the cause will be logged
284 for later reference.</para>
172338d5
ZJS
285 </example>
286
287 </listitem>
288 </varlistentry>
289
290 <varlistentry>
291 <term><command>show</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>JOB</replaceable>…</optional></term>
292
293 <listitem>
294 <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
295 properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
296 if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
297 <option>--all</option> to show those too. To select specific properties to show, use
298 <option>--property=</option>. This command is intended to be used whenever computer-parsable output is
299 required. Use <command>status</command> if you are looking for formatted human-readable output.</para>
300
301 <para>Many properties shown by <command>systemctl show</command> map directly to configuration settings of
302 the system and service manager and its unit files. Note that the properties shown by the command are
303 generally more low-level, normalized versions of the original configuration settings and expose runtime
304 state in addition to configuration. For example, properties shown for service units include the service's
305 current main process identifier as <literal>MainPID</literal> (which is runtime state), and time settings
306 are always exposed as properties ending in the <literal>…USec</literal> suffix even if a matching
307 configuration options end in <literal>…Sec</literal>, because microseconds is the normalized time unit used
308 internally by the system and service manager.</para>
309
310 <para>For details about many of these properties, see the documentation of the D-Bus interface
311 backing these properties, see
312 <citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry>
317 <term><command>cat <replaceable>PATTERN</replaceable>…</command></term>
318
319 <listitem>
320 <para>Show backing files of one or more units. Prints the
321 "fragment" and "drop-ins" (source files) of units. Each
322 file is preceded by a comment which includes the file
323 name. Note that this shows the contents of the backing files
324 on disk, which may not match the system manager's
325 understanding of these units if any unit files were
326 updated on disk and the <command>daemon-reload</command>
327 command wasn't issued since.</para>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry>
332 <term><command>help <replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…</command></term>
333
334 <listitem>
335 <para>Show manual pages for one or more units, if
336 available. If a PID is given, the manual pages for the unit
337 the process belongs to are shown.</para>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry>
342 <term>
343 <command>list-dependencies</command>
344 <optional><replaceable>UNIT</replaceable>...</optional>
345 </term>
346
347 <listitem>
348 <para>Shows units required and wanted by the specified
349 units. This recursively lists units following the
350 <varname>Requires=</varname>,
351 <varname>Requisite=</varname>,
352 <varname>ConsistsOf=</varname>,
353 <varname>Wants=</varname>, <varname>BindsTo=</varname>
354 dependencies. If no units are specified,
355 <filename>default.target</filename> is implied.</para>
356
357 <para>By default, only target units are recursively
358 expanded. When <option>--all</option> is passed, all other
359 units are recursively expanded as well.</para>
360
361 <para>Options <option>--reverse</option>,
362 <option>--after</option>, <option>--before</option>
363 may be used to change what types of dependencies
364 are shown.</para>
365
366 <para>Note that this command only lists units currently loaded into memory by the service manager. In
367 particular, this command is not suitable to get a comprehensive list at all reverse dependencies on a
368 specific unit, as it won't list the dependencies declared by units currently not loaded.</para>
369 </listitem>
370 </varlistentry>
371
372 <!-- Commands that modify unit state start here -->
373
e1fac8a6
ZJS
374 <varlistentry>
375 <term><command>start <replaceable>PATTERN</replaceable>…</command></term>
1238ee09 376
e1fac8a6 377 <listitem>
1d56bc09
ZJS
378 <para>Start (activate) one or more units specified on the command line.</para>
379
380 <para>Note that unit glob patterns expand to names of units currently in memory. Units which are
381 not active and are not in a failed state usually are not in memory, and will not be matched by
382 any pattern. In addition, in case of instantiated units, systemd is often unaware of the instance
383 name until the instance has been started. Therefore, using glob patterns with
384 <command>start</command> has limited usefulness. Also, secondary alias names of units are not
385 considered.</para>
386
387 <para>Option <option>--all</option> may be used to also operate on inactive units which are
388 referenced by other loaded units. Note that this is not the same as operating on "all" possible
389 units, because as the previous paragraph describes, such a list is ill-defined. Nevertheless,
390 <command>systemctl start --all <replaceable>GLOB</replaceable></command> may be useful if all the
391 units that should match the pattern are pulled in by some target which is known to be loaded.
392 </para>
e1fac8a6
ZJS
393 </listitem>
394 </varlistentry>
395 <varlistentry>
396 <term><command>stop <replaceable>PATTERN</replaceable>…</command></term>
afba4199 397
e1fac8a6
ZJS
398 <listitem>
399 <para>Stop (deactivate) one or more units specified on the command line.</para>
9029f642 400
e1fac8a6
ZJS
401 <para>This command will fail if the unit does not exist or if stopping of the unit is prohibited (see
402 <varname>RefuseManualStop=</varname> in
403 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
404 It will <emphasis>not</emphasis> fail if any of the commands configured to stop the unit
405 (<varname>ExecStop=</varname>, etc.) fail, because the manager will still forcibly terminate the
406 unit.</para>
407 </listitem>
408 </varlistentry>
409 <varlistentry>
410 <term><command>reload <replaceable>PATTERN</replaceable>…</command></term>
f6375e83 411
e1fac8a6
ZJS
412 <listitem>
413 <para>Asks all units listed on the command line to reload
414 their configuration. Note that this will reload the
415 service-specific configuration, not the unit configuration
416 file of systemd. If you want systemd to reload the
417 configuration file of a unit, use the
418 <command>daemon-reload</command> command. In other words:
419 for the example case of Apache, this will reload Apache's
420 <filename>httpd.conf</filename> in the web server, not the
421 <filename>apache.service</filename> systemd unit
422 file.</para>
82948f6c 423
e1fac8a6
ZJS
424 <para>This command should not be confused with the
425 <command>daemon-reload</command> command.</para>
426 </listitem>
9029f642 427
e1fac8a6
ZJS
428 </varlistentry>
429 <varlistentry>
430 <term><command>restart <replaceable>PATTERN</replaceable>…</command></term>
afba4199 431
e1fac8a6
ZJS
432 <listitem>
433 <para>Stop and then start one or more units specified on the command line. If the units are not running
434 yet, they will be started.</para>
afba4199 435
e1fac8a6
ZJS
436 <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
437 resources before it is started again. For example, the per-service file descriptor storage facility (see
438 <varname>FileDescriptorStoreMax=</varname> in
439 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
440 remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
441 no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
442 restart operation an explicit <command>systemctl stop</command> command followed by <command>systemctl
443 start</command> should be issued.</para>
444 </listitem>
445 </varlistentry>
446 <varlistentry>
447 <term><command>try-restart <replaceable>PATTERN</replaceable>…</command></term>
4a6022f0 448
e1fac8a6
ZJS
449 <listitem>
450 <para>Stop and then start one or more units specified on the
451 command line if the units are running. This does nothing
452 if units are not running.</para>
453 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
454 don't document that. -->
455 </listitem>
456 </varlistentry>
457 <varlistentry>
458 <term><command>reload-or-restart <replaceable>PATTERN</replaceable>…</command></term>
4a6022f0 459
e1fac8a6
ZJS
460 <listitem>
461 <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
462 are not running yet, they will be started.</para>
463 </listitem>
464 </varlistentry>
465 <varlistentry>
466 <term><command>try-reload-or-restart <replaceable>PATTERN</replaceable>…</command></term>
4f9a9105 467
e1fac8a6
ZJS
468 <listitem>
469 <para>Reload one or more units if they support it. If not, stop and then start them instead. This does
470 nothing if the units are not running.</para>
471 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
472 don't document that. -->
473 </listitem>
474 </varlistentry>
475 <varlistentry>
476 <term><command>isolate <replaceable>UNIT</replaceable></command></term>
4f9a9105 477
e1fac8a6
ZJS
478 <listitem>
479 <para>Start the unit specified on the command line and its dependencies
480 and stop all others, unless they have
481 <option>IgnoreOnIsolate=yes</option> (see
482 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
483 If a unit name with no extension is given, an extension of
484 <literal>.target</literal> will be assumed.</para>
991f2a39 485
5cf821ac
ZJS
486 <para>This command is dangerous, since it will immediately stop processes that are not enabled in
487 the new target, possibly including the graphical environment or terminal you are currently using.
488 </para>
991f2a39 489
483bf564 490 <para>Note that this operation is allowed only on units where
e1fac8a6
ZJS
491 <option>AllowIsolate=</option> is enabled. See
492 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
493 for details.</para>
494 </listitem>
495 </varlistentry>
496 <varlistentry>
497 <term><command>kill <replaceable>PATTERN</replaceable>…</command></term>
23ade460 498
e1fac8a6
ZJS
499 <listitem>
500 <para>Send a signal to one or more processes of the
4ccde410 501 unit. Use <option>--kill-whom=</option> to select which
e1fac8a6
ZJS
502 process to kill. Use <option>--signal=</option> to select
503 the signal to send.</para>
504 </listitem>
505 </varlistentry>
506 <varlistentry>
507 <term><command>clean <replaceable>PATTERN</replaceable>…</command></term>
4dc5b821 508
e1fac8a6
ZJS
509 <listitem>
510 <para>Remove the configuration, state, cache, logs or runtime data of the specified units. Use
511 <option>--what=</option> to select which kind of resource to remove. For service units this may
512 be used to remove the directories configured with <varname>ConfigurationDirectory=</varname>,
513 <varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>,
514 <varname>LogsDirectory=</varname> and <varname>RuntimeDirectory=</varname>, see
515 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
516 for details. For timer units this may be used to clear out the persistent timestamp data if
517 <varname>Persistent=</varname> is used and <option>--what=state</option> is selected, see
518 <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>. This
519 command only applies to units that use either of these settings. If <option>--what=</option> is
520 not specified, both the cache and runtime data are removed (as these two types of data are
521 generally redundant and reproducible on the next invocation of the unit).</para>
522 </listitem>
523 </varlistentry>
d9e45bc3
MS
524 <varlistentry>
525 <term><command>freeze <replaceable>PATTERN</replaceable>…</command></term>
526
527 <listitem>
528 <para>Freeze one or more units specified on the
529 command line using cgroup freezer</para>
530
531 <para>Freezing the unit will cause all processes contained within the cgroup corresponding to the unit
532 to be suspended. Being suspended means that unit's processes won't be scheduled to run on CPU until thawed.
533 Note that this command is supported only on systems that use unified cgroup hierarchy. Unit is automatically
534 thawed just before we execute a job against the unit, e.g. before the unit is stopped.</para>
535 </listitem>
536 </varlistentry>
537 <varlistentry>
538 <term><command>thaw <replaceable>PATTERN</replaceable>…</command></term>
539
540 <listitem>
541 <para>Thaw (unfreeze) one or more units specified on the
542 command line.</para>
543
544 <para>This is the inverse operation to the <command>freeze</command> command and resumes the execution of
545 processes in the unit's cgroup.</para>
546 </listitem>
547 </varlistentry>
e1fac8a6
ZJS
548 <varlistentry>
549 <term><command>set-property <replaceable>UNIT</replaceable> <replaceable>PROPERTY</replaceable>=<replaceable>VALUE</replaceable>…</command></term>
1ae17672 550
e1fac8a6
ZJS
551 <listitem>
552 <para>Set the specified unit properties at runtime where
553 this is supported. This allows changing configuration
554 parameter properties such as resource control settings at
555 runtime. Not all properties may be changed at runtime, but
556 many resource control settings (primarily those in
557 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
558 may. The changes are applied immediately, and stored on disk
559 for future boots, unless <option>--runtime</option> is
560 passed, in which case the settings only apply until the
561 next reboot. The syntax of the property assignment follows
562 closely the syntax of assignments in unit files.</para>
4a6022f0 563
e1fac8a6 564 <para>Example: <command>systemctl set-property foobar.service CPUWeight=200</command></para>
4a6022f0 565
e1fac8a6
ZJS
566 <para>If the specified unit appears to be inactive, the
567 changes will be only stored on disk as described
568 previously hence they will be effective when the unit will
569 be started.</para>
4a6022f0 570
e1fac8a6
ZJS
571 <para>Note that this command allows changing multiple properties at the same time, which is
572 preferable over setting them individually.</para>
93a08841 573
e1fac8a6 574 <para>Example: <command>systemctl set-property foobar.service CPUWeight=200 MemoryMax=2G IPAccounting=yes</command></para>
93a08841 575
e1fac8a6
ZJS
576 <para>Like with unit file configuration settings, assigning an empty setting usually resets a
577 property to its defaults.</para>
adb6cd9b 578
e1fac8a6
ZJS
579 <para>Example: <command>systemctl set-property avahi-daemon.service IPAddressDeny=</command></para>
580 </listitem>
581 </varlistentry>
4a6022f0 582
5e8deb94 583 <varlistentry>
e04eae5e
ZJS
584 <term>
585 <command>bind</command>
586 <replaceable>UNIT</replaceable>
587 <replaceable>PATH</replaceable>
588 [<replaceable>PATH</replaceable>]
589 </term>
590
591 <listitem><para>Bind-mounts a file or directory from the host into the specified unit's mount
592 namespace. The first path argument is the source file or directory on the host, the second path
593 argument is the destination file or directory in the unit's mount namespace. When the latter is
594 omitted, the destination path in the unit's mount namespace is the same as the source path on the
595 host. When combined with the <option>--read-only</option> switch, a ready-only bind mount is
596 created. When combined with the <option>--mkdir</option> switch, the destination path is first
597 created before the mount is applied.</para>
598
599 <para>Note that this option is currently only supported for units that run within a mount namespace
600 (e.g.: with <option>RootImage=</option>, <option>PrivateMounts=</option>, etc.). This command
601 supports bind-mounting directories, regular files, device nodes, <constant>AF_UNIX</constant>
602 socket nodes, as well as FIFOs. The bind mount is ephemeral, and it is undone as soon as the
603 current unit process exists. Note that the namespace mentioned here, where the bind mount will be
604 added to, is the one where the main service process runs. Other processes (those exececuted by
605 <option>ExecReload=</option>, <option>ExecStartPre=</option>, etc.) run in distinct namespaces.
606 </para></listitem>
607 </varlistentry>
608
609 <varlistentry>
610 <term>
611 <command>mount-image</command>
612 <replaceable>UNIT</replaceable>
613 <replaceable>IMAGE</replaceable>
614 [<replaceable>PATH</replaceable>
615 [<replaceable>PARTITION_NAME</replaceable>:<replaceable>MOUNT_OPTIONS</replaceable>]]
616 </term>
617
618 <listitem><para>Mounts an image from the host into the specified unit's mount namespace. The first
619 path argument is the source image on the host, the second path argument is the destination
620 directory in the unit's mount namespace (i.e. inside
621 <option>RootImage=</option>/<option>RootDirectory=</option>). The following argument, if any, is
622 interpreted as a colon-separated tuple of partition name and comma-separated list of mount options
623 for that partition. The format is the same as the service <option>MountImages=</option>
624 setting. When combined with the <option>--read-only</option> switch, a ready-only mount is
625 created. When combined with the <option>--mkdir</option> switch, the destination path is first
626 created before the mount is applied.</para>
627
628 <para>Note that this option is currently only supported for units that run within a mount namespace
629 (i.e. with <option>RootImage=</option>, <option>PrivateMounts=</option>, etc.). Note that the
630 namespace mentioned here where the image mount will be added to, is the one where the main service
631 process runs. Note that the namespace mentioned here, where the bind mount will be
632 added to, is the one where the main service process runs. Other processes (those exececuted by
633 <option>ExecReload=</option>, <option>ExecStartPre=</option>, etc.) run in distinct namespaces.
634 </para>
635
636 <para>Example:
6faecbd3 637 <programlisting>systemctl mount-image foo.service /tmp/img.raw /var/lib/image root:ro,nosuid</programlisting>
e04eae5e
ZJS
638 <programlisting>systemctl mount-image --mkdir bar.service /tmp/img.raw /var/lib/baz/img</programlisting>
639 </para></listitem>
6faecbd3
LB
640 </varlistentry>
641
6824c132
ZJS
642 <varlistentry>
643 <term><command>service-log-level</command> <replaceable>SERVICE</replaceable> [<replaceable>LEVEL</replaceable>]</term>
644
645 <listitem><para>If the <replaceable>LEVEL</replaceable> argument is not given, print the current
646 log level as reported by service <replaceable>SERVICE</replaceable>.</para>
647
648 <para>If the optional argument <replaceable>LEVEL</replaceable> is provided, then change the
649 current log level of the service to <replaceable>LEVEL</replaceable>. The log level should be a
650 typical syslog log level, i.e. a value in the range 0…7 or one of the strings
651 <constant>emerg</constant>, <constant>alert</constant>, <constant>crit</constant>,
652 <constant>err</constant>, <constant>warning</constant>, <constant>notice</constant>,
653 <constant>info</constant>, <constant>debug</constant>; see <citerefentry
654 project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
655 for details.</para>
656
657 <para>The service must have the appropriate
658 <varname>BusName=<replaceable>destination</replaceable></varname> property and also implement the
659 generic
660 <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
661 interface. (<filename>systemctl</filename> will use the generic D-Bus protocol to access the
662 <interfacename>org.freedesktop.LogControl1.LogLevel</interfacename> interface for the D-Bus name
663 <replaceable>destination</replaceable>.)</para></listitem>
664 </varlistentry>
665
666 <varlistentry>
667 <term><command>service-log-target</command> <replaceable>SERVICE</replaceable> [<replaceable>TARGET</replaceable>]</term>
668
669 <listitem><para>If the <replaceable>TARGET</replaceable> argument is not given, print the current
670 log target as reported by service <replaceable>SERVICE</replaceable>.</para>
671
672 <para>If the optional argument <replaceable>TARGET</replaceable> is provided, then change the
673 current log target of the service to <replaceable>TARGET</replaceable>. The log target should be
674 one of the strings <constant>console</constant> (for log output to the service's standard error
675 stream), <constant>kmsg</constant> (for log output to the kernel log buffer),
676 <constant>journal</constant> (for log output to
677 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
678 using the native journal protocol), <constant>syslog</constant> (for log output to the classic
679 syslog socket <filename>/dev/log</filename>), <constant>null</constant> (for no log output
680 whatsoever) or <constant>auto</constant> (for an automatically determined choice, typically
681 equivalent to <constant>console</constant> if the service is invoked interactively, and
682 <constant>journal</constant> or <constant>syslog</constant> otherwise).</para>
683
684 <para>For most services, only a small subset of log targets make sense. In particular, most
685 "normal" services should only implement <constant>console</constant>, <constant>journal</constant>,
686 and <constant>null</constant>. Anything else is only appropriate for low-level services that
687 are active in very early boot before proper logging is established.</para>
688
689 <para>The service must have the appropriate
690 <varname>BusName=<replaceable>destination</replaceable></varname> property and also implement the
691 generic
692 <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
693 interface. (<filename>systemctl</filename> will use the generic D-Bus protocol to access the
694 <interfacename>org.freedesktop.LogControl1.LogLevel</interfacename> interface for the D-Bus name
695 <replaceable>destination</replaceable>.)</para></listitem>
696 </varlistentry>
697
e1fac8a6
ZJS
698 <varlistentry>
699 <term><command>reset-failed [<replaceable>PATTERN</replaceable>…]</command></term>
599b6322 700
e1fac8a6
ZJS
701 <listitem>
702 <para>Reset the <literal>failed</literal> state of the specified units, or if no unit name is passed, reset
703 the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
704 terminating abnormally or timing out), it will automatically enter the <literal>failed</literal> state and
705 its exit code and status is recorded for introspection by the administrator until the service is
706 stopped/re-started or reset with this command.</para>
4a6022f0 707
e1fac8a6
ZJS
708 <para>In addition to resetting the <literal>failed</literal> state of a unit it also resets various other
709 per-unit properties: the start rate limit counter of all unit types is reset to zero, as is the restart
710 counter of service units. Thus, if a unit's start limit (as configured with
711 <varname>StartLimitIntervalSec=</varname>/<varname>StartLimitBurst=</varname>) is hit and the unit refuses
712 to be started again, use this command to make it startable again.</para>
713 </listitem>
714 </varlistentry>
e1fac8a6
ZJS
715 </variablelist>
716 </refsect2>
4a6022f0 717
e1fac8a6
ZJS
718 <refsect2>
719 <title>Unit File Commands</title>
4a6022f0 720
e1fac8a6
ZJS
721 <variablelist>
722 <varlistentry>
723 <term><command>list-unit-files</command> <optional><replaceable>PATTERN…</replaceable></optional></term>
4a6022f0 724
e1fac8a6 725 <listitem>
7ea5e82f
LP
726 <para>List unit files installed on the system, in combination with their enablement state (as
727 reported by <command>is-enabled</command>). If one or more <replaceable>PATTERN</replaceable>s
728 are specified, only unit files whose name matches one of them are shown (patterns matching unit
729 file system paths are not supported).</para>
730
731 <para>Unlike <command>list-units</command> this command will list template units in addition to
732 explicitly instantiated units.</para>
e1fac8a6
ZJS
733 </listitem>
734 </varlistentry>
4a6022f0 735
e1fac8a6
ZJS
736 <varlistentry>
737 <term><command>enable <replaceable>UNIT</replaceable>…</command></term>
738 <term><command>enable <replaceable>PATH</replaceable>…</command></term>
4a6022f0 739
e1fac8a6
ZJS
740 <listitem>
741 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
bdac5608 742 [Install] sections of the indicated unit files. After the symlinks have been created,
e1fac8a6
ZJS
743 the system manager configuration is reloaded (in a way equivalent to <command>daemon-reload</command>), in
744 order to ensure the changes are taken into account immediately. Note that this does
745 <emphasis>not</emphasis> have the effect of also starting any of the units being enabled. If this is
746 desired, combine this command with the <option>--now</option> switch, or invoke <command>start</command>
747 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
748 the form <filename>foo@bar.service</filename>), symlinks named the same as instances are created in the
749 unit configuration directory, however they point to the single template unit file they are instantiated
750 from.</para>
4a6022f0 751
e1fac8a6
ZJS
752 <para>This command expects either valid unit names (in which case various unit file directories are
753 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
754 case these files are read directly). If a specified unit file is located outside of the usual unit file
755 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
756 it is found when requested by commands such as <command>start</command>. The file system where the linked
757 unit files are located must be accessible when systemd is started (e.g. anything underneath
3b121157 758 <filename>/home/</filename> or <filename>/var/</filename> is not allowed, unless those directories are
e1fac8a6 759 located on the root file system).</para>
4a6022f0 760
e1fac8a6
ZJS
761 <para>This command will print the file system operations executed. This output may be suppressed by passing
762 <option>--quiet</option>.
763 </para>
8c8208cb 764
bdac5608 765 <para>Note that this operation creates only the symlinks suggested in the [Install]
e1fac8a6
ZJS
766 section of the unit files. While this command is the recommended way to manipulate the unit configuration
767 directory, the administrator is free to make additional changes manually by placing or removing symlinks
768 below this directory. This is particularly useful to create configurations that deviate from the suggested
769 default installation. In this case, the administrator must make sure to invoke
770 <command>daemon-reload</command> manually as necessary, in order to ensure the changes are taken into
771 account.
772 </para>
8c8208cb 773
e1fac8a6
ZJS
774 <para>Enabling units should not be confused with starting (activating) units, as done by the
775 <command>start</command> command. Enabling and starting units is orthogonal: units may be enabled without
776 being started and started without being enabled. Enabling simply hooks the unit into various suggested
777 places (for example, so that the unit is automatically started on boot or when a particular kind of
778 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
779 the socket (in case of socket units), and so on.</para>
4a6022f0 780
e1fac8a6
ZJS
781 <para>Depending on whether <option>--system</option>, <option>--user</option>, <option>--runtime</option>,
782 or <option>--global</option> is specified, this enables the unit for the system, for the calling user only,
783 for only this boot of the system, or for all future logins of all users. Note that in the last case, no
784 systemd daemon configuration is reloaded.</para>
4a6022f0 785
e1fac8a6
ZJS
786 <para>Using <command>enable</command> on masked units is not supported and results in an error.</para>
787 </listitem>
788 </varlistentry>
39c38ce1 789
e1fac8a6
ZJS
790 <varlistentry>
791 <term><command>disable <replaceable>UNIT</replaceable>…</command></term>
4a6022f0 792
e1fac8a6
ZJS
793 <listitem>
794 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
795 from the unit configuration directory, and hence undoes any changes made by <command>enable</command> or
796 <command>link</command>. Note that this removes <emphasis>all</emphasis> symlinks to matching unit files,
797 including manually created symlinks, and not just those actually created by <command>enable</command> or
798 <command>link</command>. Note that while <command>disable</command> undoes the effect of
799 <command>enable</command>, the two commands are otherwise not symmetric, as <command>disable</command> may
800 remove more symlinks than a prior <command>enable</command> invocation of the same unit created.</para>
9ef15026 801
e1fac8a6 802 <para>This command expects valid unit names only, it does not accept paths to unit files.</para>
9ef15026 803
e1fac8a6 804 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
bdac5608 805 <varname>Also=</varname> setting contained in the [Install] section of any of the unit
e1fac8a6 806 files being operated on.</para>
57ab2eab 807
e1fac8a6
ZJS
808 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
809 that this command does not implicitly stop the units that are being disabled. If this is desired, either
810 combine this command with the <option>--now</option> switch, or invoke the <command>stop</command> command
811 with appropriate arguments later.</para>
57ab2eab 812
e1fac8a6
ZJS
813 <para>This command will print information about the file system operations (symlink removals)
814 executed. This output may be suppressed by passing <option>--quiet</option>.
815 </para>
4a6022f0 816
e1fac8a6
ZJS
817 <para>This command honors <option>--system</option>, <option>--user</option>, <option>--runtime</option>
818 and <option>--global</option> in a similar way as <command>enable</command>.</para>
819 </listitem>
820 </varlistentry>
4a6022f0 821
e1fac8a6
ZJS
822 <varlistentry>
823 <term><command>reenable <replaceable>UNIT</replaceable>…</command></term>
4a6022f0 824
e1fac8a6
ZJS
825 <listitem>
826 <para>Reenable one or more units, as specified on the command line. This is a combination of
827 <command>disable</command> and <command>enable</command> and is useful to reset the symlinks a unit file is
bdac5608 828 enabled with to the defaults configured in its [Install] section. This command expects
e1fac8a6
ZJS
829 a unit name only, it does not accept paths to unit files.</para>
830 </listitem>
831 </varlistentry>
4a6022f0 832
e1fac8a6
ZJS
833 <varlistentry>
834 <term><command>preset <replaceable>UNIT</replaceable>…</command></term>
a330b376 835
e1fac8a6
ZJS
836 <listitem>
837 <para>Reset the enable/disable status one or more unit files, as specified on
838 the command line, to the defaults configured in the preset policy files. This
839 has the same effect as <command>disable</command> or
840 <command>enable</command>, depending how the unit is listed in the preset
841 files.</para>
4a6022f0 842
e1fac8a6
ZJS
843 <para>Use <option>--preset-mode=</option> to control whether units shall be
844 enabled and disabled, or only enabled, or only disabled.</para>
d309c1c3 845
e1fac8a6
ZJS
846 <para>If the unit carries no install information, it will be silently ignored
847 by this command. <replaceable>UNIT</replaceable> must be the real unit name,
848 any alias names are ignored silently.</para>
d309c1c3 849
e1fac8a6
ZJS
850 <para>For more information on the preset policy format, see
851 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
7e215af7 852 </para>
e1fac8a6
ZJS
853 </listitem>
854 </varlistentry>
4a6022f0 855
e1fac8a6
ZJS
856 <varlistentry>
857 <term><command>preset-all</command></term>
4a6022f0 858
e1fac8a6
ZJS
859 <listitem>
860 <para>Resets all installed unit files to the defaults
861 configured in the preset policy file (see above).</para>
4a6022f0 862
e1fac8a6
ZJS
863 <para>Use <option>--preset-mode=</option> to control
864 whether units shall be enabled and disabled, or only
865 enabled, or only disabled.</para>
866 </listitem>
867 </varlistentry>
4a6022f0 868
27722f96 869 <varlistentry>
e1fac8a6 870 <term><command>is-enabled <replaceable>UNIT</replaceable>…</command></term>
4a6022f0 871
27722f96 872 <listitem>
e1fac8a6
ZJS
873 <para>Checks whether any of the specified unit files are
874 enabled (as with <command>enable</command>). Returns an
875 exit code of 0 if at least one is enabled, non-zero
876 otherwise. Prints the current enable status (see table).
877 To suppress this output, use <option>--quiet</option>.
878 To show installation targets, use <option>--full</option>.
879 </para>
6fdbb3c8 880
e1fac8a6
ZJS
881 <table>
882 <title>
883 <command>is-enabled</command> output
884 </title>
6fdbb3c8 885
e1fac8a6
ZJS
886 <tgroup cols='3'>
887 <thead>
888 <row>
889 <entry>Name</entry>
890 <entry>Description</entry>
891 <entry>Exit Code</entry>
892 </row>
893 </thead>
894 <tbody>
895 <row>
896 <entry><literal>enabled</literal></entry>
897 <entry morerows='1'>Enabled via <filename>.wants/</filename>, <filename>.requires/</filename> or <varname>Alias=</varname> symlinks (permanently in <filename>/etc/systemd/system/</filename>, or transiently in <filename>/run/systemd/system/</filename>).</entry>
898 <entry morerows='1'>0</entry>
899 </row>
900 <row>
901 <entry><literal>enabled-runtime</literal></entry>
902 </row>
903 <row>
904 <entry><literal>linked</literal></entry>
905 <entry morerows='1'>Made available through one or more symlinks to the unit file (permanently in <filename>/etc/systemd/system/</filename> or transiently in <filename>/run/systemd/system/</filename>), even though the unit file might reside outside of the unit file search path.</entry>
906 <entry morerows='1'>&gt; 0</entry>
907 </row>
908 <row>
909 <entry><literal>linked-runtime</literal></entry>
910 </row>
15d7ab87
ZJS
911 <row>
912 <entry><literal>alias</literal></entry>
913 <entry>The name is an alias (symlink to another unit file).</entry>
914 <entry>0</entry>
915 </row>
e1fac8a6
ZJS
916 <row>
917 <entry><literal>masked</literal></entry>
918 <entry morerows='1'>Completely disabled, so that any start operation on it fails (permanently in <filename>/etc/systemd/system/</filename> or transiently in <filename>/run/systemd/systemd/</filename>).</entry>
919 <entry morerows='1'>&gt; 0</entry>
920 </row>
921 <row>
922 <entry><literal>masked-runtime</literal></entry>
923 </row>
924 <row>
925 <entry><literal>static</literal></entry>
bdac5608 926 <entry>The unit file is not enabled, and has no provisions for enabling in the [Install] unit file section.</entry>
e1fac8a6
ZJS
927 <entry>0</entry>
928 </row>
929 <row>
930 <entry><literal>indirect</literal></entry>
bdac5608 931 <entry>The unit file itself is not enabled, but it has a non-empty <varname>Also=</varname> setting in the [Install] unit file section, listing other unit files that might be enabled, or it has an alias under a different name through a symlink that is not specified in <varname>Also=</varname>. For template unit files, an instance different than the one specified in <varname>DefaultInstance=</varname> is enabled.</entry>
e1fac8a6
ZJS
932 <entry>0</entry>
933 </row>
934 <row>
935 <entry><literal>disabled</literal></entry>
bdac5608 936 <entry>The unit file is not enabled, but contains an [Install] section with installation instructions.</entry>
e1fac8a6
ZJS
937 <entry>&gt; 0</entry>
938 </row>
939 <row>
940 <entry><literal>generated</literal></entry>
941 <entry>The unit file was generated dynamically via a generator tool. See <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Generated unit files may not be enabled, they are enabled implicitly by their generator.</entry>
942 <entry>0</entry>
943 </row>
944 <row>
945 <entry><literal>transient</literal></entry>
946 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.</entry>
947 <entry>0</entry>
948 </row>
949 <row>
950 <entry><literal>bad</literal></entry>
951 <entry>The unit file is invalid or another error occurred. Note that <command>is-enabled</command> will not actually return this state, but print an error message instead. However the unit file listing printed by <command>list-unit-files</command> might show it.</entry>
952 <entry>&gt; 0</entry>
953 </row>
954 </tbody>
955 </tgroup>
956 </table>
6fdbb3c8 957
27722f96
LN
958 </listitem>
959 </varlistentry>
991f2a39 960
27722f96 961 <varlistentry>
e1fac8a6 962 <term><command>mask <replaceable>UNIT</replaceable>…</command></term>
27722f96
LN
963
964 <listitem>
e1fac8a6
ZJS
965 <para>Mask one or more units, as specified on the command line. This will link these unit files to
966 <filename>/dev/null</filename>, making it impossible to start them. This is a stronger version of
967 <command>disable</command>, since it prohibits all kinds of activation of the unit, including enablement
968 and manual activation. Use this option with care. This honors the <option>--runtime</option> option to only
969 mask temporarily until the next reboot of the system. The <option>--now</option> option may be used to
970 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
971 file paths.</para>
27722f96
LN
972 </listitem>
973 </varlistentry>
974
cbb76c29 975 <varlistentry>
e1fac8a6 976 <term><command>unmask <replaceable>UNIT</replaceable>…</command></term>
cbb76c29
LP
977
978 <listitem>
e1fac8a6
ZJS
979 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
980 <command>mask</command>. This command expects valid unit names only, it does not accept unit file
981 paths.</para>
982 </listitem>
983 </varlistentry>
cbb76c29 984
e1fac8a6
ZJS
985 <varlistentry>
986 <term><command>link <replaceable>PATH</replaceable>…</command></term>
ccdda955 987
e1fac8a6
ZJS
988 <listitem>
989 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
990 command expects an absolute path to a unit file. The effect of this may be undone with
991 <command>disable</command>. The effect of this command is that a unit file is made available for commands
992 such as <command>start</command>, even though it is not installed directly in the unit search path. The
993 file system where the linked unit files are located must be accessible when systemd is started
3b121157 994 (e.g. anything underneath <filename>/home/</filename> or <filename>/var/</filename> is not allowed, unless
e1fac8a6 995 those directories are located on the root file system).</para>
cbb76c29
LP
996 </listitem>
997 </varlistentry>
998
27722f96 999 <varlistentry>
e1fac8a6 1000 <term><command>revert <replaceable>UNIT</replaceable>…</command></term>
27722f96
LN
1001
1002 <listitem>
e1fac8a6
ZJS
1003 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
1004 files that modify the specified units, as well as any user-configured unit file that overrides a matching
1005 vendor supplied unit file. Specifically, for a unit <literal>foo.service</literal> the matching directories
1006 <literal>foo.service.d/</literal> with all their contained files are removed, both below the persistent and
1007 runtime configuration directories (i.e. below <filename>/etc/systemd/system</filename> and
1008 <filename>/run/systemd/system</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
3b121157 1009 located below <filename>/usr/</filename>) any matching persistent or runtime unit file that overrides it is
e1fac8a6
ZJS
1010 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
1011 <filename>/etc/systemd/system</filename> or <filename>/run/systemd/system</filename>, but not in a unit
3b121157 1012 file stored below <filename>/usr/</filename>), then it is not removed. Also, if a unit is masked, it is
e1fac8a6
ZJS
1013 unmasked.</para>
1014
1015 <para>Effectively, this command may be used to undo all changes made with <command>systemctl
1016 edit</command>, <command>systemctl set-property</command> and <command>systemctl mask</command> and puts
1017 the original unit file with its settings back in effect.</para>
27722f96
LN
1018 </listitem>
1019 </varlistentry>
e1fac8a6 1020
27722f96 1021 <varlistentry>
e1fac8a6
ZJS
1022 <term><command>add-wants <replaceable>TARGET</replaceable>
1023 <replaceable>UNIT</replaceable>…</command></term>
1024 <term><command>add-requires <replaceable>TARGET</replaceable>
1025 <replaceable>UNIT</replaceable>…</command></term>
27722f96
LN
1026
1027 <listitem>
e1fac8a6
ZJS
1028 <para>Adds <literal>Wants=</literal> or <literal>Requires=</literal>
1029 dependencies, respectively, to the specified
1030 <replaceable>TARGET</replaceable> for one or more units. </para>
1031
1032 <para>This command honors <option>--system</option>,
1033 <option>--user</option>, <option>--runtime</option> and
1034 <option>--global</option> in a way similar to
1035 <command>enable</command>.</para>
4f0acdb3 1036
27722f96
LN
1037 </listitem>
1038 </varlistentry>
e1fac8a6 1039
27722f96 1040 <varlistentry>
e1fac8a6 1041 <term><command>edit <replaceable>UNIT</replaceable>…</command></term>
27722f96
LN
1042
1043 <listitem>
e1fac8a6
ZJS
1044 <para>Edit a drop-in snippet or a whole replacement file if
1045 <option>--full</option> is specified, to extend or override the
1046 specified unit.</para>
27722f96 1047
e1fac8a6
ZJS
1048 <para>Depending on whether <option>--system</option> (the default),
1049 <option>--user</option>, or <option>--global</option> is specified,
1050 this command creates a drop-in file for each unit either for the system,
1051 for the calling user, or for all futures logins of all users. Then,
1052 the editor (see the "Environment" section below) is invoked on
1053 temporary files which will be written to the real location if the
1054 editor exits successfully.</para>
27722f96 1055
e1fac8a6
ZJS
1056 <para>If <option>--full</option> is specified, this will copy the
1057 original units instead of creating drop-in files.</para>
27722f96 1058
e1fac8a6
ZJS
1059 <para>If <option>--force</option> is specified and any units do
1060 not already exist, new unit files will be opened for editing.</para>
c4f2aaa4 1061
e1fac8a6 1062 <para>If <option>--runtime</option> is specified, the changes will
3b121157 1063 be made temporarily in <filename>/run/</filename> and they will be
e1fac8a6
ZJS
1064 lost on the next reboot.</para>
1065
1066 <para>If the temporary file is empty upon exit, the modification of
1067 the related unit is canceled.</para>
1068
1069 <para>After the units have been edited, systemd configuration is
1070 reloaded (in a way that is equivalent to <command>daemon-reload</command>).
1071 </para>
1072
1073 <para>Note that this command cannot be used to remotely edit units
1074 and that you cannot temporarily edit units which are in
3b121157
ZJS
1075 <filename>/etc/</filename>, since they take precedence over
1076 <filename>/run/</filename>.</para>
27722f96
LN
1077 </listitem>
1078 </varlistentry>
e1fac8a6 1079
27722f96 1080 <varlistentry>
e1fac8a6 1081 <term><command>get-default</command></term>
27722f96
LN
1082
1083 <listitem>
e1fac8a6
ZJS
1084 <para>Return the default target to boot into. This returns
1085 the target unit name <filename>default.target</filename>
1086 is aliased (symlinked) to.</para>
27722f96
LN
1087 </listitem>
1088 </varlistentry>
e1fac8a6 1089
27722f96 1090 <varlistentry>
e1fac8a6 1091 <term><command>set-default <replaceable>TARGET</replaceable></command></term>
27722f96
LN
1092
1093 <listitem>
e1fac8a6
ZJS
1094 <para>Set the default target to boot into. This sets
1095 (symlinks) the <filename>default.target</filename> alias
1096 to the given target unit.</para>
27722f96
LN
1097 </listitem>
1098 </varlistentry>
e1fac8a6
ZJS
1099
1100 </variablelist>
1101 </refsect2>
1102
1103 <refsect2>
1104 <title>Machine Commands</title>
1105
1106 <variablelist>
27722f96 1107 <varlistentry>
e1fac8a6 1108 <term><command>list-machines</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
27722f96
LN
1109
1110 <listitem>
e1fac8a6
ZJS
1111 <para>List the host and all running local containers with
1112 their state. If one or more
1113 <replaceable>PATTERN</replaceable>s are specified, only
1114 containers matching one of them are shown.
1115 </para>
27722f96
LN
1116 </listitem>
1117 </varlistentry>
e1fac8a6
ZJS
1118 </variablelist>
1119 </refsect2>
1120
1121 <refsect2>
1122 <title>Job Commands</title>
1123
1124 <variablelist>
27722f96 1125 <varlistentry>
e1fac8a6 1126 <term><command>list-jobs <optional><replaceable>PATTERN…</replaceable></optional></command></term>
27722f96
LN
1127
1128 <listitem>
e1fac8a6
ZJS
1129 <para>List jobs that are in progress. If one or more
1130 <replaceable>PATTERN</replaceable>s are specified, only
1131 jobs for units matching one of them are shown.</para>
27722f96 1132
e1fac8a6
ZJS
1133 <para>When combined with <option>--after</option> or <option>--before</option> the list is augmented with
1134 information on which other job each job is waiting for, and which other jobs are waiting for it, see
1135 above.</para>
27722f96
LN
1136 </listitem>
1137 </varlistentry>
1138 <varlistentry>
e1fac8a6 1139 <term><command>cancel <replaceable>JOB</replaceable>…</command></term>
27722f96
LN
1140
1141 <listitem>
e1fac8a6
ZJS
1142 <para>Cancel one or more jobs specified on the command line
1143 by their numeric job IDs. If no job ID is specified, cancel
1144 all pending jobs.</para>
27722f96
LN
1145 </listitem>
1146 </varlistentry>
e1fac8a6
ZJS
1147 </variablelist>
1148 </refsect2>
1149
1150 <refsect2>
1151 <title>Environment Commands</title>
1152
0dc9fd56
ZJS
1153 <para><command>systemd</command> supports an environment block that is passed to processes the manager
1154 spawns. The names of the variables can contain ASCII letters, digits, and the underscore
1155 character. Variable names cannot be empty or start with a digit. In variable values, most characters
30927a24
ZJS
1156 are allowed, but the whole sequence must be valid UTF-8. (Note that control characters like newline
1157 (<constant>NL</constant>), tab (<constant>TAB</constant>), or the escape character
1158 (<constant>ESC</constant>), <emphasis>are</emphasis> valid ASCII and thus valid UTF-8). The total
1159 length of the environment block is limited to <constant>_SC_ARG_MAX</constant> value defined by
0dc9fd56
ZJS
1160 <citerefentry project='man-pages'><refentrytitle>sysconf</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1161 </para>
1162
e1fac8a6 1163 <variablelist>
8c8208cb 1164 <varlistentry>
e1fac8a6 1165 <term><command>show-environment</command></term>
8c8208cb
LP
1166
1167 <listitem>
e1fac8a6
ZJS
1168 <para>Dump the systemd manager environment block. This is the environment
1169 block that is passed to all processes the manager spawns. The environment
4bb37359 1170 block will be dumped in straightforward form suitable for sourcing into
e1fac8a6
ZJS
1171 most shells. If no special characters or whitespace is present in the variable
1172 values, no escaping is performed, and the assignments have the form
1173 <literal>VARIABLE=value</literal>. If whitespace or characters which have
1174 special meaning to the shell are present, dollar-single-quote escaping is
1175 used, and assignments have the form <literal>VARIABLE=$'value'</literal>.
1176 This syntax is known to be supported by
1177 <citerefentry project='die-net'><refentrytitle>bash</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1178 <citerefentry project='die-net'><refentrytitle>zsh</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1179 <citerefentry project='die-net'><refentrytitle>ksh</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1180 and
1181 <citerefentry project='die-net'><refentrytitle>busybox</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
1182 <citerefentry project='die-net'><refentrytitle>ash</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1183 but not
1184 <citerefentry project='die-net'><refentrytitle>dash</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1185 or
1186 <citerefentry project='die-net'><refentrytitle>fish</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1187 </para>
8c8208cb
LP
1188 </listitem>
1189 </varlistentry>
27722f96 1190 <varlistentry>
e1fac8a6 1191 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>…</command></term>
27722f96
LN
1192
1193 <listitem>
0dc9fd56
ZJS
1194 <para>Set one or more systemd manager environment variables, as specified on the command
1195 line. This command will fail if variable names and values do not conform to the rules listed
1196 above.</para>
27722f96
LN
1197 </listitem>
1198 </varlistentry>
1199 <varlistentry>
e1fac8a6 1200 <term><command>unset-environment <replaceable>VARIABLE</replaceable>…</command></term>
27722f96
LN
1201
1202 <listitem>
e1fac8a6
ZJS
1203 <para>Unset one or more systemd manager environment
1204 variables. If only a variable name is specified, it will be
1205 removed regardless of its value. If a variable and a value
1206 are specified, the variable is only removed if it has the
1207 specified value.</para>
27722f96
LN
1208 </listitem>
1209 </varlistentry>
1210 <varlistentry>
e1fac8a6
ZJS
1211 <term>
1212 <command>import-environment</command>
32854f70 1213 <replaceable>VARIABLE…</replaceable>
e1fac8a6 1214 </term>
27722f96
LN
1215
1216 <listitem>
0dc9fd56 1217 <para>Import all, one or more environment variables set on the client into the systemd manager
82651d5b
ZJS
1218 environment block. If a list of environment variable names is passed, client-side values are then
1219 imported into the manager's environment block. If any names are not valid environment variable
1220 names or have invalid values according to the rules described above, an error is raised. If no
1221 arguments are passed, the entire environment block inherited by the <command>systemctl</command>
1222 process is imported. In this mode, any inherited invalid environment variables are quietly
1223 ignored.</para>
32854f70
ZJS
1224
1225 <para>Importing of the full inherited environment block (calling this command without any
1226 arguments) is deprecated. A shell will set dozens of variables which only make sense locally and
1227 are only meant for processes which are descendants of the shell. Such variables in the global
1228 environment block are confusing to other processes.</para>
27722f96
LN
1229 </listitem>
1230 </varlistentry>
e1fac8a6
ZJS
1231 </variablelist>
1232 </refsect2>
1233
1234 <refsect2>
38fcb7f7 1235 <title>Manager State Commands</title>
e1fac8a6
ZJS
1236
1237 <variablelist>
27722f96 1238 <varlistentry>
e1fac8a6 1239 <term><command>daemon-reload</command></term>
27722f96
LN
1240
1241 <listitem>
e1fac8a6
ZJS
1242 <para>Reload the systemd manager configuration. This will
1243 rerun all generators (see
1244 <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1245 reload all unit files, and recreate the entire dependency
1246 tree. While the daemon is being reloaded, all sockets
1247 systemd listens on behalf of user configuration will stay
1248 accessible.</para>
33d2308c 1249
e1fac8a6
ZJS
1250 <para>This command should not be confused with the
1251 <command>reload</command> command.</para>
27722f96
LN
1252 </listitem>
1253 </varlistentry>
38fcb7f7 1254
e93c33d4 1255 <varlistentry>
e1fac8a6 1256 <term><command>daemon-reexec</command></term>
27722f96 1257
e93c33d4 1258 <listitem>
e1fac8a6
ZJS
1259 <para>Reexecute the systemd manager. This will serialize the
1260 manager state, reexecute the process and deserialize the
1261 state again. This command is of little use except for
1262 debugging and package upgrades. Sometimes, it might be
1263 helpful as a heavy-weight <command>daemon-reload</command>.
1264 While the daemon is being reexecuted, all sockets systemd listening
1265 on behalf of user configuration will stay accessible.
1266 </para>
e93c33d4
SL
1267 </listitem>
1268 </varlistentry>
38fcb7f7 1269
df957849 1270 <varlistentry id='log-level'>
38fcb7f7
ZJS
1271 <term><command>log-level</command> [<replaceable>LEVEL</replaceable>]</term>
1272
1273 <listitem><para>If no argument is given, print the current log level of the manager. If an
1274 optional argument <replaceable>LEVEL</replaceable> is provided, then the command changes the
1275 current log level of the manager to <replaceable>LEVEL</replaceable> (accepts the same values as
1276 <option>--log-level=</option> described in
1277 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1278 </para></listitem>
1279 </varlistentry>
1280
1281 <varlistentry>
1282 <term><command>log-target</command> [<replaceable>TARGET</replaceable>]</term>
1283
1284 <listitem><para>If no argument is given, print the current log target of the manager. If an
1285 optional argument <replaceable>TARGET</replaceable> is provided, then the command changes the
1286 current log target of the manager to <replaceable>TARGET</replaceable> (accepts the same values as
1287 <option>--log-target=</option>, described in
1288 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1289 </para></listitem>
1290 </varlistentry>
6ab86319
ZJS
1291
1292 <varlistentry>
1293 <term><command>service-watchdogs</command> [yes|no]</term>
1294
1295 <listitem><para>If no argument is given, print the current state of service runtime watchdogs of
1296 the manager. If an optional boolean argument is provided, then globally enables or disables the
1297 service runtime watchdogs (<option>WatchdogSec=</option>) and emergency actions (e.g.
1298 <option>OnFailure=</option> or <option>StartLimitAction=</option>); see
1299 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1300 The hardware watchdog is not affected by this setting.</para></listitem>
1301 </varlistentry>
e1fac8a6
ZJS
1302 </variablelist>
1303 </refsect2>
27722f96 1304
e1fac8a6
ZJS
1305 <refsect2>
1306 <title>System Commands</title>
e9fd88f2 1307
e1fac8a6
ZJS
1308 <variablelist>
1309 <varlistentry>
1310 <term><command>is-system-running</command></term>
5b792edb 1311
e1fac8a6
ZJS
1312 <listitem>
1313 <para>Checks whether the system is operational. This
1314 returns success (exit code 0) when the system is fully up
1315 and running, specifically not in startup, shutdown or
1316 maintenance mode, and with no failed services. Failure is
1317 returned otherwise (exit code non-zero). In addition, the
1318 current state is printed in a short string to standard
1319 output, see the table below. Use <option>--quiet</option> to
1320 suppress this output.</para>
5b792edb 1321
e1fac8a6
ZJS
1322 <para>Use <option>--wait</option> to wait until the boot
1323 process is completed before printing the current state and
1324 returning the appropriate error status. If <option>--wait</option>
1325 is in use, states <varname>initializing</varname> or
1326 <varname>starting</varname> will not be reported, instead
1327 the command will block until a later state (such as
1328 <varname>running</varname> or <varname>degraded</varname>)
1329 is reached.</para>
5b792edb 1330
e1fac8a6
ZJS
1331 <table>
1332 <title><command>is-system-running</command> output</title>
1333 <tgroup cols='3'>
1334 <colspec colname='name'/>
1335 <colspec colname='description'/>
1336 <colspec colname='exit-code'/>
1337 <thead>
1338 <row>
1339 <entry>Name</entry>
1340 <entry>Description</entry>
1341 <entry>Exit Code</entry>
1342 </row>
1343 </thead>
1344 <tbody>
1345 <row>
1346 <entry><varname>initializing</varname></entry>
1347 <entry><para>Early bootup, before
1348 <filename>basic.target</filename> is reached
1349 or the <varname>maintenance</varname> state entered.
1350 </para></entry>
1351 <entry>&gt; 0</entry>
1352 </row>
1353 <row>
1354 <entry><varname>starting</varname></entry>
1355 <entry><para>Late bootup, before the job queue
1356 becomes idle for the first time, or one of the
1357 rescue targets are reached.</para></entry>
1358 <entry>&gt; 0</entry>
1359 </row>
1360 <row>
1361 <entry><varname>running</varname></entry>
1362 <entry><para>The system is fully
1363 operational.</para></entry>
1364 <entry>0</entry>
1365 </row>
1366 <row>
1367 <entry><varname>degraded</varname></entry>
1368 <entry><para>The system is operational but one or more
1369 units failed.</para></entry>
1370 <entry>&gt; 0</entry>
1371 </row>
1372 <row>
1373 <entry><varname>maintenance</varname></entry>
1374 <entry><para>The rescue or emergency target is
1375 active.</para></entry>
1376 <entry>&gt; 0</entry>
1377 </row>
1378 <row>
1379 <entry><varname>stopping</varname></entry>
1380 <entry><para>The manager is shutting
1381 down.</para></entry>
1382 <entry>&gt; 0</entry>
1383 </row>
1384 <row>
1385 <entry><varname>offline</varname></entry>
1386 <entry><para>The manager is not
1387 running. Specifically, this is the operational
1388 state if an incompatible program is running as
1389 system manager (PID 1).</para></entry>
1390 <entry>&gt; 0</entry>
1391 </row>
1392 <row>
1393 <entry><varname>unknown</varname></entry>
1394 <entry><para>The operational state could not be
1395 determined, due to lack of resources or another
1396 error cause.</para></entry>
1397 <entry>&gt; 0</entry>
1398 </row>
1399 </tbody>
1400 </tgroup>
1401 </table>
27722f96
LN
1402 </listitem>
1403 </varlistentry>
1404
1405 <varlistentry>
e1fac8a6 1406 <term><command>default</command></term>
27722f96
LN
1407
1408 <listitem>
e1fac8a6
ZJS
1409 <para>Enter default mode. This is equivalent to <command>systemctl isolate default.target</command>. This
1410 operation is blocking by default, use <option>--no-block</option> to request asynchronous behavior.</para>
27722f96
LN
1411 </listitem>
1412 </varlistentry>
1413
1414 <varlistentry>
e1fac8a6 1415 <term><command>rescue</command></term>
27722f96
LN
1416
1417 <listitem>
e1fac8a6
ZJS
1418 <para>Enter rescue mode. This is equivalent to <command>systemctl isolate rescue.target</command>. This
1419 operation is blocking by default, use <option>--no-block</option> to request asynchronous behavior.</para>
27722f96
LN
1420 </listitem>
1421 </varlistentry>
27722f96 1422 <varlistentry>
e1fac8a6 1423 <term><command>emergency</command></term>
27722f96
LN
1424
1425 <listitem>
e1fac8a6
ZJS
1426 <para>Enter emergency mode. This is equivalent to <command>systemctl isolate
1427 emergency.target</command>. This operation is blocking by default, use <option>--no-block</option> to
1428 request asynchronous behavior.</para>
27722f96
LN
1429 </listitem>
1430 </varlistentry>
27722f96 1431 <varlistentry>
e1fac8a6 1432 <term><command>halt</command></term>
27722f96
LN
1433
1434 <listitem>
e1fac8a6
ZJS
1435 <para>Shut down and halt the system. This is mostly equivalent to <command>systemctl start halt.target
1436 --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all users. This command is
1437 asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
1438 that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
1439 on. Use <command>systemctl poweroff</command> for powering off the system (see below).</para>
1440
1441 <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
1442 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1443 system halt. If <option>--force</option> is specified twice, the operation is immediately executed without
1444 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1445 <option>--force</option> is specified twice the halt operation is executed by <command>systemctl</command>
1446 itself, and the system manager is not contacted. This means the command should succeed even when the system
1447 manager has crashed.</para>
27722f96
LN
1448 </listitem>
1449 </varlistentry>
27722f96 1450 <varlistentry>
e1fac8a6 1451 <term><command>poweroff</command></term>
27722f96
LN
1452
1453 <listitem>
e1fac8a6
ZJS
1454 <para>Shut down and power-off the system. This is mostly equivalent to <command>systemctl start
1455 poweroff.target --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all
1456 users. This command is asynchronous; it will return after the power-off operation is enqueued, without
1457 waiting for it to complete.</para>
27722f96 1458
e1fac8a6
ZJS
1459 <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
1460 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1461 powering off. If <option>--force</option> is specified twice, the operation is immediately executed without
1462 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1463 <option>--force</option> is specified twice the power-off operation is executed by
1464 <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
1465 succeed even when the system manager has crashed.</para>
1466 </listitem>
1467 </varlistentry>
1468 <varlistentry>
dae710be 1469 <term><command>reboot</command></term>
27722f96 1470
e1fac8a6 1471 <listitem>
76c068b7
ZJS
1472 <para>Shut down and reboot the system.</para>
1473
1474 <para>This command mostly equivalent to <command>systemctl start reboot.target
1475 --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all
1476 users. This command is asynchronous; it will return after the reboot operation is enqueued,
1477 without waiting for it to complete.</para>
3990961d 1478
e1fac8a6
ZJS
1479 <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
1480 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1481 reboot. If <option>--force</option> is specified twice, the operation is immediately executed without
1482 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1483 <option>--force</option> is specified twice the reboot operation is executed by
1484 <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
1485 succeed even when the system manager has crashed.</para>
3990961d 1486
dae710be 1487 <para>If the switch <option>--reboot-argument=</option> is given, it will be passed as the optional
e1fac8a6 1488 argument to the <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
dae710be 1489 system call.</para>
76c068b7
ZJS
1490
1491 <para>Options <option>--boot-loader-entry=</option>, <option>--boot-loader-menu=</option>, and
1492 <option>--firmware-setup</option> can be used to select what to do <emphasis>after</emphasis> the
1493 reboot. See the descriptions of those options for details.</para>
27722f96
LN
1494 </listitem>
1495 </varlistentry>
1496
1497 <varlistentry>
e1fac8a6 1498 <term><command>kexec</command></term>
27722f96
LN
1499
1500 <listitem>
e1fac8a6
ZJS
1501 <para>Shut down and reboot the system via <command>kexec</command>. This is equivalent to
1502 <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block</command>. This command is
1503 asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1504 complete.</para>
3990961d 1505
e1fac8a6
ZJS
1506 <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
1507 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1508 reboot.</para>
1509 </listitem>
1510 </varlistentry>
3990961d 1511
e1fac8a6
ZJS
1512 <varlistentry>
1513 <term><command>exit</command> <optional><replaceable>EXIT_CODE</replaceable></optional></term>
3990961d 1514
e1fac8a6
ZJS
1515 <listitem>
1516 <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
1517 conjunction with the <option>--user</option> option) or in containers and is equivalent to
1518 <command>poweroff</command> otherwise. This command is asynchronous; it will return after the exit
1519 operation is enqueued, without waiting for it to complete.</para>
27722f96 1520
e1fac8a6
ZJS
1521 <para>The service manager will exit with the specified exit code, if
1522 <replaceable>EXIT_CODE</replaceable> is passed.</para>
27722f96
LN
1523 </listitem>
1524 </varlistentry>
1525
b619ec8f 1526 <varlistentry>
e1fac8a6 1527 <term><command>switch-root</command> <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></term>
b619ec8f
LP
1528
1529 <listitem>
e1fac8a6
ZJS
1530 <para>Switches to a different root directory and executes a new system manager process below it. This is
1531 intended for usage in initial RAM disks ("initrd"), and will transition from the initrd's system manager
1532 process (a.k.a. "init" process) to the main system manager process which is loaded from the actual host
1533 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1534 to the new system manager binary below it to execute as PID 1. If the latter is omitted or the empty
1535 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1536 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1537 initrd's system manager process is passed to the main system manager, which allows later introspection of
1538 the state of the services involved in the initrd boot phase.</para>
b619ec8f
LP
1539 </listitem>
1540 </varlistentry>
1541
1542 <varlistentry>
e1fac8a6 1543 <term><command>suspend</command></term>
b619ec8f
LP
1544
1545 <listitem>
e1fac8a6
ZJS
1546 <para>Suspend the system. This will trigger activation of the special target unit
1547 <filename>suspend.target</filename>. This command is asynchronous, and will return after the suspend
1548 operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.</para>
1549 </listitem>
1550 </varlistentry>
39207373 1551
e1fac8a6
ZJS
1552 <varlistentry>
1553 <term><command>hibernate</command></term>
b619ec8f 1554
e1fac8a6
ZJS
1555 <listitem>
1556 <para>Hibernate the system. This will trigger activation of the special target unit
1557 <filename>hibernate.target</filename>. This command is asynchronous, and will return after the hibernation
1558 operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.</para>
b619ec8f
LP
1559 </listitem>
1560 </varlistentry>
1561
1562 <varlistentry>
e1fac8a6 1563 <term><command>hybrid-sleep</command></term>
b619ec8f
LP
1564
1565 <listitem>
e1fac8a6
ZJS
1566 <para>Hibernate and suspend the system. This will trigger activation of the special target unit
1567 <filename>hybrid-sleep.target</filename>. This command is asynchronous, and will return after the hybrid
1568 sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.</para>
b619ec8f
LP
1569 </listitem>
1570 </varlistentry>
1571
27722f96 1572 <varlistentry>
e1fac8a6 1573 <term><command>suspend-then-hibernate</command></term>
27722f96
LN
1574
1575 <listitem>
e1fac8a6
ZJS
1576 <para>Suspend the system and hibernate it after the delay specified in <filename>systemd-sleep.conf</filename>.
1577 This will trigger activation of the special target unit <filename>suspend-then-hibernate.target</filename>.
1578 This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued.
1579 It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.</para>
1580 </listitem>
1581 </varlistentry>
1582 </variablelist>
1583 </refsect2>
171754aa 1584
e1fac8a6
ZJS
1585 <refsect2>
1586 <title>Parameter Syntax</title>
171754aa 1587
e1fac8a6
ZJS
1588 <para>Unit commands listed above take either a single unit name (designated as <replaceable>UNIT</replaceable>),
1589 or multiple unit specifications (designated as <replaceable>PATTERN</replaceable>…). In the first case, the
1590 unit name with or without a suffix must be given. If the suffix is not specified (unit name is "abbreviated"),
1591 systemctl will append a suitable suffix, <literal>.service</literal> by default, and a type-specific suffix in
1592 case of commands which operate only on specific unit types. For example,
1593 <programlisting># systemctl start sshd</programlisting> and
1594 <programlisting># systemctl start sshd.service</programlisting>
1595 are equivalent, as are
1596 <programlisting># systemctl isolate default</programlisting>
1597 and
1598 <programlisting># systemctl isolate default.target</programlisting>
1599 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1600 paths to mount unit names.
1601 <programlisting># systemctl status /dev/sda
1602# systemctl status /home</programlisting>
1603 are equivalent to:
1604 <programlisting># systemctl status dev-sda.device
1605# systemctl status home.mount</programlisting>
1606 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
1607 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1608 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1609 error.</para>
171754aa 1610
e1fac8a6
ZJS
1611 <para>Glob patterns use
1612 <citerefentry project='man-pages'><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1613 so normal shell-style globbing rules are used, and
1614 <literal>*</literal>, <literal>?</literal>,
1615 <literal>[]</literal> may be used. See
1616 <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1617 for more details. The patterns are matched against the primary names of
1618 units currently in memory, and patterns which do not match anything
1619 are silently skipped. For example:
1620 <programlisting># systemctl stop sshd@*.service</programlisting>
1621 will stop all <filename>sshd@.service</filename> instances. Note that alias names of units, and units that aren't
1622 in memory are not considered for glob expansion.
1623 </para>
27722f96 1624
e1fac8a6
ZJS
1625 <para>For unit file commands, the specified <replaceable>UNIT</replaceable> should be the name of the unit file
1626 (possibly abbreviated, see above), or the absolute path to the unit file:
1627 <programlisting># systemctl enable foo.service</programlisting>
1628 or
1629 <programlisting># systemctl link /path/to/foo.service</programlisting>
1630 </para>
1631 </refsect2>
27722f96 1632
e1fac8a6 1633 </refsect1>
27722f96 1634
e1fac8a6
ZJS
1635 <refsect1>
1636 <title>Options</title>
27722f96 1637
e1fac8a6 1638 <para>The following options are understood:</para>
27722f96 1639
e1fac8a6
ZJS
1640 <variablelist>
1641 <varlistentry>
1642 <term><option>-t</option></term>
1643 <term><option>--type=</option></term>
27722f96 1644
e1fac8a6 1645 <listitem>
a6e33464
ZJS
1646 <para>The argument is a comma-separated list of unit types such as <option>service</option> and
1647 <option>socket</option>. When units are listed with <command>list-units</command>,
1648 <command>show</command>, or <command>status</command>, only units of the specified types will be
1649 shown. By default, units of all types are shown.</para>
344ca755 1650
a6e33464
ZJS
1651 <para>As a special case, if one of the arguments is <option>help</option>, a list of allowed values
1652 will be printed and the program will exit.</para>
e1fac8a6
ZJS
1653 </listitem>
1654 </varlistentry>
344ca755 1655
e1fac8a6
ZJS
1656 <varlistentry>
1657 <term><option>--state=</option></term>
344ca755 1658
e1fac8a6 1659 <listitem>
a6e33464
ZJS
1660 <para>The argument is a comma-separated list of unit LOAD, SUB, or ACTIVE states. When listing
1661 units with <command>list-units</command>, <command>show</command>, or <command>status</command>,
1662 show only those in the specified states. Use <option>--state=failed</option> or
1663 <option>--failed</option> to show only failed units.</para>
1664
1665 <para>As a special case, if one of the arguments is <option>help</option>, a list of allowed values
1666 will be printed and the program will exit.</para>
e1fac8a6
ZJS
1667 </listitem>
1668 </varlistentry>
27722f96 1669
e1fac8a6
ZJS
1670 <varlistentry>
1671 <term><option>-p</option></term>
1672 <term><option>--property=</option></term>
27722f96 1673
e1fac8a6
ZJS
1674 <listitem>
1675 <para>When showing unit/job/manager properties with the
1676 <command>show</command> command, limit display to properties
1677 specified in the argument. The argument should be a
1678 comma-separated list of property names, such as
1679 <literal>MainPID</literal>. Unless specified, all known
1680 properties are shown. If specified more than once, all
1681 properties with the specified names are shown. Shell
1682 completion is implemented for property names.</para>
7d4fb3b1 1683
e1fac8a6 1684 <para>For the manager itself,
c809e387
PN
1685 <command>systemctl show</command>
1686 will show all available properties, most of which are derived or closely match the options described in
e1fac8a6
ZJS
1687 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1688 </para>
7d4fb3b1 1689
e1fac8a6
ZJS
1690 <para>Properties for units vary by unit type, so showing any
1691 unit (even a non-existent one) is a way to list properties
1692 pertaining to this type. Similarly, showing any job will list
1693 properties pertaining to all jobs. Properties for units are
1694 documented in
1695 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1696 and the pages for individual unit types
1697 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1698 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1699 etc.</para>
1700 </listitem>
1701 </varlistentry>
7d4fb3b1 1702
5292c240
ZJS
1703 <varlistentry>
1704 <term><option>-P</option></term>
1705
1706 <listitem>
1707 <para>Equivalent to <option>--value</option> <option>--property=</option>, i.e. shows the
1708 value of the property without the property name or <literal>=</literal>. Note that using
1709 <option>-P</option> once will also affect all properties listed with
1710 <option>-p</option>/<option>--property=</option>.</para>
1711 </listitem>
1712 </varlistentry>
1713
e1fac8a6
ZJS
1714 <varlistentry>
1715 <term><option>-a</option></term>
1716 <term><option>--all</option></term>
7d4fb3b1 1717
e1fac8a6
ZJS
1718 <listitem>
1719 <para>When listing units with <command>list-units</command>, also show inactive units and
1720 units which are following other units. When showing unit/job/manager properties, show all
1721 properties regardless whether they are set or not.</para>
7d4fb3b1 1722
e1fac8a6
ZJS
1723 <para>To list all units installed in the file system, use the
1724 <command>list-unit-files</command> command instead.</para>
39c38ce1 1725
e1fac8a6
ZJS
1726 <para>When listing units with <command>list-dependencies</command>, recursively show
1727 dependencies of all dependent units (by default only dependencies of target units are
1728 shown).</para>
7d4fb3b1 1729
e1fac8a6
ZJS
1730 <para>When used with <command>status</command>, show journal messages in full, even if they include
1731 unprintable characters or are very long. By default, fields with unprintable characters are
1732 abbreviated as "blob data". (Note that the pager may escape unprintable characters again.)</para>
1733 </listitem>
1734 </varlistentry>
7d4fb3b1 1735
e1fac8a6
ZJS
1736 <varlistentry>
1737 <term><option>-r</option></term>
1738 <term><option>--recursive</option></term>
7d4fb3b1 1739
e1fac8a6
ZJS
1740 <listitem>
1741 <para>When listing units, also show units of local
1742 containers. Units of local containers will be prefixed with
1743 the container name, separated by a single colon character
1744 (<literal>:</literal>).</para>
1745 </listitem>
1746 </varlistentry>
b619ec8f 1747
e1fac8a6
ZJS
1748 <varlistentry>
1749 <term><option>--reverse</option></term>
b619ec8f 1750
e1fac8a6
ZJS
1751 <listitem>
1752 <para>Show reverse dependencies between units with
1753 <command>list-dependencies</command>, i.e. follow
1754 dependencies of type <varname>WantedBy=</varname>,
1755 <varname>RequiredBy=</varname>,
1756 <varname>PartOf=</varname>, <varname>BoundBy=</varname>,
1757 instead of <varname>Wants=</varname> and similar.
1758 </para>
1759 </listitem>
1760 </varlistentry>
b619ec8f 1761
e1fac8a6
ZJS
1762 <varlistentry>
1763 <term><option>--after</option></term>
b619ec8f 1764
e1fac8a6
ZJS
1765 <listitem>
1766 <para>With <command>list-dependencies</command>, show the
1767 units that are ordered before the specified unit. In other
1768 words, recursively list units following the
1769 <varname>After=</varname> dependency.</para>
b619ec8f 1770
e1fac8a6
ZJS
1771 <para>Note that any <varname>After=</varname> dependency is
1772 automatically mirrored to create a
1773 <varname>Before=</varname> dependency. Temporal dependencies
1774 may be specified explicitly, but are also created implicitly
1775 for units which are <varname>WantedBy=</varname> targets
1776 (see
1777 <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
1778 and as a result of other directives (for example
1779 <varname>RequiresMountsFor=</varname>). Both explicitly
1780 and implicitly introduced dependencies are shown with
1781 <command>list-dependencies</command>.</para>
27722f96 1782
e1fac8a6
ZJS
1783 <para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs are
1784 waiting for it. May be combined with <option>--before</option> to show both the jobs waiting for each job as
1785 well as all jobs each job is waiting for.</para>
1786 </listitem>
1787 </varlistentry>
0d292f5e 1788
e1fac8a6
ZJS
1789 <varlistentry>
1790 <term><option>--before</option></term>
0d292f5e 1791
e1fac8a6
ZJS
1792 <listitem>
1793 <para>With <command>list-dependencies</command>, show the
1794 units that are ordered after the specified unit. In other
1795 words, recursively list units following the
1796 <varname>Before=</varname> dependency.</para>
0d292f5e 1797
e1fac8a6
ZJS
1798 <para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs it
1799 is waiting for. May be combined with <option>--after</option> to show both the jobs waiting for each job as
1800 well as all jobs each job is waiting for.</para>
1801 </listitem>
1802 </varlistentry>
27722f96 1803
a602a0b4
KK
1804 <varlistentry>
1805 <term><option>--with-dependencies</option></term>
1806
1807 <listitem>
1808 <para>When used with <command>status</command>,
1809 <command>cat</command>, <command>list-units</command>, and
1810 <command>list-unit-files</command>, those commands print all
1811 specified units and the dependencies of those units.</para>
1812
1813 <para>Options <option>--reverse</option>,
1814 <option>--after</option>, <option>--before</option>
1815 may be used to change what types of dependencies
1816 are shown.</para>
1817 </listitem>
1818 </varlistentry>
1819
e1fac8a6
ZJS
1820 <varlistentry>
1821 <term><option>-l</option></term>
1822 <term><option>--full</option></term>
27722f96 1823
e1fac8a6
ZJS
1824 <listitem>
1825 <para>Do not ellipsize unit names, process tree entries,
1826 journal output, or truncate unit descriptions in the output
1827 of <command>status</command>, <command>list-units</command>,
1828 <command>list-jobs</command>, and
1829 <command>list-timers</command>.</para>
1830 <para>Also, show installation targets in the output of
1831 <command>is-enabled</command>.</para>
1832 </listitem>
1833 </varlistentry>
82948f6c 1834
e1fac8a6
ZJS
1835 <varlistentry>
1836 <term><option>--value</option></term>
27722f96 1837
e1fac8a6 1838 <listitem>
5292c240
ZJS
1839 <para>When printing properties with <command>show</command>, only print the value, and skip the
1840 property name and <literal>=</literal>. Also see option <option>-P</option> above.</para>
e1fac8a6
ZJS
1841 </listitem>
1842 </varlistentry>
27722f96 1843
e1fac8a6
ZJS
1844 <varlistentry>
1845 <term><option>--show-types</option></term>
27722f96 1846
e1fac8a6
ZJS
1847 <listitem>
1848 <para>When showing sockets, show the type of the socket.</para>
1849 </listitem>
1850 </varlistentry>
27722f96 1851
e1fac8a6
ZJS
1852 <varlistentry>
1853 <term><option>--job-mode=</option></term>
27722f96 1854
e1fac8a6
ZJS
1855 <listitem>
1856 <para>When queuing a new job, this option controls how to deal with
1857 already queued jobs. It takes one of <literal>fail</literal>,
1858 <literal>replace</literal>,
1859 <literal>replace-irreversibly</literal>,
1860 <literal>isolate</literal>,
1861 <literal>ignore-dependencies</literal>,
132e0b53
KK
1862 <literal>ignore-requirements</literal>,
1863 <literal>flush</literal>, or
1864 <literal>triggering</literal>. Defaults to
e1fac8a6
ZJS
1865 <literal>replace</literal>, except when the
1866 <command>isolate</command> command is used which implies the
1867 <literal>isolate</literal> job mode.</para>
27722f96 1868
e1fac8a6
ZJS
1869 <para>If <literal>fail</literal> is specified and a requested
1870 operation conflicts with a pending job (more specifically:
1871 causes an already pending start job to be reversed into a stop
1872 job or vice versa), cause the operation to fail.</para>
ac3efa8a 1873
e1fac8a6
ZJS
1874 <para>If <literal>replace</literal> (the default) is
1875 specified, any conflicting pending job will be replaced, as
1876 necessary.</para>
27722f96 1877
e1fac8a6
ZJS
1878 <para>If <literal>replace-irreversibly</literal> is specified,
1879 operate like <literal>replace</literal>, but also mark the new
1880 jobs as irreversible. This prevents future conflicting
1881 transactions from replacing these jobs (or even being enqueued
1882 while the irreversible jobs are still pending). Irreversible
1883 jobs can still be cancelled using the <command>cancel</command>
1884 command. This job mode should be used on any transaction which
1885 pulls in <filename>shutdown.target</filename>.</para>
27722f96 1886
e1fac8a6
ZJS
1887 <para><literal>isolate</literal> is only valid for start
1888 operations and causes all other units to be stopped when the
1889 specified unit is started. This mode is always used when the
1890 <command>isolate</command> command is used.</para>
27722f96 1891
e1fac8a6
ZJS
1892 <para><literal>flush</literal> will cause all queued jobs to
1893 be canceled when the new job is enqueued.</para>
432d5965 1894
e1fac8a6
ZJS
1895 <para>If <literal>ignore-dependencies</literal> is specified,
1896 then all unit dependencies are ignored for this new job and
1897 the operation is executed immediately. If passed, no required
1898 units of the unit passed will be pulled in, and no ordering
1899 dependencies will be honored. This is mostly a debugging and
1900 rescue tool for the administrator and should not be used by
1901 applications.</para>
27722f96 1902
e1fac8a6
ZJS
1903 <para><literal>ignore-requirements</literal> is similar to
1904 <literal>ignore-dependencies</literal>, but only causes the
1905 requirement dependencies to be ignored, the ordering
1906 dependencies will still be honored.</para>
1907 </listitem>
27722f96 1908
132e0b53
KK
1909 <para><literal>triggering</literal> may only be used with
1910 <command>systemctl stop</command>. In this mode, the specified
1911 unit and any active units that trigger it are stopped. See the
1912 discussion of
1913 <varname>Triggers=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1914 for more information about triggering units.</para>
1915
e1fac8a6 1916 </varlistentry>
27722f96 1917
e1fac8a6
ZJS
1918 <varlistentry>
1919 <term><option>-T</option></term>
1920 <term><option>--show-transaction</option></term>
99813a19 1921
e1fac8a6
ZJS
1922 <listitem>
1923 <para>When enqueuing a unit job (for example as effect of a <command>systemctl start</command>
1924 invocation or similar), show brief information about all jobs enqueued, covering both the requested
1925 job and any added because of unit dependencies. Note that the output will only include jobs
1926 immediately part of the transaction requested. It is possible that service start-up program code
1927 run as effect of the enqueued jobs might request further jobs to be pulled in. This means that
1928 completion of the listed jobs might ultimately entail more jobs than the listed ones.</para>
1929 </listitem>
1930 </varlistentry>
2de51fdc 1931
e1fac8a6
ZJS
1932 <varlistentry>
1933 <term><option>--fail</option></term>
adb6cd9b 1934
e1fac8a6
ZJS
1935 <listitem>
1936 <para>Shorthand for <option>--job-mode=</option>fail.</para>
1937 <para>When used with the <command>kill</command> command,
1938 if no units were killed, the operation results in an error.
1939 </para>
1940 </listitem>
1941 </varlistentry>
99813a19 1942
4327574f
FS
1943 <varlistentry>
1944 <term><option>--check-inhibitors=</option></term>
1945
1946 <listitem>
5b69a7c5
ZJS
1947 <para>When system shutdown or sleep state is requested, this option controls checking of inhibitor
1948 locks. It takes one of <literal>auto</literal>, <literal>yes</literal> or
4327574f 1949 <literal>no</literal>. Defaults to <literal>auto</literal>, which will behave like
5b69a7c5
ZJS
1950 <literal>yes</literal> for interactive invocations (i.e. from a TTY) and <literal>no</literal> for
1951 non-interactive invocations. <literal>yes</literal> lets the request respect inhibitor locks.
1952 <literal>no</literal> lets the request ignore inhibitor locks.</para>
1953
1954 <para>Applications can establish inhibitor locks to prevent certain important operations (such as
1955 CD burning) from being interrupted by system shutdown or sleep. Any user may take these locks and
1956 privileged users may override these locks. If any locks are taken, shutdown and sleep state
1957 requests will normally fail (unless privileged). However, if <literal>no</literal> is specified or
1958 <literal>auto</literal> is specified on a non-interactive requests, the operation will be
1959 attempted. If locks are present, the operation may require additional privileges.</para>
1960
1961 <para>Option <option>--force</option> provides another way to override inhibitors.</para>
4327574f
FS
1962 </listitem>
1963 </varlistentry>
1964
e1fac8a6
ZJS
1965 <varlistentry>
1966 <term><option>-i</option></term>
27722f96 1967
e1fac8a6 1968 <listitem>
4327574f 1969 <para>Shortcut for <option>--check-inhibitors=no</option>.</para>
e1fac8a6
ZJS
1970 </listitem>
1971 </varlistentry>
99813a19 1972
e1fac8a6
ZJS
1973 <varlistentry>
1974 <term><option>--dry-run</option></term>
27722f96 1975
e1fac8a6
ZJS
1976 <listitem>
1977 <para>Just print what would be done. Currently supported by verbs
1978 <command>halt</command>, <command>poweroff</command>, <command>reboot</command>,
1979 <command>kexec</command>, <command>suspend</command>, <command>hibernate</command>,
1980 <command>hybrid-sleep</command>, <command>suspend-then-hibernate</command>,
1981 <command>default</command>, <command>rescue</command>,
1982 <command>emergency</command>, and <command>exit</command>.</para>
1983 </listitem>
1984 </varlistentry>
27722f96 1985
e1fac8a6
ZJS
1986 <varlistentry>
1987 <term><option>-q</option></term>
1988 <term><option>--quiet</option></term>
27722f96 1989
e1fac8a6
ZJS
1990 <listitem>
1991 <para>Suppress printing of the results of various commands
1992 and also the hints about truncated log lines. This does not
1993 suppress output of commands for which the printed output is
1994 the only result (like <command>show</command>). Errors are
1995 always printed.</para>
1996 </listitem>
1997 </varlistentry>
6324a8a7 1998
e1fac8a6
ZJS
1999 <varlistentry>
2000 <term><option>--no-block</option></term>
27722f96 2001
e1fac8a6
ZJS
2002 <listitem>
2003 <para>Do not synchronously wait for the requested operation
2004 to finish. If this is not specified, the job will be
2005 verified, enqueued and <command>systemctl</command> will
2006 wait until the unit's start-up is completed. By passing this
2007 argument, it is only verified and enqueued. This option may not be
2008 combined with <option>--wait</option>.</para>
2009 </listitem>
2010 </varlistentry>
6324a8a7 2011
e1fac8a6
ZJS
2012 <varlistentry>
2013 <term><option>--wait</option></term>
2014
2015 <listitem>
2016 <para>Synchronously wait for started units to terminate again.
2017 This option may not be combined with <option>--no-block</option>.
2018 Note that this will wait forever if any given unit never terminates
2019 (by itself or by getting stopped explicitly); particularly services
2020 which use <literal>RemainAfterExit=yes</literal>.</para>
2021
2022 <para>When used with <command>is-system-running</command>, wait
2023 until the boot process is completed before returning.</para>
2024 </listitem>
2025 </varlistentry>
2026
2027 <xi:include href="user-system-options.xml" xpointer="user" />
2028 <xi:include href="user-system-options.xml" xpointer="system" />
2029
2030 <varlistentry>
2031 <term><option>--failed</option></term>
2032
2033 <listitem>
2034 <para>List units in failed state. This is equivalent to
2035 <option>--state=failed</option>.</para>
2036 </listitem>
2037 </varlistentry>
2038
2039 <varlistentry>
2040 <term><option>--no-wall</option></term>
2041
2042 <listitem>
2043 <para>Do not send wall message before halt, power-off and reboot.</para>
2044 </listitem>
2045 </varlistentry>
2046
2047 <varlistentry>
2048 <term><option>--global</option></term>
2049
2050 <listitem>
2051 <para>When used with <command>enable</command> and
2052 <command>disable</command>, operate on the global user
2053 configuration directory, thus enabling or disabling a unit
2054 file globally for all future logins of all users.</para>
2055 </listitem>
2056 </varlistentry>
2057
2058 <varlistentry>
2059 <term><option>--no-reload</option></term>
2060
2061 <listitem>
2062 <para>When used with <command>enable</command> and
2063 <command>disable</command>, do not implicitly reload daemon
2064 configuration after executing the changes.</para>
2065 </listitem>
2066 </varlistentry>
2067
2068 <varlistentry>
2069 <term><option>--no-ask-password</option></term>
2070
2071 <listitem>
2072 <para>When used with <command>start</command> and related
2073 commands, disables asking for passwords. Background services
2074 may require input of a password or passphrase string, for
2075 example to unlock system hard disks or cryptographic
2076 certificates. Unless this option is specified and the
2077 command is invoked from a terminal,
2078 <command>systemctl</command> will query the user on the
2079 terminal for the necessary secrets. Use this option to
2080 switch this behavior off. In this case, the password must be
2081 supplied by some other means (for example graphical password
2082 agents) or the service might fail. This also disables
2083 querying the user for authentication for privileged
2084 operations.</para>
2085 </listitem>
2086 </varlistentry>
2087
2088 <varlistentry>
4ccde410 2089 <term><option>--kill-whom=</option></term>
e1fac8a6
ZJS
2090
2091 <listitem>
2092 <para>When used with <command>kill</command>, choose which
2093 processes to send a signal to. Must be one of
2094 <option>main</option>, <option>control</option> or
2095 <option>all</option> to select whether to kill only the main
2096 process, the control process or all processes of the
2097 unit. The main process of the unit is the one that defines
2098 the life-time of it. A control process of a unit is one that
2099 is invoked by the manager to induce state changes of it. For
2100 example, all processes started due to the
2101 <varname>ExecStartPre=</varname>,
2102 <varname>ExecStop=</varname> or
2103 <varname>ExecReload=</varname> settings of service units are
2104 control processes. Note that there is only one control
2105 process per unit at a time, as only one state change is
2106 executed at a time. For services of type
2107 <varname>Type=forking</varname>, the initial process started
2108 by the manager for <varname>ExecStart=</varname> is a
2109 control process, while the process ultimately forked off by
2110 that one is then considered the main process of the unit (if
2111 it can be determined). This is different for service units
2112 of other types, where the process forked off by the manager
2113 for <varname>ExecStart=</varname> is always the main process
2114 itself. A service unit consists of zero or one main process,
2115 zero or one control process plus any number of additional
2116 processes. Not all unit types manage processes of these
2117 types however. For example, for mount units, control processes
2118 are defined (which are the invocations of
2119 <filename>&MOUNT_PATH;</filename> and
2120 <filename>&UMOUNT_PATH;</filename>), but no main process
2121 is defined. If omitted, defaults to
2122 <option>all</option>.</para>
2123 </listitem>
e1fac8a6
ZJS
2124 </varlistentry>
2125
86beb213 2126 <xi:include href="standard-options.xml" xpointer="signal" />
e1fac8a6
ZJS
2127
2128 <varlistentry>
2129 <term><option>--what=</option></term>
2130
2131 <listitem>
2132 <para>Select what type of per-unit resources to remove when the <command>clean</command> command is
2133 invoked, see below. Takes one of <constant>configuration</constant>, <constant>state</constant>,
2134 <constant>cache</constant>, <constant>logs</constant>, <constant>runtime</constant> to select the
2135 type of resource. This option may be specified more than once, in which case all specified resource
2136 types are removed. Also accepts the special value <constant>all</constant> as a shortcut for
11fcfc53 2137 specifying all five resource types. If this option is not specified defaults to the combination of
e1fac8a6
ZJS
2138 <constant>cache</constant> and <constant>runtime</constant>, i.e. the two kinds of resources that
2139 are generally considered to be redundant and can be reconstructed on next invocation.</para>
2140 </listitem>
2141 </varlistentry>
2142
2143 <varlistentry>
2144 <term><option>-f</option></term>
2145 <term><option>--force</option></term>
2146
2147 <listitem>
2148 <para>When used with <command>enable</command>, overwrite
2149 any existing conflicting symlinks.</para>
2150
2151 <para>When used with <command>edit</command>, create all of the
2152 specified units which do not already exist.</para>
2153
2154 <para>When used with <command>halt</command>, <command>poweroff</command>, <command>reboot</command> or
2155 <command>kexec</command>, execute the selected operation without shutting down all units. However, all
2156 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
2157 drastic but relatively safe option to request an immediate reboot. If <option>--force</option> is specified
2158 twice for these operations (with the exception of <command>kexec</command>), they will be executed
2159 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
2160 <option>--force</option> twice with any of these operations might result in data loss. Note that when
2161 <option>--force</option> is specified twice the selected operation is executed by
2162 <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
2163 succeed even when the system manager has crashed.</para>
2164 </listitem>
2165 </varlistentry>
27722f96 2166
e1fac8a6
ZJS
2167 <varlistentry>
2168 <term><option>--message=</option></term>
6324a8a7 2169
e1fac8a6
ZJS
2170 <listitem>
2171 <para>When used with <command>halt</command>, <command>poweroff</command> or <command>reboot</command>, set a
2172 short message explaining the reason for the operation. The message will be logged together with the default
2173 shutdown message.</para>
2174 </listitem>
2175 </varlistentry>
6324a8a7 2176
e1fac8a6
ZJS
2177 <varlistentry>
2178 <term><option>--now</option></term>
b619ec8f 2179
e1fac8a6
ZJS
2180 <listitem>
2181 <para>When used with <command>enable</command>, the units
2182 will also be started. When used with <command>disable</command> or
2183 <command>mask</command>, the units will also be stopped. The start
2184 or stop operation is only carried out when the respective enable or
2185 disable operation has been successful.</para>
2186 </listitem>
2187 </varlistentry>
27722f96 2188
e1fac8a6
ZJS
2189 <varlistentry>
2190 <term><option>--root=</option></term>
6324a8a7 2191
e1fac8a6
ZJS
2192 <listitem>
2193 <para>When used with
2194 <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
2195 (and related commands), use the specified root path when looking for unit
2196 files. If this option is present, <command>systemctl</command> will operate on
2197 the file system directly, instead of communicating with the <command>systemd</command>
2198 daemon to carry out changes.</para>
2199 </listitem>
b619ec8f 2200
e1fac8a6 2201 </varlistentry>
27722f96 2202
e1fac8a6
ZJS
2203 <varlistentry>
2204 <term><option>--runtime</option></term>
6324a8a7 2205
e1fac8a6
ZJS
2206 <listitem>
2207 <para>When used with <command>enable</command>,
2208 <command>disable</command>, <command>edit</command>,
2209 (and related commands), make changes only temporarily, so
2210 that they are lost on the next reboot. This will have the
2211 effect that changes are not made in subdirectories of
3b121157 2212 <filename>/etc/</filename> but in <filename>/run/</filename>,
e1fac8a6
ZJS
2213 with identical immediate effects, however, since the latter
2214 is lost on reboot, the changes are lost too.</para>
27722f96 2215
e1fac8a6
ZJS
2216 <para>Similarly, when used with
2217 <command>set-property</command>, make changes only
2218 temporarily, so that they are lost on the next
2219 reboot.</para>
2220 </listitem>
2221 </varlistentry>
b619ec8f 2222
e1fac8a6
ZJS
2223 <varlistentry>
2224 <term><option>--preset-mode=</option></term>
b619ec8f 2225
e1fac8a6
ZJS
2226 <listitem>
2227 <para>Takes one of <literal>full</literal> (the default),
2228 <literal>enable-only</literal>,
2229 <literal>disable-only</literal>. When used with the
2230 <command>preset</command> or <command>preset-all</command>
2231 commands, controls whether units shall be disabled and
2232 enabled according to the preset rules, or only enabled, or
2233 only disabled.</para>
2234 </listitem>
2235 </varlistentry>
27722f96 2236
e1fac8a6
ZJS
2237 <varlistentry>
2238 <term><option>-n</option></term>
2239 <term><option>--lines=</option></term>
b619ec8f 2240
e1fac8a6 2241 <listitem>
e04eae5e
ZJS
2242 <para>When used with <command>status</command>, controls the number of journal lines to show,
2243 counting from the most recent ones. Takes a positive integer argument, or 0 to disable journal
2244 output. Defaults to 10.</para>
e1fac8a6
ZJS
2245 </listitem>
2246 </varlistentry>
27722f96 2247
e1fac8a6
ZJS
2248 <varlistentry>
2249 <term><option>-o</option></term>
2250 <term><option>--output=</option></term>
b619ec8f 2251
e1fac8a6
ZJS
2252 <listitem>
2253 <para>When used with <command>status</command>, controls the
2254 formatting of the journal entries that are shown. For the
2255 available choices, see
2256 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
2257 Defaults to <literal>short</literal>.</para>
2258 </listitem>
2259 </varlistentry>
27722f96 2260
e1fac8a6
ZJS
2261 <varlistentry>
2262 <term><option>--firmware-setup</option></term>
6cc2b882 2263
e1fac8a6 2264 <listitem>
e04eae5e
ZJS
2265 <para>When used with the <command>reboot</command> command, indicate to the system's firmware to
2266 reboot into the firmware setup interface. Note that this functionality is not available on all
2267 systems.</para>
e1fac8a6
ZJS
2268 </listitem>
2269 </varlistentry>
6cc2b882 2270
e1fac8a6 2271 <varlistentry>
76c068b7 2272 <term><option>--boot-loader-menu=<replaceable>timeout</replaceable></option></term>
4a6022f0 2273
e1fac8a6 2274 <listitem>
e04eae5e
ZJS
2275 <para>When used with the <command>reboot</command> command, indicate to the system's boot loader to
2276 show the boot loader menu on the following boot. Takes a time value as parameter — indicating the
2277 menu timeout. Pass zero in order to disable the menu timeout. Note that not all boot loaders
2278 support this functionality.</para>
e1fac8a6
ZJS
2279 </listitem>
2280 </varlistentry>
a7c0e5d7 2281
e1fac8a6 2282 <varlistentry>
76c068b7 2283 <term><option>--boot-loader-entry=<replaceable>ID</replaceable></option></term>
e3e0314b 2284
e1fac8a6 2285 <listitem>
e04eae5e
ZJS
2286 <para>When used with the <command>reboot</command> command, indicate to the system's boot loader to
2287 boot into a specific boot loader entry on the following boot. Takes a boot loader entry identifier
2288 as argument, or <literal>help</literal> in order to list available entries. Note that not all boot
2289 loaders support this functionality.</para>
e1fac8a6
ZJS
2290 </listitem>
2291 </varlistentry>
e3e0314b 2292
dae710be 2293 <varlistentry>
2294 <term><option>--reboot-argument=</option></term>
2295
2296 <listitem>
2297 <para>This switch is used with <command>reboot</command>. The value is architecture and firmware specific. As an example, <literal>recovery</literal>
2298 might be used to trigger system recovery, and <literal>fota</literal> might be used to trigger a
2299 <quote>firmware over the air</quote> update.</para>
2300 </listitem>
2301 </varlistentry>
2302
e1fac8a6
ZJS
2303 <varlistentry>
2304 <term><option>--plain</option></term>
a7c0e5d7 2305
e1fac8a6
ZJS
2306 <listitem>
2307 <para>When used with <command>list-dependencies</command>,
2308 <command>list-units</command> or <command>list-machines</command>,
2309 the output is printed as a list instead of a tree, and the bullet
2310 circles are omitted.</para>
2311 </listitem>
2312 </varlistentry>
46ad9c53
LB
2313
2314 <varlistentry>
2315 <term><option>--timestamp=</option></term>
2316
2317 <listitem>
d13f2617
ZJS
2318 <para>Change the format of printed timestamps. The following values may be used:
2319 </para>
2320
2321 <variablelist>
2322 <varlistentry>
2323 <term><option>pretty</option> (this is the default)</term>
2324 <listitem><para><literal>Day YYYY-MM-DD HH:MM:SS TZ</literal></para></listitem>
2325 </varlistentry>
2326 </variablelist>
2327
b58b4a9f
FS
2328 <variablelist>
2329 <varlistentry>
2330 <term><option>unix</option></term>
2331 <listitem><para><literal>@seconds-since-the-epoch</literal></para></listitem>
2332 </varlistentry>
2333 </variablelist>
2334
d13f2617
ZJS
2335 <variablelist>
2336 <varlistentry>
2337 <term><option>us</option></term>
2338 <term><option>µs</option></term>
2339 <listitem><para><literal>Day YYYY-MM-DD HH:MM:SS.UUUUUU TZ</literal></para></listitem>
2340 </varlistentry>
2341 </variablelist>
2342
2343 <variablelist>
2344 <varlistentry>
2345 <term><option>utc</option></term>
2346 <listitem><para><literal>Day YYYY-MM-DD HH:MM:SS UTC</literal></para></listitem>
2347 </varlistentry>
2348 </variablelist>
2349
2350 <variablelist>
2351 <varlistentry>
2352 <term><option>us+utc</option></term>
2353 <term><option>µs+utc</option></term>
2354 <listitem><para><literal>Day YYYY-MM-DD HH:MM:SS.UUUUUU UTC</literal></para></listitem>
2355 </varlistentry>
2356 </variablelist>
46ad9c53
LB
2357 </listitem>
2358 </varlistentry>
e1fac8a6 2359
5e8deb94
LB
2360 <varlistentry>
2361 <term><option>--mkdir</option></term>
2362
2363 <listitem><para>When used with <command>bind</command>, creates the destination file or directory before
2364 applying the bind mount. Note that even though the name of this option suggests that it is suitable only for
2365 directories, this option also creates the destination file node to mount over if the object to mount is not
2366 a directory, but a regular file, device node, socket or FIFO.</para></listitem>
2367 </varlistentry>
2368
c9615f73
ZJS
2369 <varlistentry>
2370 <term><option>--marked</option></term>
2371
2372 <listitem><para>Only allowed with <command>reload-or-restart</command>. Enqueues restart jobs for all
2373 units that have the <literal>needs-restart</literal> mark, and reload jobs for units that have the
2374 <literal>needs-reload</literal> mark. When a unit marked for reload does not support reload, restart
2375 will be queued. Those properties can be set using <command>set-property Marks</command>.</para>
2376
2377 <para>Unless <option>--no-block</option> is used, <command>systemctl</command> will wait for the
2378 queued jobs to finish.</para></listitem>
2379 </varlistentry>
2380
5e8deb94
LB
2381 <varlistentry>
2382 <term><option>--read-only</option></term>
2383
2384 <listitem><para>When used with <command>bind</command>, creates a read-only bind mount.</para></listitem>
2385 </varlistentry>
2386
e1fac8a6
ZJS
2387 <xi:include href="user-system-options.xml" xpointer="host" />
2388 <xi:include href="user-system-options.xml" xpointer="machine" />
2389
2390 <xi:include href="standard-options.xml" xpointer="no-pager" />
6906da26 2391 <xi:include href="standard-options.xml" xpointer="legend" />
e1fac8a6
ZJS
2392 <xi:include href="standard-options.xml" xpointer="help" />
2393 <xi:include href="standard-options.xml" xpointer="version" />
2394 </variablelist>
4a6022f0
ZJS
2395 </refsect1>
2396
2397 <refsect1>
2398 <title>Exit status</title>
2399
23a9ffb0
ZJS
2400 <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
2401
2402 <para><command>systemctl</command> uses the return codes defined by LSB, as defined in
2403 <ulink url="http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html">LSB 3.0.0</ulink>.
2404 </para>
2405
2406 <table>
2407 <title>LSB return codes</title>
2408
2409 <tgroup cols='3'>
2410 <thead>
2411 <row>
2412 <entry>Value</entry>
2413 <entry>Description in LSB</entry>
2414 <entry>Use in systemd</entry>
2415 </row>
2416 </thead>
2417 <tbody>
2418 <row>
2419 <entry><constant>0</constant></entry>
2420 <entry>"program is running or service is OK"</entry>
2421 <entry>unit is active</entry>
2422 </row>
2423 <row>
2424 <entry><constant>1</constant></entry>
2425 <entry>"program is dead and <filename>/var/run</filename> pid file exists"</entry>
2426 <entry>unit <emphasis>not</emphasis> failed (used by <command>is-failed</command>)</entry>
2427 </row>
2428 <row>
2429 <entry><constant>2</constant></entry>
2430 <entry>"program is dead and <filename>/var/lock</filename> lock file exists"</entry>
2431 <entry>unused</entry>
2432 </row>
2433 <row>
2434 <entry><constant>3</constant></entry>
2435 <entry>"program is not running"</entry>
2436 <entry>unit is not active</entry>
2437 </row>
2438 <row>
2439 <entry><constant>4</constant></entry>
2440 <entry>"program or service status is unknown"</entry>
2441 <entry>no such unit</entry>
2442 </row>
2443 </tbody>
2444 </tgroup>
2445 </table>
2446
2447 <para>The mapping of LSB service states to systemd unit states is imperfect, so it is better to
2448 not rely on those return values but to look for specific unit states and substates instead.
2449 </para>
4a6022f0
ZJS
2450 </refsect1>
2451
7d4fb3b1
RC
2452 <refsect1>
2453 <title>Environment</title>
2454
2455 <variablelist class='environment-variables'>
2456 <varlistentry>
2457 <term><varname>$SYSTEMD_EDITOR</varname></term>
2458
2459 <listitem><para>Editor to use when editing units; overrides
2460 <varname>$EDITOR</varname> and <varname>$VISUAL</varname>. If neither
2461 <varname>$SYSTEMD_EDITOR</varname> nor <varname>$EDITOR</varname> nor
2462 <varname>$VISUAL</varname> are present or if it is set to an empty
2463 string or if their execution failed, systemctl will try to execute well
2464 known editors in this order:
9391a1c3 2465 <citerefentry project='die-net'><refentrytitle>editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
3ba3a79d
ZJS
2466 <citerefentry project='die-net'><refentrytitle>nano</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2467 <citerefentry project='die-net'><refentrytitle>vim</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2468 <citerefentry project='die-net'><refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
7d4fb3b1
RC
2469 </para></listitem>
2470 </varlistentry>
2471 </variablelist>
5bd27a17
ZJS
2472 <xi:include href="common-variables.xml" xpointer="log-level"/>
2473 <xi:include href="common-variables.xml" xpointer="log-color"/>
2474 <xi:include href="common-variables.xml" xpointer="log-time"/>
2475 <xi:include href="common-variables.xml" xpointer="log-location"/>
2476 <xi:include href="common-variables.xml" xpointer="log-target"/>
4ef3ca34
ZJS
2477 <xi:include href="common-variables.xml" xpointer="pager"/>
2478 <xi:include href="common-variables.xml" xpointer="less"/>
2479 <xi:include href="common-variables.xml" xpointer="lesscharset"/>
2480 <xi:include href="common-variables.xml" xpointer="lesssecure"/>
2481 <xi:include href="common-variables.xml" xpointer="colors"/>
2482 <xi:include href="common-variables.xml" xpointer="urlify"/>
7d4fb3b1 2483 </refsect1>
4a6022f0
ZJS
2484
2485 <refsect1>
2486 <title>See Also</title>
2487 <para>
2488 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
4a6022f0
ZJS
2489 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2490 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
a03fe1a5 2491 <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
4a6022f0 2492 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
ee41f602 2493 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
4a6022f0 2494 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
5aded369 2495 <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
7d4fb3b1 2496 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
432d5965 2497 <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
decde8cd 2498 <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
4a6022f0
ZJS
2499 </para>
2500 </refsect1>
7874bcd6
LP
2501
2502</refentry>