From cdadf2302cef2bd4e0d83f1ad4466aad025a052c Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Mon, 3 Feb 2014 10:56:52 -0600 Subject: [PATCH] Update documentation, mostly related to the command line editor --- COPYING | 21 ------ Documentation/NuttShell.html | 132 ++++++++++++++++++++++++++++++++--- 2 files changed, 122 insertions(+), 31 deletions(-) diff --git a/COPYING b/COPYING index 39c1fadc19..8acaa714c3 100644 --- a/COPYING +++ b/COPYING @@ -214,26 +214,6 @@ libc/math WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -Documents/rss.gif -^^^^^^^^^^^^^^^^^ - - Licensed under Creative Commons Attribution-Share Alike 2.5 Generic - license: - - You are free: - - * to share – to copy, distribute and transmit the work - * to remix – to adapt the work - - Under the following conditions: - - * attribution – You must attribute the work in the manner specified - by the author or licensor (but not in any way that suggests that - they endorse you or your use of the work). - * share alike – If you alter, transform, or build upon this work, - you may distribute the resulting work only under the same or - similar license to this one. - drivers/video/ov2640 ^^^^^^^^^^^^^^^^^^^^ @@ -243,4 +223,3 @@ drivers/video/ov2640 content of those tables and still retain this BSD license. I am guessing so, but I am not a copyright attorney so you should use this driver in products at your own risk. - \ No newline at end of file diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index 8e3497552f..de80660ad4 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -459,10 +459,11 @@

+ The NSH Library. The apps/nshlib sub-directory contains the NuttShell (NSH) library. - This library can easily to linked to produce a NSH application (See as an example apps/nshlib). - NSH is a simple shell application for NuttX. + This library can easily to linked to produce a NSH application (See as an example apps/examples/nsh). + The NSH Library provides a simple shell application for NuttX.

@@ -474,17 +475,104 @@

- Using settings in the configuration file, NSH may be configured to - use either the serial stdin/out or a telnet connection as the console - or BOTH. When NSH is started, you will see the following welcome on - either console: + NSH Consoles. + Using settings in the configuration file, NSH may be configured to use + (1) the serial stdin/out, + (2) a USB serial device (such as CDC/ACM), or + (3) a telnet connection as the console. + Or, perhaps even all at once since or BOTH. + An indefinite number of telnet sessions are supported. +

+

+ Start-Up prompt. + When NSH is started, you will see the a welcome message such the following on the selected console:

- nsh> is the NSH prompt and indicates that you may enter a command - from the console. + The greating may also include NuttX versioning information if you are using a versioned copy of NuttX. + nsh> is the NSH prompt and indicates that you may enter a command from the console.

+

+ Extended Command Line Editing. + By default, NuttX uses a simple command line editor that allows command entry after the nsh> and supports only the backspace key for editing. + However, a more complete command line editor can be selected by setting CONFIG_NSH_CLE=y in the NuttX configuration file. + When that option is selected, the following EMACS-like line editing commands are supported: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Key Binding + + Editor Action +
+ ^A + + Move cursor to start of the line +
+ ^B + + Move left one character +
+ ^D or Del + + Delete a single character at the cursor position +
+ ^E + + Move cursor to end of current line +
+ ^F + + Move right one character +
+ ^H or Backspace + + Delete character, left (backspace) +
+ ^K + + Delete to the end of the line +
+ ^U + + Delete the entire line +
@@ -2736,6 +2824,25 @@ nsh> + + + + + + + + +
Configuration Description
CONFIG_NSH_READLINE + Selects the minimal implementation of readline(). + This minimal implementation provides on backspace for command line editing. + It expects some minimal VT100 command support from the terminal. +
CONFIG_NSH_CLE + Selects the more extensive, EMACS-like command line editor. + Select this option only if + (1) you don't mind a modest increase in the FLASH footprint, and + (2) you work with a terminal that supports extensive VT100 editing commands. + Selecting this option will add probably 1.5-2KB to the FLASH footprint. +
CONFIG_NSH_BUILTIN_APPS @@ -4054,6 +4161,7 @@ mount -t vfat /dev/ram1 /tmp
  • cat
  • cd
  • cmp
    • +
  • Command Line Editing
  • Command summaries
  • Command table
  • Conditional command execution
    • @@ -4065,6 +4173,7 @@ mount -t vfat /dev/ram1 /tmp
  • CONFIG_NSH_ARGCAT
  • CONFIG_NSH_BUILTIN_APPS
  • CONFIG_NSH_BUILTIN_APPS
    • +
  • CONFIG_NSH_CLE
  • CONFIG_NSH_CMDPARMS
  • CONFIG_NSH_CONSOLE
  • CONFIG_NSH_DHCPC
    • @@ -4090,6 +4199,7 @@ mount -t vfat /dev/ram1 /tmp