man: don't document systemctl --failed

[elogind.git] / man / systemctl.xml

diff --git a/man/systemctl.xml b/man/systemctl.xml
index 7cbaa6ccb0112ca831c0b3a02751bb42f29c053e..8a4cff8833a578a7a8617919e5d37b1f38e3daf0 100644 (file)
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -98,9 +98,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><option>--state=</option></term>
 
         <listitem>
-        <para>The argument should be a comma-separated list of unit LOAD,
-        SUB, or ACTIVE states. When listing units, show only those
-        in specified states.</para>
+        <para>The argument should be a comma-separated list of unit
+        LOAD, SUB, or ACTIVE states. When listing units, show only
+        those in specified states. Use <option>--state=failed</option>
+        to show only failed units.</para>
         </listitem>
       </varlistentry>
 
@@ -321,6 +322,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <xi:include href="user-system-options.xml" xpointer="user" />
       <xi:include href="user-system-options.xml" xpointer="system" />
 
+      <!-- we do not document -failed here, as it has been made
+           redundant by -state=failed, which it predates. To keep
+           things simple we only document the new switch, while
+           keeping the old one around for compatibility only. -->
+
       <varlistentry>
         <term><option>--no-wall</option></term>