From: Nick Rosbrook <nick.rosbrook@canonical.com>
Date: Fri, 28 Oct 2022 15:01:15 +0000 (-0400)
Subject: man: document reboot --poweroff exception
X-Git-Tag: v252~18
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6dfaeac3704c68a1e297cef0c08e5b6ee1dbf3b7;p=thirdparty%2Fsystemd.git

man: document reboot --poweroff exception

When reboot is invoked, the -p/--poweroff option is intentionally
ignored. Update the man page to reflect this exception.
---

diff --git a/man/halt.xml b/man/halt.xml
index 6d272f7daf7..c13ee5c1448 100644
--- a/man/halt.xml
+++ b/man/halt.xml
@@ -69,8 +69,9 @@
         <term><option>-p</option></term>
         <term><option>--poweroff</option></term>
 
-        <listitem><para>Power-off the machine, regardless of which one
-        of the three commands is invoked.</para></listitem>
+        <listitem><para>Power-off the machine, when either <command>halt</command>
+        or <command>poweroff</command> is invoked. This option is ignored when
+        <command>reboot</command> is invoked.</para></listitem>
       </varlistentry>
 
       <varlistentry>