summaryrefslogtreecommitdiff
path: root/apps/nshlib/README.txt
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 /apps/nshlib/README.txt
parentd57cdbc921d1a50eb6d37471df59dbb3a8a0bb2b (diff)
downloadnuttx-3609cc6eb6f7f30654cb95b0ce02487c742c9487.tar.gz
nuttx-3609cc6eb6f7f30654cb95b0ce02487c742c9487.tar.bz2
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 'apps/nshlib/README.txt')
-rw-r--r--apps/nshlib/README.txt13
1 files changed, 11 insertions, 2 deletions
diff --git a/apps/nshlib/README.txt b/apps/nshlib/README.txt
index 7dbae8e63..a6cb2d7d7 100644
--- a/apps/nshlib/README.txt
+++ b/apps/nshlib/README.txt
@@ -371,9 +371,15 @@ o get [-b|-n] [-f <local-path>] -h <ip-address> <remote-path>
Selects either binary ("octect") or test ("netascii") transfer
mode. Default: text.
-o help
+o help [-v] [<cmd>]
- Presents summary information about each command to console.
+ Presents summary information about NSH commands to console. Options:
+
+ -v
+ Show verbose output will full command usage
+
+ <cmd>
+ Show full command usage only for this command
o ifconfig
@@ -889,6 +895,9 @@ also allow it to squeeze into very small memory footprints.
CONFIG_NSH_DISABLE_UNSET, CONFIG_NSH_DISABLE_USLEEP, CONFIG_NSH_DISABLE_WGET,
CONFIG_NSH_DISABLE_XD
+Verbose help output can be suppressed by defining CONFIG_NSH_HELP_TERSE. In that
+case, the help command is still available but will be slightly smaller.
+
NSH-Specific Configuration Settings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^