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   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU General Public License as published by
  12   the Free Software Foundation; either version 2 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   General Public License for more details.
  19
  20   You should have received a copy of the GNU General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="shutdown">
  25
  26         <refentryinfo>
  27                 <title>shutdown</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Lennart</firstname>
  34                                 <surname>Poettering</surname>
  35                                 <email>lennart@poettering.net</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>shutdown</refentrytitle>
  42                 <manvolnum>8</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>shutdown</refname>
  47                 <refpurpose>Halt, power-off or reboot the machine</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <cmdsynopsis>
  52                         <command>shutdown <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">now</arg> <arg choice="opt" rep="repeat">WALL</arg></command>
  53                 </cmdsynopsis>
  54         </refsynopsisdiv>
  55
  56         <refsect1>
  57                 <title>Description</title>
  58
  59                 <para><command>shutdown</command> may be used to halt,
  60                 power-off or reboot the machine.</para>
  61
  62                 <para>The first argument should be the string
  63                 <command>now</command> which however is ignored by
  64                 this implementation. Optionally, this may be followed
  65                 by a wall message to be sent to all logged-in users
  66                 before going down.</para>
  67         </refsect1>
  68
  69         <refsect1>
  70                 <title>Options</title>
  71
  72                 <para>The following options are understood:</para>
  73
  74                 <variablelist>
  75                         <varlistentry>
  76                                 <term><option>--help</option></term>
  77
  78                                 <listitem><para>Prints a short help
  79                                 text and exits.</para></listitem>
  80                         </varlistentry>
  81
  82                         <varlistentry>
  83                                 <term><option>-H</option></term>
  84                                 <term><option>--halt</option></term>
  85
  86                                 <listitem><para>Halt the machine.</para></listitem>
  87                         </varlistentry>
  88
  89                         <varlistentry>
  90                                 <term><option>-P</option></term>
  91                                 <term><option>--poweroff</option></term>
  92
  93                                 <listitem><para>Power-off the
  94                                 machine (the default).</para></listitem>
  95                         </varlistentry>
  96
  97                         <varlistentry>
  98                                 <term><option>-r</option></term>
  99                                 <term><option>--reboot</option></term>
 100
 101                                 <listitem><para>Reboot the
 102                                 machine.</para></listitem>
 103                         </varlistentry>
 104
 105                         <varlistentry>
 106                                 <term><option>-h</option></term>
 107
 108                                 <listitem><para>Equivalent to
 109                                 <option>--poweroff</option>, unless
 110                                 <option>--halt</option> is
 111                                 specified.</para></listitem>
 112                         </varlistentry>
 113
 114                         <varlistentry>
 115                                 <term><option>--k</option></term>
 116
 117                                 <listitem><para>Don't halt, power-off,
 118                                 reboot, just write wall
 119                                 message.</para></listitem>
 120                         </varlistentry>
 121
 122                         <varlistentry>
 123                                 <term><option>--no-wall</option></term>
 124
 125                                 <listitem><para>Don't send wall
 126                                 message before
 127                                 halt, power-off, reboot.</para></listitem>
 128                         </varlistentry>
 129                 </variablelist>
 130         </refsect1>
 131
 132         <refsect1>
 133                 <title>Exit status</title>
 134
 135                 <para>On success 0 is returned, a non-zero failure
 136                 code otherwise.</para>
 137         </refsect1>
 138
 139         <refsect1>
 140                 <title>Notes</title>
 141
 142                 <para>This is a legacy command available for
 143                 compatibility only.</para>
 144         </refsect1>
 145
 146         <refsect1>
 147                 <title>See Also</title>
 148                 <para>
 149                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 150                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 151                         <citerefentry><refentrytitle>halt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 152                         <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 153                 </para>
 154         </refsect1>
 155
 156 </refentry>