From 60889d41f6f43ac396d2f7bb71a8bcd166f9ca66 Mon Sep 17 00:00:00 2001
From: patacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>
Date: Sat, 4 Aug 2012 22:17:37 +0000
Subject: Update NSH documentation; Add option to reduce size of help commnd
 without completely eliminating it

git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@5009 7fd9a85b-ad96-42d3-883c-3090e2eb8679
---
 nuttx/Documentation/NuttShell.html | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

(limited to 'nuttx')

diff --git a/nuttx/Documentation/NuttShell.html b/nuttx/Documentation/NuttShell.html
index 249bf2636..8e57e27b2 100644
--- a/nuttx/Documentation/NuttShell.html
+++ b/nuttx/Documentation/NuttShell.html
@@ -1046,12 +1046,27 @@ get [-b|-n] [-f &lt;local-path&gt;] -h &lt;ip-address&gt; &lt;remote-path&gt;
 
 <p><b>Command Syntax:</b></p>
 <ul><pre>
-help
+help [-v] [&lt;cmd&gt;]
 </pre></ul>
 <p>
   <b>Synopsis</b>.
-  Presents summary information about each command to console.
+  Presents summary information about NSH commands to console.
 </p>
+<p><b>Options:</b></p>
+<ul><table>
+  <tr>
+    <td><b><code>-v</code></b></td>
+    <td>
+      how verbose output will full command usage.
+    </td>
+  </tr>
+  <tr>
+    <td><b><code>&lt;cmd&gt;</code></b></td>
+    <td>
+      Show full command usage only for this command.
+    </td>
+  </tr>
+</table></ul>
 
 <table width ="100%">
   <tr bgcolor="#e4e4e4">
@@ -2031,7 +2046,7 @@ nsh>
     <td><code>CONFIG_NSH_DISABLE_GET</code></td>
   </tr>
   <tr>
-    <td><b><code>help</code></b></td>
+    <td><b><code>help</code></b><sup>5</sup></td>
     <td><br></td>
     <td><code>CONFIG_NSH_DISABLE_HELP</code></td>
   </tr>
@@ -2192,6 +2207,10 @@ nsh>
   <sup>4</sup><small>
   <code>CONFIG_FS_WRITABLE</code> is not a user configuration but is set automatically
   if any writable filesystem is selected.  At present, this is only <code>CONFIG_FS_FAT</code>.</small><br>
+  <sup>5</sup><small>
+  Verbose help output can be suppressed by defining <code>CONFIG_NSH_HELP_TERSE</code>.
+  In that case, the help command is still available but will be slightly smaller.
+  </small>
 </p>
 
 <table width ="100%">
-- 
cgit v1.2.3