]>
Commit | Line | Data |
---|---|---|
160cd5c9 | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
0307f791 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> |
160cd5c9 | 5 | |
dfdebb1b | 6 | <refentry id="halt" |
798d3a52 ZJS |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
8 | ||
9 | <refentryinfo> | |
10 | <title>halt</title> | |
11 | <productname>systemd</productname> | |
798d3a52 ZJS |
12 | </refentryinfo> |
13 | ||
14 | <refmeta> | |
15 | <refentrytitle>halt</refentrytitle> | |
16 | <manvolnum>8</manvolnum> | |
17 | </refmeta> | |
18 | ||
19 | <refnamediv> | |
20 | <refname>halt</refname> | |
21 | <refname>poweroff</refname> | |
22 | <refname>reboot</refname> | |
23 | <refpurpose>Halt, power-off or reboot the machine</refpurpose> | |
24 | </refnamediv> | |
25 | ||
26 | <refsynopsisdiv> | |
27 | <cmdsynopsis> | |
28 | <command>halt</command> | |
29 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
30 | </cmdsynopsis> | |
31 | <cmdsynopsis> | |
32 | <command>poweroff</command> | |
33 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
34 | </cmdsynopsis> | |
35 | <cmdsynopsis> | |
36 | <command>reboot</command> | |
37 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
38 | </cmdsynopsis> | |
39 | </refsynopsisdiv> | |
40 | ||
41 | <refsect1> | |
42 | <title>Description</title> | |
43 | ||
44 | <para><command>halt</command>, <command>poweroff</command>, | |
45 | <command>reboot</command> may be used to halt, power-off or reboot | |
46 | the machine.</para> | |
47 | ||
48 | </refsect1> | |
49 | ||
50 | <refsect1> | |
51 | <title>Options</title> | |
52 | ||
53 | <para>The following options are understood:</para> | |
54 | ||
55 | <variablelist> | |
56 | <varlistentry> | |
57 | <term><option>--help</option></term> | |
58 | ||
59 | <xi:include href="standard-options.xml" xpointer="help-text" /> | |
60 | </varlistentry> | |
61 | ||
62 | <varlistentry> | |
63 | <term><option>--halt</option></term> | |
64 | ||
65 | <listitem><para>Halt the machine, regardless of which one of | |
66 | the three commands is invoked.</para></listitem> | |
67 | </varlistentry> | |
68 | ||
69 | <varlistentry> | |
70 | <term><option>-p</option></term> | |
71 | <term><option>--poweroff</option></term> | |
72 | ||
73 | <listitem><para>Power-off the machine, regardless of which one | |
74 | of the three commands is invoked.</para></listitem> | |
75 | </varlistentry> | |
76 | ||
77 | <varlistentry> | |
78 | <term><option>--reboot</option></term> | |
79 | ||
80 | <listitem><para>Reboot the machine, regardless of which one of | |
81 | the three commands is invoked.</para></listitem> | |
82 | </varlistentry> | |
83 | ||
84 | <varlistentry> | |
85 | <term><option>-f</option></term> | |
86 | <term><option>--force</option></term> | |
87 | ||
5d9adb5b ZJS |
88 | <listitem><para>Force immediate halt, power-off, or reboot. When |
89 | specified once, this results in an immediate but clean shutdown | |
90 | by the system manager. When specified twice, this results in an | |
91 | immediate shutdown without contacting the system manager. See the | |
92 | description of <option>--force</option> in | |
93 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
94 | for more details.</para></listitem> | |
798d3a52 ZJS |
95 | </varlistentry> |
96 | ||
97 | <varlistentry> | |
98 | <term><option>-w</option></term> | |
99 | <term><option>--wtmp-only</option></term> | |
100 | ||
101 | <listitem><para>Only write wtmp shutdown entry, do not | |
102 | actually halt, power-off, reboot.</para></listitem> | |
103 | </varlistentry> | |
104 | ||
105 | <varlistentry> | |
106 | <term><option>-d</option></term> | |
107 | <term><option>--no-wtmp</option></term> | |
108 | ||
109 | <listitem><para>Do not write wtmp shutdown | |
110 | entry.</para></listitem> | |
111 | </varlistentry> | |
f3f054f0 TB |
112 | |
113 | <varlistentry> | |
114 | <term><option>-n</option></term> | |
115 | <term><option>--no-sync</option></term> | |
116 | ||
117 | <listitem><para>Don't sync hard disks/storage media before | |
118 | halt, power-off, reboot.</para></listitem> | |
119 | </varlistentry> | |
798d3a52 ZJS |
120 | |
121 | <varlistentry> | |
122 | <term><option>--no-wall</option></term> | |
123 | ||
124 | <listitem><para>Do not send wall message before halt, | |
125 | power-off, reboot.</para></listitem> | |
126 | </varlistentry> | |
127 | </variablelist> | |
128 | </refsect1> | |
129 | ||
130 | <refsect1> | |
131 | <title>Exit status</title> | |
132 | ||
133 | <para>On success, 0 is returned, a non-zero failure code | |
134 | otherwise.</para> | |
135 | </refsect1> | |
136 | ||
137 | <refsect1> | |
138 | <title>Notes</title> | |
139 | ||
1b2ad5d9 | 140 | <para>These commands are implemented in a way that preserves compatibility with |
2e772f30 ZJS |
141 | the original SysV commands. |
142 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
143 | verbs <command>halt</command>, <command>poweroff</command>, | |
144 | <command>reboot</command> provide the same functionality with some additional | |
145 | features.</para> | |
798d3a52 ZJS |
146 | </refsect1> |
147 | ||
148 | <refsect1> | |
149 | <title>See Also</title> | |
150 | <para> | |
151 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
152 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
153 | <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
154 | <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
155 | </para> | |
156 | </refsect1> | |
160cd5c9 LP |
157 | |
158 | </refentry> |