summaryrefslogtreecommitdiff
path: root/man/shutdown.xml
blob: 95884921ace4dac99f32132cd5b429e723a23fa5 (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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<?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="shutdown">

        <refentryinfo>
                <title>shutdown</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>shutdown</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

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

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>shutdown <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">TIME</arg> <arg choice="opt" rep="repeat">WALL</arg></command>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

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

                <para>The first argument may be a time string (which
                is usually <literal>now</literal>). Optionally, this
                may be followed by a wall message to be sent to all
                logged-in users before going down.</para>

                <para>The time string may either be in the format
                <literal>hh:mm</literal> for hour/minutes specifying
                the time to execute the shutdown at, specified in 24h
                clock format. Alternatively it may be in the syntax
                <literal>+m</literal> referring to the specified
                number of minutes m from now. <literal>now</literal>
                is an alias for <literal>+0</literal>, i.e. for
                triggering an immediate shutdown. If no time argument
                is specified, <literal>now</literal> is
                implied.</para>

                <para>Note that to specify a wall message you must
                speciy a time argument, too.</para>

                <para>If the time argument is used, 5 minutes
                before the system goes down the
                <filename>/etc/nologin</filename> file is created to
                ensure that further logins shall not be
                allowed.</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>-H</option></term>
                                <term><option>--halt</option></term>

                                <listitem><para>Halt the machine.</para></listitem>
                        </varlistentry>

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

                                <listitem><para>Power-off the
                                machine (the default).</para></listitem>
                        </varlistentry>

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

                                <listitem><para>Reboot the
                                machine.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-h</option></term>

                                <listitem><para>Equivalent to
                                <option>--poweroff</option>, unless
                                <option>--halt</option> is
                                specified.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-k</option></term>

                                <listitem><para>Don't halt, power-off,
                                reboot, just write wall
                                message.</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>

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

                                <listitem><para>Skip file system check
                                on reboot. This is equivalent to
                                creating the
                                <filename>/fastboot</filename> file
                                before going down.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-F</option></term>

                                <listitem><para>Force file system
                                check on reboot. This is equivalent to
                                creating the
                                <filename>/forcefsck</filename> file
                                before going down.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-c</option></term>

                                <listitem><para>Cancel a pending
                                shutdown. This may be used cancel the
                                effect of an invocation of
                                <command>shutdown</command> with a
                                time argument that is not
                                <literal>+0</literal> or
                                <literal>now</literal>.</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>This is a legacy command 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>halt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>