shutdown.xml revision 798d3a524ea57aaf40cb53858aaa45ec702f012d
172N/A<?xml version='1.0'?> <!--*-nxml-*-->
172N/A<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
172N/A "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
172N/A
172N/A<!--
172N/A This file is part of systemd.
172N/A
172N/A Copyright 2010 Lennart Poettering
172N/A
172N/A systemd is free software; you can redistribute it and/or modify it
172N/A under the terms of the GNU Lesser General Public License as published by
172N/A the Free Software Foundation; either version 2.1 of the License, or
172N/A (at your option) any later version.
172N/A
172N/A systemd is distributed in the hope that it will be useful, but
172N/A WITHOUT ANY WARRANTY; without even the implied warranty of
172N/A MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
172N/A Lesser General Public License for more details.
172N/A
172N/A You should have received a copy of the GNU Lesser General Public License
172N/A along with systemd; If not, see <http://www.gnu.org/licenses/>.
172N/A-->
3347N/A
172N/A<refentry id="shutdown"
172N/A xmlns:xi="http://www.w3.org/2001/XInclude">
172N/A
172N/A <refentryinfo>
1273N/A <title>shutdown</title>
3573N/A <productname>systemd</productname>
3573N/A
3573N/A <authorgroup>
618N/A <author>
3573N/A <contrib>Developer</contrib>
1273N/A <firstname>Lennart</firstname>
172N/A <surname>Poettering</surname>
844N/A <email>lennart@poettering.net</email>
3573N/A </author>
3573N/A </authorgroup>
1273N/A </refentryinfo>
1273N/A
3573N/A <refmeta>
3347N/A <refentrytitle>shutdown</refentrytitle>
172N/A <manvolnum>8</manvolnum>
172N/A </refmeta>
172N/A
172N/A <refnamediv>
172N/A <refname>shutdown</refname>
172N/A <refpurpose>Halt, power-off or reboot the machine</refpurpose>
181N/A </refnamediv>
181N/A
181N/A <refsynopsisdiv>
172N/A <cmdsynopsis>
172N/A <command>shutdown</command>
172N/A <arg choice="opt" rep="repeat">OPTIONS</arg>
172N/A <arg choice="opt">TIME</arg>
172N/A <arg choice="opt" rep="repeat">WALL</arg>
172N/A </cmdsynopsis>
172N/A </refsynopsisdiv>
172N/A
172N/A <refsect1>
172N/A <title>Description</title>
172N/A
172N/A <para><command>shutdown</command> may be used to halt, power-off
172N/A or reboot the machine.</para>
172N/A
172N/A <para>The first argument may be a time string (which is usually
172N/A <literal>now</literal>). Optionally, this may be followed by a
172N/A wall message to be sent to all logged-in users before going
181N/A down.</para>
172N/A
172N/A <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-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>Do not halt, power-off, reboot, just write
wall message.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-wall</option></term>
<listitem><para>Do not send wall
message before
halt, power-off, reboot.</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>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>