diff pwm.1.xml @ 14:a01899a6e4bb

Extend help command to show usage information for commands
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Mon, 07 Aug 2017 18:16:47 +0200
parents cf81eb0c2d5a
children 3380c8fd9776
line wrap: on
line diff
--- a/pwm.1.xml	Mon Aug 07 16:59:47 2017 +0200
+++ b/pwm.1.xml	Mon Aug 07 18:16:47 2017 +0200
@@ -34,7 +34,7 @@
       <email>guido+pwm@berhoerster.name</email>
       <personblurb/>
     </author>
-    <date>6 August, 2017</date>
+    <date>7 August, 2017</date>
   </info>
   <refmeta>
     <refentrytitle>pwm</refentrytitle>
@@ -458,12 +458,19 @@
           <listitem>
             <cmdsynopsis>
               <command>help</command>
+              <arg choice="opt">
+                <replaceable>command</replaceable>
+              </arg>
             </cmdsynopsis>
             <cmdsynopsis>
               <command>h</command>
+              <arg choice="opt">
+                <replaceable>command</replaceable>
+              </arg>
               <sbr/>
             </cmdsynopsis>
-            <para>Display a list of all commands and a short help text.</para>
+            <para>Display a summary of all commands or usage information for
+            the specified <replaceable>command</replaceable>.</para>
           </listitem>
         </varlistentry>
         <varlistentry>