summaryrefslogtreecommitdiff
path: root/nuttx
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-08-04 22:17:37 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-08-04 22:17:37 +0000
commit3609cc6eb6f7f30654cb95b0ce02487c742c9487 (patch)
treee08ea462e0bf7d5917e44000a4e5102ef898fc39 /nuttx
parentd57cdbc921d1a50eb6d37471df59dbb3a8a0bb2b (diff)
downloadpx4-nuttx-3609cc6eb6f7f30654cb95b0ce02487c742c9487.tar.gz
px4-nuttx-3609cc6eb6f7f30654cb95b0ce02487c742c9487.tar.bz2
px4-nuttx-3609cc6eb6f7f30654cb95b0ce02487c742c9487.zip
Update NSH documentation; Add option to reduce size of help commnd without completely eliminating it
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5009 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'nuttx')
-rw-r--r--nuttx/Documentation/NuttShell.html25
1 files changed, 22 insertions, 3 deletions
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%">