X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fshutdown.xml;h=6a4c1844a47ad819ca709d3e428c68c4fe87017c;hp=bff68213e6854ee6ca050feb938e03e973d66e75;hb=9b15b7846d4de01bb5d9700a24077787e984e8ab;hpb=160cd5c9aa2301892e13950015de7968c764340d

diff --git a/man/shutdown.xml b/man/shutdown.xml
index bff68213e..6a4c1844a 100644
--- a/man/shutdown.xml
+++ b/man/shutdown.xml
@@ -8,20 +8,21 @@
   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
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 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.
+  Lesser General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="shutdown">
+<refentry id="shutdown"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>shutdown</title>
@@ -49,7 +50,7 @@
 
         <refsynopsisdiv>
                 <cmdsynopsis>
-                        <command>shutdown <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">now</arg> <arg choice="opt" rep="repeat">WALL</arg></command>
+                        <command>shutdown <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">TIME</arg> <arg choice="opt" rep="repeat">WALL</arg></command>
                 </cmdsynopsis>
         </refsynopsisdiv>
 
@@ -59,11 +60,30 @@
                 <para><command>shutdown</command> may be used to halt,
                 power-off or reboot the machine.</para>
 
-                <para>The first argument should be the string
-                <command>now</command> which however is ignored by
-                this implementation. Optionally, this may be followed
-                by a wall message to be sent to all logged-in users
-                before going down.</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>
@@ -75,8 +95,7 @@
                         <varlistentry>
                                 <term><option>--help</option></term>
 
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
+                                <xi:include href="standard-options.xml" xpointer="help-text" />
                         </varlistentry>
 
                         <varlistentry>
@@ -112,9 +131,9 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--k</option></term>
+                                <term><option>-k</option></term>
 
-                                <listitem><para>Don't halt, power-off,
+                                <listitem><para>Do not halt, power-off,
                                 reboot, just write wall
                                 message.</para></listitem>
                         </varlistentry>
@@ -122,33 +141,40 @@
                         <varlistentry>
                                 <term><option>--no-wall</option></term>
 
-                                <listitem><para>Don't send wall
+                                <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
+                <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>halt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 </para>
         </refsect1>