summaryrefslogtreecommitdiffstats
path: root/man/shutdown.xml
blob: 24a934f45ec318f806bd9f9b37c0b8311db2eb2d (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
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->

<refentry id="shutdown"
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>shutdown</title>
    <productname>systemd</productname>
  </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</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="opt">TIME</arg>
      <arg choice="opt" rep="repeat">WALL</arg>
    </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>+1</literal> is implied.</para>

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

    <para>If the time argument is used, 5 minutes before the system
    goes down the <filename>/run/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>

        <xi:include href="standard-options.xml" xpointer="help-text" />
      </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 the machine off (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>The same as <option>--poweroff</option>, but does not override the action to take if
        it is "halt". E.g. <command>shutdown --reboot -h</command> means "poweroff", but <command>shutdown
        --halt -h</command> means "halt".</para></listitem>
      </varlistentry>

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

        <listitem><para>Do not halt, power off, or reboot, but just write the wall message.</para></listitem>
      </varlistentry>

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

        <listitem><para>Do not send wall message before halt, power off, or reboot.</para></listitem>
      </varlistentry>

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

        <listitem><para>Cancel a pending shutdown. This may be used to 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>

      <varlistentry>
        <term><option>--show</option></term>

        <listitem><para>Show a pending shutdown action and time if
        there is any.</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>Compatibility</title>

    <para>The <command> shutdown</command> command in previous init systems (including sysvinit) defaulted to
    single-user mode instead of powering off the machine. To change into single-user mode, use
    <command>systemctl rescue</command> instead.</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 project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>