summaryrefslogtreecommitdiff
path: root/apps/nshlib/README.txt
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2014-01-18 09:39:16 -0600
committerGregory Nutt <gnutt@nuttx.org>2014-01-18 09:39:16 -0600
commitc9e72e0eed21a1c8c679bc094b0960dabf31c84d (patch)
tree9ef30c27fc3d15efa8db04cb1112d916316f3998 /apps/nshlib/README.txt
parent1cc717520d36623c08f8b60f9cd7fede1bd8f1c1 (diff)
downloadnuttx-c9e72e0eed21a1c8c679bc094b0960dabf31c84d.tar.gz
nuttx-c9e72e0eed21a1c8c679bc094b0960dabf31c84d.tar.bz2
nuttx-c9e72e0eed21a1c8c679bc094b0960dabf31c84d.zip
NSH: Add a break command; if-then-else and looping behavior can not be configured out of the build for small systems that need minimal scripting capability
Diffstat (limited to 'apps/nshlib/README.txt')
-rw-r--r--apps/nshlib/README.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/apps/nshlib/README.txt b/apps/nshlib/README.txt
index 1e4731066..cdf7600bf 100644
--- a/apps/nshlib/README.txt
+++ b/apps/nshlib/README.txt
@@ -7,6 +7,7 @@ apps/nshlib
- Console/NSH Front End
- Command Overview
- Conditional Command Execution
+ - Looping
- Built-In Variables
- Current Working Directory
Environment Variables
@@ -121,6 +122,12 @@ Looping
Execute <cmd-sequence> as long as <test-cmd> has a non-zero exit
status.
+ A break command is also supported. The break command is only valid
+ within the body of the a while or until loop, between the do and done
+ tokens. If the break command is executed within the body of a loop, the
+ loop will immediately terminate and execution will continue with the
+ next command immediately following the done token.
+
Built-In Variables
^^^^^^^^^^^^^^^^^^
@@ -1094,6 +1101,20 @@ NSH-Specific Configuration Settings
if-then[-else]-fi construct. This would only be set on systems
where a minimal footprint is a necessity and scripting is not.
+ * CONFIG_NSH_DISABLE_ITEF
+
+ If scripting is enabled, then then this option can be selected to
+ suppress support for if-then-else-fi sequences in scripts. This would
+ only be set on systems where some minimal scripting is required but
+ if-then-else-fi is not.
+
+ * CONFIG_NSH_DISABLE_LOOPS
+
+ If scripting is enabled, then then this option can be selected
+ suppress support for while-do-done and until-do-done sequences in
+ scripts. This would only be set on systems where some minimal
+ scripting is required but looping is not.
+
* CONFIG_NSH_DISABLEBG
This can be set to 'y' to suppress support for background
commands. This setting disables the 'nice' command prefix and