1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>systemctl</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"/></head><body><div class="refentry" title="systemctl"><a id="systemctl"/><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>systemctl — Control the systemd system and service manager</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">systemctl [OPTIONS...] {COMMAND} [NAME...]</code> </p></div></div><div class="refsect1" title="Description"><a id="id447628"/><h2>Description</h2><p><span class="command"><strong>systemctl</strong></span> may be used to
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemctl</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="systemctl"><a name="systemctl"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemctl — Control the systemd system and service manager</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">systemctl [OPTIONS...] {COMMAND} [NAME...]</code> </p></div></div><div class="refsect1" title="Description"><a name="id497096"></a><h2>Description</h2><p><span class="command"><strong>systemctl</strong></span> may be used to
4
2
introspect and control the state of the
5
3
<span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span>
6
system and service manager.</p></div><div class="refsect1" title="Options"><a id="id447650"/><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl><dt><span class="term"><code class="option">--help</code>, </span><span class="term"><code class="option">-h</code></span></dt><dd><p>Prints a short help
4
system and service manager.</p></div><div class="refsect1" title="Options"><a name="id497118"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl><dt><span class="term"><code class="option">--help</code>, </span><span class="term"><code class="option">-h</code></span></dt><dd><p>Prints a short help
7
5
text and exits.</p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p>Prints a short version
8
6
string and exits.</p></dd><dt><span class="term"><code class="option">--type=</code>, </span><span class="term"><code class="option">-t</code></span></dt><dd><p>When listing units,
9
7
limit display to certain unit
139
137
<span class="command"><strong>halt</strong></span>,
140
138
<span class="command"><strong>poweroff</strong></span>,
141
139
<span class="command"><strong>reboot</strong></span> or
142
<span class="command"><strong>kexec</strong></span> execute
140
<span class="command"><strong>kexec</strong></span> execute the
143
141
selected operation without shutting
144
142
down all units. However, all processes
145
143
will be killed forcibly and all file
146
144
systems are unmounted or remounted
147
145
read-only. This is hence a drastic but
148
146
relatively safe option to request an
149
immediate reboot.</p></dd><dt><span class="term"><code class="option">--root=</code></span></dt><dd><p>When used with
148
<code class="option">--force</code> is specified
149
twice for these operations, they will
150
be executed immediately without
151
terminating any processes or umounting
152
any file systems. Warning: specifying
153
<code class="option">--force</code> twice with
154
any of these operations might result
155
in data loss.</p></dd><dt><span class="term"><code class="option">--root=</code></span></dt><dd><p>When used with
150
156
<span class="command"><strong>enable</strong></span>/<span class="command"><strong>disable</strong></span>/<span class="command"><strong>is-enabled</strong></span> (and
151
157
related commands), use alternative
152
158
root path when looking for unit
168
174
talk to the remote systemd
169
175
instance.</p></dd><dt><span class="term"><code class="option">-P</code>, </span><span class="term"><code class="option">--privileged</code></span></dt><dd><p>Acquire privileges via
170
176
PolicyKit before executing the
171
operation.</p></dd></dl></div><p>The following commands are understood:</p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>list-units</strong></span></span></dt><dd><p>List known units.</p></dd><dt><span class="term"><span class="command"><strong>start [NAME...]</strong></span></span></dt><dd><p>Start (activate) one
177
operation.</p></dd><dt><span class="term"><code class="option">--lines=</code>, </span><span class="term"><code class="option">-n</code></span></dt><dd><p>When used with
178
<span class="command"><strong>status</strong></span> controls the
179
number of journal lines to show,
180
counting from the most recent
181
ones. Takes a positive integer
182
argument. Defaults to
183
10.</p></dd><dt><span class="term"><code class="option">--follow</code>, </span><span class="term"><code class="option">-f</code></span></dt><dd><p>When used with
184
<span class="command"><strong>status</strong></span> continously
185
prints new journal entries as they are
187
journal.</p></dd><dt><span class="term"><code class="option">--output=</code>, </span><span class="term"><code class="option">-o</code></span></dt><dd><p>When used with
188
<span class="command"><strong>status</strong></span> controls the
189
formatting of the journal entries that
190
are shown. For the available choices
192
<span class="citerefentry"><span class="refentrytitle">systemd-journalctl</span>(1)</span>. Defaults
194
<code class="literal">short</code>.</p></dd></dl></div><p>The following commands are understood:</p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>list-units</strong></span></span></dt><dd><p>List known units.</p></dd><dt><span class="term"><span class="command"><strong>start [NAME...]</strong></span></span></dt><dd><p>Start (activate) one
172
195
or more units specified on the command
173
196
line.</p></dd><dt><span class="term"><span class="command"><strong>stop [NAME...]</strong></span></span></dt><dd><p>Stop (deactivate) one
174
197
or more units specified on the command
242
265
this will also print the current unit
243
266
state to STDOUT.</p></dd><dt><span class="term"><span class="command"><strong>status [NAME...|PID...]</strong></span></span></dt><dd><p>Show terse runtime
244
267
status information about one or more
245
units. This function is intended to
246
generate human-readable output. If you
247
are looking for computer-parsable
248
output, use <span class="command"><strong>show</strong></span>
249
instead. If a PID is passed
250
information about the unit the process
251
of the PID belongs to is
252
shown.</p></dd><dt><span class="term"><span class="command"><strong>show [NAME...|JOB...]</strong></span></span></dt><dd><p>Show properties of one
268
units, followed by its most recent log
269
data from the journal. This function
270
is intended to generate human-readable
271
output. If you are looking for
272
computer-parsable output, use
273
<span class="command"><strong>show</strong></span> instead. If a
274
PID is passed information about the
275
unit the process of the PID belongs to
276
is shown.</p></dd><dt><span class="term"><span class="command"><strong>show [NAME...|JOB...]</strong></span></span></dt><dd><p>Show properties of one
253
277
or more units, jobs or the manager
254
278
itself. If no argument is specified
255
279
properties of the manager will be
529
553
system. This is mostly equivalent to
530
554
<span class="command"><strong>start halt.target</strong></span>
531
555
but also prints a wall message to all
533
combined with <code class="option">--force</code>
534
shutdown of all running services is
535
skipped, however all processes are killed
536
and all file systems are unmounted or
556
users. If combined with
557
<code class="option">--force</code> shutdown of
558
all running services is skipped,
559
however all processes are killed and
560
all file systems are unmounted or
537
561
mounted read-only, immediately
539
system halt.</p></dd><dt><span class="term"><span class="command"><strong>poweroff</strong></span></span></dt><dd><p>Shut down and
562
followed by the system halt. If
563
<code class="option">--force</code> is specified
564
twice the the operation is immediately
565
executed without terminating any
566
processes or unmounting any file
567
systems. This may result in data
568
loss.</p></dd><dt><span class="term"><span class="command"><strong>poweroff</strong></span></span></dt><dd><p>Shut down and
540
569
power-off the system. This is mostly
541
570
equivalent to <span class="command"><strong>start
542
571
poweroff.target</strong></span> but also
543
prints a wall message to all
572
prints a wall message to all users. If
545
573
combined with <code class="option">--force</code>
546
574
shutdown of all running services is
547
skipped, however all processes are killed
548
and all file systems are unmounted or
549
mounted read-only, immediately
551
powering off.</p></dd><dt><span class="term"><span class="command"><strong>reboot</strong></span></span></dt><dd><p>Shut down and
552
reboot the system. This is mostly
553
equivalent to <span class="command"><strong>start
575
skipped, however all processes are
576
killed and all file systems are
577
unmounted or mounted read-only,
578
immediately followed by the powering
579
off. If <code class="option">--force</code> is
580
specified twice the the operation is
581
immediately executed without
582
terminating any processes or
583
unmounting any file systems. This may
584
result in data loss.</p></dd><dt><span class="term"><span class="command"><strong>reboot</strong></span></span></dt><dd><p>Shut down and reboot
585
the system. This is mostly equivalent
586
to <span class="command"><strong>start
554
587
reboot.target</strong></span> but also
555
prints a wall message to all
588
prints a wall message to all users. If
557
589
combined with <code class="option">--force</code>
558
590
shutdown of all running services is
559
skipped, however all processes are killed
560
and all file systems are unmounted or
561
mounted read-only, immediately
563
reboot.</p></dd><dt><span class="term"><span class="command"><strong>kexec</strong></span></span></dt><dd><p>Shut down and reboot
591
skipped, however all processes are
592
killed and all file systems are
593
unmounted or mounted read-only,
594
immediately followed by the reboot. If
595
<code class="option">--force</code> is specified
596
twice the the operation is immediately
597
executed without terminating any
598
processes or unmounting any file
599
systems. This may result in data
600
loss.</p></dd><dt><span class="term"><span class="command"><strong>kexec</strong></span></span></dt><dd><p>Shut down and reboot
564
601
the system via kexec. This is mostly
565
602
equivalent to <span class="command"><strong>start
566
603
kexec.target</strong></span> but also prints
576
613
supported for user service managers
577
614
(i.e. in conjunction with the
578
615
<code class="option">--user</code> option) and
579
will fail otherwise.</p></dd></dl></div></div><div class="refsect1" title="Exit status"><a id="id458094"/><h2>Exit status</h2><p>On success 0 is returned, a non-zero failure
580
code otherwise.</p></div><div class="refsect1" title="Environment"><a id="id458104"/><h2>Environment</h2><div class="variablelist"><dl><dt><span class="term"><code class="varname">$SYSTEMD_PAGER</code></span></dt><dd><p>Pager to use when
616
will fail otherwise.</p></dd></dl></div></div><div class="refsect1" title="Exit status"><a name="id539943"></a><h2>Exit status</h2><p>On success 0 is returned, a non-zero failure
617
code otherwise.</p></div><div class="refsect1" title="Environment"><a name="id539953"></a><h2>Environment</h2><div class="variablelist"><dl><dt><span class="term"><code class="varname">$SYSTEMD_PAGER</code></span></dt><dd><p>Pager to use when
581
618
<code class="option">--no-pager</code> is not given;
582
619
overrides <code class="varname">$PAGER</code>. Setting
583
620
this to an empty string or the value
584
621
<code class="literal">cat</code> is equivalent to passing
585
<code class="option">--no-pager</code>.</p></dd></dl></div></div><div class="refsect1" title="See Also"><a id="id458143"/><h2>See Also</h2><p>
622
<code class="option">--no-pager</code>.</p></dd></dl></div></div><div class="refsect1" title="See Also"><a name="id539992"></a><h2>See Also</h2><p>
586
623
<span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span>,
587
624
<span class="citerefentry"><span class="refentrytitle">systemadm</span>(1)</span>,
625
<span class="citerefentry"><span class="refentrytitle">systemd-journalctl</span>(1)</span>,
588
626
<span class="citerefentry"><span class="refentrytitle">systemd-loginctl</span>(1)</span>,
589
627
<span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span>,
590
628
<span class="citerefentry"><span class="refentrytitle">systemd.special</span>(7)</span>,
added
removed
man/systemctl.html
