From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 16 Aug 2010 13:56:42 +0000 (+0200)
Subject: man: document new shutdown features
X-Git-Tag: v8~81
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=5dc50792ac1bc627bf9b50d259b4e7546b3f8d86;ds=sidebyside

man: document new shutdown features
---

diff --git a/man/shutdown.xml b/man/shutdown.xml
index f2274a8a8..95884921a 100644
--- a/man/shutdown.xml
+++ b/man/shutdown.xml
@@ -49,7 +49,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 +59,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>now</literal> is
+                implied.</para>
+
+                <para>Note that to specify a wall message you must
+                speciy a time argument, too.</para>
+
+                <para>If the time argument is used, 5 minutes
+                before the system goes down the
+                <filename>/etc/nologin</filename> file is created to
+                ensure that further logins shall not be
+                allowed.</para>
         </refsect1>
 
         <refsect1>
@@ -126,6 +145,39 @@
                                 message before
                                 halt, power-off, reboot.</para></listitem>
                         </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-f</option></term>
+
+                                <listitem><para>Skip file system check
+                                on reboot. This is equivalent to
+                                creating the
+                                <filename>/fastboot</filename> file
+                                before going down.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-F</option></term>
+
+                                <listitem><para>Force file system
+                                check on reboot. This is equivalent to
+                                creating the
+                                <filename>/forcefsck</filename> file
+                                before going down.</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>
 
diff --git a/man/systemd.special.xml.in b/man/systemd.special.xml.in
index c6c2393fc..2855f6a25 100644
--- a/man/systemd.special.xml.in
+++ b/man/systemd.special.xml.in
@@ -655,6 +655,26 @@
                                         connected to syslog or the
                                         kernel log buffer.</para>
                                 </listitem>
+                        </varlistentry>
+                         <varlistentry>
+                                <term><filename>systemd-shutdownd.service</filename></term>
+                                <listitem>
+                                        <para>This is internally used
+                                        by
+                                        <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                                        to implement delayed shutdowns.</para>
+                                        <para>This is a
+                                        socket-activated service, see
+                                        <filename>system-shutdownd.socket</filename>.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><filename>systemd-shutdownd.socket</filename></term>
+                                <listitem>
+                                        <para>Socket activation unit
+                                        for
+                                        <filename>system-shutdownd.service</filename>.</para>
+                                </listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><filename>umount.target</filename></term>
@@ -723,9 +743,9 @@
         <refsect1>
                   <title>See Also</title>
                   <para>
-                          <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-                          <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-                          <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                   </para>
         </refsect1>
diff --git a/man/systemd.xml b/man/systemd.xml
index b35469c10..6edce4996 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -937,6 +937,17 @@
                                 abstract namespace.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><filename>@/org/freedesktop/systemd1/shutdown</filename></term>
+
+                                <listitem><para>Used internally by the
+                                <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                                tool to implement delayed
+                                shutdowns. This is an AF_UNIX datagram
+                                socket in the Linux abstract
+                                namespace.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><filename>@/org/freedesktop/systemd1/private</filename></term>