summaryrefslogtreecommitdiff
path: root/man/halt.xml
blob: f07e04a7c43ea6c116e5c9a5d3c2dc57b32f4993 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="halt">

        <refentryinfo>
                <title>halt</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>halt</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>halt</refname>
                <refname>poweroff</refname>
                <refname>reboot</refname>
                <refpurpose>Halt, power-off or reboot the machine</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>halt <arg choice="opt" rep="repeat">OPTIONS</arg></command>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>poweroff <arg choice="opt" rep="repeat">OPTIONS</arg></command>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>reboot <arg choice="opt" rep="repeat">OPTIONS</arg></command>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>halt</command>,
                <command>poweroff</command>, <command>reboot</command>
                may be used to halt, power-off or reboot the
                machine.</para>

        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>--help</option></term>

                                <listitem><para>Prints a short help
                                text and exits.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--halt</option></term>

                                <listitem><para>Halt the machine,
                                regardless which one of the three
                                commands is invoked.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-p</option></term>
                                <term><option>--poweroff</option></term>

                                <listitem><para>Power-off the machine,
                                regardless which one of the three
                                commands is invoked.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--reboot</option></term>

                                <listitem><para>Reboot the machine,
                                regardless which one of the three
                                commands is invoked.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-f</option></term>
                                <term><option>--force</option></term>

                                <listitem><para>Force immediate halt,
                                power-off, reboot. Don't contact the
                                init system.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-w</option></term>
                                <term><option>--wtmp-only</option></term>

                                <listitem><para>Only write wtmp
                                shutdown entry, don't actually halt,
                                power-off, reboot.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-d</option></term>
                                <term><option>--no-wtmp</option></term>

                                <listitem><para>Don't write wtmp
                                shutdown entry.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-n</option></term>
                                <term><option>--no-sync</option></term>

                                <listitem><para>Don't sync hard disks/storage media before
                                halt, power-off,
                                reboot.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--no-wall</option></term>

                                <listitem><para>Don't send wall
                                message before
                                halt, power-off, reboot.</para></listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>Exit status</title>

                <para>On success 0 is returned, a non-zero failure
                code otherwise.</para>
        </refsect1>

        <refsect1>
                <title>Notes</title>

                <para>These are legacy commands available for
                compatibility only.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>