man/shutdown.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7 -->
   8
   9 <refentry id="shutdown"
  10     xmlns:xi="http://www.w3.org/2001/XInclude">
  11
  12   <refentryinfo>
  13     <title>shutdown</title>
  14     <productname>systemd</productname>
  15
  16     <authorgroup>
  17       <author>
  18         <contrib>Developer</contrib>
  19         <firstname>Lennart</firstname>
  20         <surname>Poettering</surname>
  21         <email>lennart@poettering.net</email>
  22       </author>
  23     </authorgroup>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle>shutdown</refentrytitle>
  28     <manvolnum>8</manvolnum>
  29   </refmeta>
  30
  31   <refnamediv>
  32     <refname>shutdown</refname>
  33     <refpurpose>Halt, power-off or reboot the machine</refpurpose>
  34   </refnamediv>
  35
  36   <refsynopsisdiv>
  37     <cmdsynopsis>
  38       <command>shutdown</command>
  39       <arg choice="opt" rep="repeat">OPTIONS</arg>
  40       <arg choice="opt">TIME</arg>
  41       <arg choice="opt" rep="repeat">WALL</arg>
  42     </cmdsynopsis>
  43   </refsynopsisdiv>
  44
  45   <refsect1>
  46     <title>Description</title>
  47
  48     <para><command>shutdown</command> may be used to halt, power-off
  49     or reboot the machine.</para>
  50
  51     <para>The first argument may be a time string (which is usually
  52     <literal>now</literal>). Optionally, this may be followed by a
  53     wall message to be sent to all logged-in users before going
  54     down.</para>
  55
  56     <para>The time string may either be in the format
  57     <literal>hh:mm</literal> for hour/minutes specifying the time to
  58     execute the shutdown at, specified in 24h clock format.
  59     Alternatively it may be in the syntax <literal>+m</literal>
  60     referring to the specified number of minutes m from now.
  61     <literal>now</literal> is an alias for <literal>+0</literal>, i.e.
  62     for triggering an immediate shutdown. If no time argument is
  63     specified, <literal>+1</literal> is implied.</para>
  64
  65     <para>Note that to specify a wall message you must specify a time
  66     argument, too.</para>
  67
  68     <para>If the time argument is used, 5 minutes before the system
  69     goes down the <filename>/run/nologin</filename> file is created to
  70     ensure that further logins shall not be allowed.</para>
  71   </refsect1>
  72
  73   <refsect1>
  74     <title>Options</title>
  75
  76     <para>The following options are understood:</para>
  77
  78     <variablelist>
  79       <varlistentry>
  80         <term><option>--help</option></term>
  81
  82         <xi:include href="standard-options.xml" xpointer="help-text" />
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term><option>-H</option></term>
  87         <term><option>--halt</option></term>
  88
  89         <listitem><para>Halt the machine.</para></listitem>
  90       </varlistentry>
  91
  92       <varlistentry>
  93         <term><option>-P</option></term>
  94         <term><option>--poweroff</option></term>
  95
  96         <listitem><para>Power-off the machine (the
  97         default).</para></listitem>
  98       </varlistentry>
  99
 100       <varlistentry>
 101         <term><option>-r</option></term>
 102         <term><option>--reboot</option></term>
 103
 104         <listitem><para>Reboot the
 105         machine.</para></listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term><option>-h</option></term>
 110
 111         <listitem><para>Equivalent to <option>--poweroff</option>,
 112         unless <option>--halt</option> is specified.</para></listitem>
 113       </varlistentry>
 114
 115       <varlistentry>
 116         <term><option>-k</option></term>
 117
 118         <listitem><para>Do not halt, power-off, reboot, just write
 119         wall message.</para></listitem>
 120       </varlistentry>
 121
 122       <varlistentry>
 123         <term><option>--no-wall</option></term>
 124
 125         <listitem><para>Do not send wall
 126         message before
 127         halt, power-off, reboot.</para></listitem>
 128       </varlistentry>
 129
 130       <varlistentry>
 131         <term><option>-c</option></term>
 132
 133         <listitem><para>Cancel a pending shutdown. This may be used
 134         cancel the effect of an invocation of
 135         <command>shutdown</command> with a time argument that is not
 136         <literal>+0</literal> or
 137         <literal>now</literal>.</para></listitem>
 138       </varlistentry>
 139
 140     </variablelist>
 141   </refsect1>
 142
 143   <refsect1>
 144     <title>Exit status</title>
 145
 146     <para>On success, 0 is returned, a non-zero failure code
 147     otherwise.</para>
 148   </refsect1>
 149
 150   <refsect1>
 151     <title>See Also</title>
 152     <para>
 153       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 154       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 155       <citerefentry><refentrytitle>halt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 156       <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 157     </para>
 158   </refsect1>
 159
 160 </refentry>